Abstract base class for single buttons. More...

Inheritance diagram for Laxkit::ButtonBase:

Public Member Functions
	ButtonBase (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 *nsendmes, int nid=0)
virtual	~ButtonBase ()
	Detaches button from a button group, if any.
virtual int	Grayed ()
	Return anXWindow::Grayed()\|(state==LAX_GRAY).
virtual int	Grayed (int g)
virtual int	LBDown (int x, int y, unsigned int wstate, int count, const LaxMouse *d)
virtual int	LBUp (int x, int y, unsigned int wstate, const LaxMouse *d)
virtual int	WheelDown (int x, int y, unsigned int wstate, int count, const LaxMouse *d)
	For Momentary buttons, send() with direction=1.
virtual int	WheelUp (int x, int y, unsigned int wstate, int count, const LaxMouse *d)
	For Momentary buttons, send() with direction=-1.
virtual int	MouseMove (int x, int y, unsigned int state, const LaxMouse *d)
virtual int	CharInput (unsigned int ch, const char buffer, int len, unsigned int state, const LaxKeyboard d)
	Sends on enter.
virtual int	Event (const EventData e, const char mes)
	On enter or leave, swap oldstate and newstate.
virtual int	send (int deviceid, int direction)
	Send a SimpleMessage with type==LAX_ButtonEvent.
virtual void	Refresh ()
virtual void	draw ()=0
virtual void	drawon ()
virtual void	drawoff ()
virtual void	drawgrayed ()
virtual void	drawother ()
virtual int	toggle ()
	If state==LAX_ON, make LAX_OFF and vice versa, and set needtodraw=1. Returns state. Does net send.
virtual int	State (int newstate)
	Set the state to newstate (if a button is not currently pressed). Typically LAX_ON or LAX_OFF.
virtual int	State ()
	Return the state.
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 *	whattype ()
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	preinit ()
virtual int	init ()
	Empty placeholeder. Just returns 0.
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	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	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 int	MoveResize (int nx, int ny, int nw, int nh)
	Move and resize the window.
virtual int	Resize (int nw, int nh)
	Resize with new nw, and nh.
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 Attributes
unsigned int	highlight
unsigned int	shadow
int	bevel
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

Protected Attributes
int	mousein
	The number of mice in the button, so 0 if none.
int	state
int	oldstate
int	id
ButtonBase *	nextbutton
ButtonBase *	prevbutton
ButtonDownInfo	buttondown
unsigned int	button_style
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

Abstract base class for single buttons.

Most derived classes would only redefine the following, everything else should work ok. Most would only need to redefine draw() based on values of mousein and state. Separating drawon/off/other/grayed is for convenience, when a separate thing is drawn in each case.

They are currently the following. Refresh() does not call draw() directly, but does call the other ones directly according to state:

    virtual void draw() = 0;
    virtual void drawon() { draw(); }    //<- for LAX_ON
    virtual void drawoff() { draw(); }  //<- for LAX_OFF
    virtual void drawgrayed() { drawoff(); }  //<- for LAX_GRAY
    virtual void drawother() {}        //<- for any other state

To use the drawother, derived classes must implement state values other than LAX_ON/OFF/GRAY, and redefine: virtual int toggle() which should then toggle between all the values, not just LAX_ON/LAX_OFF. Toggle is called from LBDown(). Also redefine drawother(), which is called for state >2 from Refresh.

State(newstate).. state holds only an info value, not mouseover or anything like that. mousein holds whether the mouse is in the window or not, based on Enter/Leave events.

Style:

    // only when buttondown and mouseon, off when mouseoff,sends on
    // LBUp and mousein.\n
   #define BUTTON_MOMENTARY (1<<16)
    // click toggles on/off, sends on any toggle and LBUp***check that
   #define BUTTON_TOGGLE (1<<17)

  TODO
  ***test grayed
   class Thing {
    int state;
    unsigned int flags;??
   }

  perhaps *** use a statemap: map to looks raised, flat, looks pressed
 style 1   2
  off   nomo  ccur    flat  up
  off   nomo  noccur  flat  up
  off     mo  ccur    up    up
  off     mo  noccur  up    up
  on    nomo  ccur    down  down
  on    nomo  noccur  down  down
  on      mo  ccur    down  down
  on      mo  noccur  down  down
  gray  nomo  ccur    flat  up
  gray  nomo  noccur  flat  up
  gray    mo  ccur    flat  up
  gray    mo  noccur  flat  up

Todo:: could combine all the buttons: text button, iconbutton, checkbox into one thing...

Member Function Documentation

int Laxkit::ButtonBase::Grayed ( int g )

virtual

For some REALLY REALLY STUPID REASON, g++ is not recognizing anXWindow::Grayed(int) as the proper Grayed(int) when ButtonBase::Grayed() exists, so relaying here. To that I say $&#^$&^&$^&!!!!

Reimplemented from Laxkit::anXWindow.

References Grayed().

int Laxkit::ButtonBase::LBDown	(	int	x,
		int	y,
		unsigned int	wstate,
		int	count,
		const LaxMouse *	d
	)

virtual

Set oldstate to the current state and call toggle.

Reimplemented from Laxkit::anXWindow.

Reimplemented in Laxkit::MenuButton.

References Laxkit::ButtonDownInfo::down(), Grayed(), Laxkit::ButtonDownInfo::isdown(), and toggle().

int Laxkit::ButtonBase::LBUp	(	int	x,
		int	y,
		unsigned int	wstate,
		const LaxMouse *	d
	)

virtual

If !mousein or left button is not down, return.

If MOMENTARY, then set state=oldstate.

send().

Reimplemented from Laxkit::anXWindow.

References Grayed(), Laxkit::ButtonDownInfo::isdown(), mousein, send(), and Laxkit::ButtonDownInfo::up().

int Laxkit::ButtonBase::MouseMove	(	int	x,
		int	y,
		unsigned int	mstate,
		const LaxMouse *	d
	)

virtual

If mouse crosses borders, make sure that mousein is the correct value. Seems the window is not receiving all the Enter/LeaveNotify events that it is supposed to.

Reimplemented from Laxkit::anXWindow.

void Laxkit::ButtonBase::Refresh ( )

virtual

Does this:

   switch (state) {
    case LAX_GRAY: drawgrayed(); return;
    case LAX_OFF: drawoff(); return;
    case LAX_ON: drawon(); return;
    default: drawother(); return;
   }

Reimplemented from Laxkit::anXWindow.

References Grayed(), and Laxkit::anXWindow::win_on.

int Laxkit::ButtonBase::send	(	int	deviceid,
		int	direction
	)

virtual

Send a SimpleMessage with type==LAX_ButtonEvent.

data.info1=state, data.info2=id, data.info3=device id of what triggered the send. data.info4=1 or -1, direction according to wheel clicks

Reimplemented in Laxkit::QuickFileOpen.

References Laxkit::anXApp::SendMessage(), Laxkit::anXWindow::win_owner, and Laxkit::anXWindow::win_sendthis.

Referenced by CharInput(), Laxkit::MenuButton::LBDown(), LBUp(), WheelDown(), and WheelUp().

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

buttonbase.h
buttonbase.cc

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation