GuiCheckableBtn Class Reference
[2D graphical user interface]

A class for buttons that can be checked. More...

#include <guidynamicbutton.h>

Inheritance diagram for GuiCheckableBtn:

[legend]Collaboration diagram for GuiCheckableBtn:

[legend]List of all members.

Public Member Functions
DECLSPEC	GuiCheckableBtn (const SDL_Rect &r, GuiElement *p, const char *name, const char *t=0, SdlSurfaceContainer *b=0, SdlAudio *u=0, SdlAudio *d=0)
DECLSPEC	GuiCheckableBtn (TiXmlElement *el, GuiElement *p)
virtual const char *	getClassName ()
DECLSPEC void	setCheck (bool b)
bool	getCheck () const
void	setCheckCallback (Callback c)
void	setCallbackData (BasicObject *d)
Static Public Member Functions
static void	newguiobject (void *presult, BasicObject *o, void *xmldata)
Protected Member Functions
virtual DECLSPEC Uint32	onMouseDown (SDL_MouseButtonEvent *ev)
virtual DECLSPEC Uint32	onMouseUp (SDL_MouseButtonEvent *ev)
virtual DECLSPEC void	onInit ()
virtual DECLSPEC Uint32	onThemeChanged (UiTheme *t)
virtual DECLSPEC void	onCheck (bool checked)

---

Detailed Description

A class for buttons that can be checked.

---

Constructor & Destructor Documentation

GuiCheckableBtn::GuiCheckableBtn	(	TiXmlElement *	el,
		GuiElement *	p
	)

Constructor. Uses XML data.

Parameters:

	el	the XML data for initialisation, the attribute OnCheck (event) can be specified
	p	parent element (or NULL, to take GuiManager::the as parent)

See also:

GuiElement(TiXmlElement*,GuiElement*)

---

Member Function Documentation

virtual const char* GuiCheckableBtn::getClassName

(

)

[inline, virtual]

This function should be overriden in every sub-class of BasicObject!

Returns:

the name of the class.

Reimplemented from GuiDynamicButton.

Reimplemented in GuiRadioBtn.

Uint32 GuiCheckableBtn::onMouseDown

(

SDL_MouseButtonEvent *

ev

)

[protected, virtual]

This event is called, when the object has the mouse focus and a mouse button is pressed down.

Parameters:

ev

the button-down event, that occured

Returns:

currently the result is not used; may be zero, if no error...

Reimplemented from UiObject.

Uint32 GuiCheckableBtn::onMouseUp

(

SDL_MouseButtonEvent *

ev

)

[protected, virtual]

This event is called, when the object has the mouse focus and a mouse button is released.

Parameters:

ev

the button-up event, that occured

Returns:

currently the result is not used; may be zero, if no error...

Reimplemented from UiObject.

void GuiCheckableBtn::onInit

(

)

[protected, virtual]

Initializes the object's variables by reading data from the XML element. If there were no XML data used for creation, nothing is done. This function calls onInit() of its children recursively (after it has inited itself). It is highly recommended to call BasicObject::onInit(), usually at the end of the onInit() method, when overwriting it in a derived class.

Reimplemented from GuiDynamicButton.

Reimplemented in GuiRadioBtn.

Uint32 GuiCheckableBtn::onThemeChanged

(

UiTheme *

t

)

[protected, virtual]

This event is called, when the theme changes. Perform here the changes of the object's look and feel.

Parameters:

t

pointer to the new used theme

Returns:

currently the result is not used; may be zero, if no error...

Reimplemented from GuiDynamicButton.

Reimplemented in GuiRadioBtn.

void GuiCheckableBtn::onCheck

(

bool

checked

)

[protected, virtual]

Called after the checked-state changed.

Parameters:

checked

the new state (true if checked, false if unchecked)

Reimplemented in GuiRadioBtn.

---

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

• guidynamicbutton.h
• guidynamicbutton.cpp

---