Laxkit::PanWindow Class Reference

Lets you drag a little rectangle around an image to select viewable area. More...

Inheritance diagram for Laxkit::PanWindow:

List of all members.

Public Member Functions
	PanWindow (anXWindow *pwindow, const char *nname, const char *ntitle, unsigned long nstyle, int nx, int ny, int nw, int nh, int brder, anXWindow *prev, unsigned long nowner, const char *nsend, int mouseid, PanController *pan, LaxImage *img, int nxs=0, int nys=0, int npad=0)
virtual void	UseThisPanner (PanController *npanner)
	Calls same of PanUser, then sets needtodraw=1.
virtual void	centerOnMouse (int mouseid)
	Move the window so that the selection is as near to centered on the mouse as possible.
virtual void	CenterImage ()
	Adjust imagerect so that its width and height are centered in the window.
virtual int	SetImage (LaxImage *imag)
	Set the image to imag or to panner settings. Sets imagerect to proper values.
virtual int	Event (const EventData *e, const char *mes)
	Intercept MapNotify in case PAN_IS_POPUP is set.
virtual int	init ()
virtual void	Refresh ()
	Draw the image and the selection rectangle.
virtual const char *	whattype ()
virtual int	LBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
virtual int	LBUp (int x, int y, unsigned int state, const LaxMouse *d)
virtual int	MouseMove (int x, int y, unsigned int state, const LaxMouse *d)
virtual int	MoveResize (int nx, int ny, int nw, int nh)
	Resizes and centers the image.
virtual int	Resize (int nw, int nh)
	Resizes and centers the image.
virtual int	send ()
Public Member Functions inherited from Laxkit::anXWindow
	anXWindow (anXWindow *parnt, const char *nname, const char *ntitle, unsigned long nstyle, int xx, int yy, int ww, int hh, int brder, anXWindow *prev, unsigned long nowner, const char *nsend)
	Constructor.
virtual	~anXWindow ()
	anXWindow destructor. Its X window should have been XDestroy'd before here.
virtual const char *	WindowTitle (int which=0)
	Return basically the name of the window.
virtual void	WindowTitle (const char *newtitle)
	Change the title of the window. This text would usually be displayed in the bar provided by a window manager.
virtual const char *	tooltip (int mouseid=0)
	By default, return win_tooltip.
virtual const char *	tooltip (const char *newtooltip)
	Replace the current tooltip, return the current tooltip (after replacing).
virtual anXWindow *	findChildWindowByTitle (const char *title)
	Find the first immediate child window that has win_title==title.
virtual anXWindow *	findChildWindowByName (const char *name)
	Find the first immediate child window that has win_name==name.
virtual int	Grayed ()
	Return whether this window is grayed.
virtual int	Grayed (int g)
	Set the gray state of this window. Returns Grayed(void).
virtual int	preinit ()
virtual int	close ()
	Called by anXApp from anXApp::destroywindow() when a window is to be destroyed.
virtual int	Idle (int tid=0)
	anXWindow::Idle() is an empty placeholeder. Just returns 1.
virtual Displayer *	MakeCurrent ()
virtual int	Needtodraw ()
	Default is to return needtodraw.
virtual void	Needtodraw (int nntd)
	If 0, then the window does not need refreshing. Otherwise it does.
virtual int	deletenow ()
	Return whether the window is allowed to be deleted.
virtual int	setWinStyle (unsigned int stylebit, int newvalue)
	Control various window related basic styling of win_style.
virtual int	getWinStyle (unsigned int stylebit)
	Currently, simply return win_style&stylebit.
virtual void	installColors (WindowColors *newcolors)
	Dec_count old and inc_count new.
virtual ShortcutHandler *	GetShortcuts ()
	Return a ShortcutHandler that contains stacks of bound shortcuts and possible window actions.
virtual int	PerformAction (int action_number)
virtual int	ExposeChange (ScreenEventData *e)
	Default behavior on Expose events is to call Needtodraw(1).
virtual int	DeviceChange (const DeviceEventData *e)
virtual int	CharInput (unsigned int ch, const char *buffer, int len, unsigned int state, const LaxKeyboard *kb)
	Input of character data or control character presses.
virtual int	KeyUp (unsigned int ch, unsigned int state, const LaxKeyboard *kb)
	Called when a key is released.
virtual int	ButtonDown (int button, int x, int y, unsigned int state, int count, const LaxMouse *m)
virtual int	ButtonUp (int button, int x, int y, unsigned int state, const LaxMouse *m)
virtual int	MBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
	Default is just to return 1.
virtual int	MBUp (int x, int y, unsigned int state, const LaxMouse *d)
	Default is just to return 1.
virtual int	RBDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
	Default is just to return 1.
virtual int	RBUp (int x, int y, unsigned int state, const LaxMouse *d)
	Default is just to return 1.
virtual int	WheelUp (int x, int y, unsigned int state, int count, const LaxMouse *d)
	The wheel mouse rolling up. Default is just to return 1.
virtual int	WheelDown (int x, int y, unsigned int state, int count, const LaxMouse *d)
	The wheel mouse rolling down. Default is just to return 1.
virtual int	FocusOn (const FocusChangeData *e)
	Increment win_active, and highlights the window's border, if the event refers to this window.
virtual int	FocusOff (const FocusChangeData *e)
	Decrements win_active, and de-highlights the window's border if win_active==0, if event is a real focus off.
virtual void	contentChanged ()
	Windows may call this when their contents change.
virtual void	selectionChanged ()
	Windows may call this when their selections change.
virtual anXWindow *	GetController ()
	Return the window most relevant for tab control loops.
virtual int	SelectNextControl (const LaxDevice *d)
	Transfer focus to nextcontrol.
virtual int	SelectPrevControl (const LaxDevice *d)
	Transfer the focus to prevcontrol.
virtual void	ControlActivation (int on)
	Do special activation or not when controls are activated by tabbing.
virtual int	AddPrevControl (anXWindow *prev)
virtual int	AddNextControl (anXWindow *next)
virtual int	ConnectControl (anXWindow *towhat, int after=1)
	Connect towhat to this. Used for tab loops.
virtual int	CloseControlLoop ()
	Close a tab loop.
virtual void	SetOwner (anXWindow *nowner, const char *mes=NULL, unsigned int send_mask=0)
	Set the new owner and control message.
virtual void	SetOwner (unsigned long nowner_id, const char *mes=NULL, unsigned int send_mask=0)
virtual void	dump_out (FILE *f, int indent, int what, anObject *context)
	Simple dumping function.
virtual LaxFiles::Attribute *	dump_out_atts (LaxFiles::Attribute *att, int what, anObject *context)
virtual void	dump_in_atts (LaxFiles::Attribute *att, int flag, anObject *context)
Public Member Functions inherited from Laxkit::Tagged
virtual int	HasTag (const char *tag, int casematters)
	Return whether the tag exists.
virtual int	NumberOfTags ()
	Return the number of tags, strangely enough.
virtual const char *	GetTag (int i)
	Return const pointer to the tag text for tag number i, where i==0 is the first tag.
virtual char *	GetAllTags ()
	Return a new char[] with a space separated list of all the tags.
virtual int	InsertTags (const char *tags, int casematters)
	Insert tags from a string such as 'tag1 tag2 tag3 "tag with spaces" tag4'.
virtual int	InsertTag (const char *tag, int casematters)
	Insert tag if it doesn't exist already.
virtual int	RemoveTag (const char *tag)
	The tag must be an exact match.
virtual int	RemoveTag (int i)
	Remove tag number i. i must be in range [0..NumberOfTags()-1].
virtual void	FlushTags ()
Public Member Functions inherited from LaxFiles::DumpUtility
virtual void	dump_in (FILE *f, int indent, int what, Laxkit::anObject *loadcontext, Attribute **att)
	Read in a file segment as an Attribute, and pass parsing duties to dump_in_atts.
virtual	~DumpUtility ()
	Empty virtual destructor.
Public Member Functions inherited from Laxkit::aDrawable
	aDrawable (Drawable d=0)
virtual int	DrawableType ()
virtual int	ValidDrawable ()
Public Member Functions inherited from Laxkit::PanUser
	PanUser (PanController *npan=NULL)
	Create with a new panner.
virtual	~PanUser ()
	Removes this from panner tellstack. Delete panner if necessary.
virtual PanController *	createNewPanner (PanController *pan=NULL)
	Create a new panner that is a copy of pan if given.

Public Attributes
int	pad
int	maxdim
Public Attributes inherited from Laxkit::anXWindow
WindowColors *	win_colors
anXApp *	app
char *	win_name
	An arbitrary string to be used as an id.
char *	win_title
	The title of the window.
anXWindow *	win_parent
int	win_screen
unsigned long	win_style
int	win_x
int	win_y
int	win_w
int	win_h
unsigned int	win_border
int	win_pointer_shape
	Identifier for a stock mouse shape.
char	win_on
	Nonzero if the window is mapped.
char	win_active
	Should be positive when the window has a keyboard focus, 0 otherwise.
unsigned long	win_owner
	Who gets control messages from this window.
unsigned int	win_owner_send_mask
char *	win_sendthis
	The type of message that gets sent to owner.
anXWindow *	nextcontrol
anXWindow *	prevcontrol
Public Attributes inherited from Laxkit::Tagged
int	sorttags
Public Attributes inherited from Laxkit::PanUser
PanController *	panner

Protected Attributes
LaxImage *	image
XRectangle	imagerect
int	imagex
int	imagey
int	xs
int	ys
int	mx
int	my
unsigned long	bgcolor
int	buttondown
int	bdowndevice
Protected Attributes inherited from Laxkit::anXWindow
char *	win_tooltip
	Convenience variable to hold the window's tooltip, if any.
int	needtodraw
RefPtrStack< anXWindow >	_kids
	Stack of children of the window.
Protected Attributes inherited from Laxkit::Tagged
PtrStack< char >	list_of_tags

Additional Inherited Members
Protected Member Functions inherited from Laxkit::anXWindow
virtual int	deletekid (anXWindow *w)
	Purges child anXWindows from window's child stack.
virtual void	SwapBuffers ()
	Swap buffers. This should be called from Refresh() if VIEWPORT_BACK_BUFFER is set in win_style.
virtual void	SetupBackBuffer ()
	Initialize the backbuffer.

---

Detailed Description

Lets you drag a little rectangle around an image to select viewable area.

Todo:

****** must be able to handle when the wholebox is less than the selbox... right now is screwed up...

   // Specifies that the window should try to center itself and the selbox
   // around the mouse.
  #define PAN_IS_POPUP     (1<<16)
  #define PAN_NEEDS_BDOWN  (1<<17)

---

Member Function Documentation

int Laxkit::PanWindow::Event ( const EventData *  e, const char *  mes  )

virtual

Intercept MapNotify in case PAN_IS_POPUP is set.

Grabs the pointer if that style is set. In either case, it then properly calls anXWindow::Event().

Todo:

*** this is broken!! Must reimplement for mpx!!

Reimplemented from Laxkit::anXWindow.

int Laxkit::PanWindow::SetImage ( LaxImage *  imag )

virtual

Set the image to imag or to panner settings. Sets imagerect to proper values.

PanWindow assumes responsiblity for deleting the image via XDestroyImage.

This designates the selectable area proportional to the image size, or porportional to the panner wholespace if there is no image. It does not overwrite any of the panner settings, unless the panner seems to have 0's for everything.

If imag==NULL, then the imagerect will correspond to panner stuff scaled to fit within a square with side length maxdim, else imagerect will correspond to the image. If this->window is None and win_w==0 or win_h==0, then set that element to imagerect.width or height.

References CenterImage(), Laxkit::anObject::dec_count(), Laxkit::LaxImage::h(), Laxkit::anObject::inc_count(), Laxkit::PanController::max, Laxkit::PanController::min, and Laxkit::LaxImage::w().

void Laxkit::PanWindow::UseThisPanner ( PanController *  npanner )

virtual

Calls same of PanUser, then sets needtodraw=1.

*** this is perhaps not necessary? assumes that a new panner is set assumes needtodraw=1 already?

Reimplemented from Laxkit::PanUser.

---

The documentation for this class was generated from the following files:

• panpopup.h
• panpopup.cc