CEGUI::ToggleButton Class Reference

Class providing logic buttons that can have their selected state toggled. More...

Inheritance diagram for CEGUI::ToggleButton:

Collaboration diagram for CEGUI::ToggleButton:

List of all members.

Public Member Functions
bool	isSelected (void) const
	returns true if the toggle button is in the selected state.
void	setSelected (bool select)
	sets whether the toggle button is in the selected state.
	ToggleButton (const String &type, const String &name)
Static Public Attributes
static const String	EventNamespace
	Namespace for global events.
static const String	WidgetTypeName
static const String	EventSelectStateChanged
Protected Member Functions
virtual bool	getPostClickSelectState () const
void	addToggleButtonProperties ()
virtual void	onSelectStateChange (WindowEventArgs &e)
	event triggered internally when toggle button select state changes.
void	onMouseButtonUp (MouseEventArgs &e)
	Handler called when a mouse button has been released within this window's area.
Protected Attributes
bool	d_selected

---

Detailed Description

Class providing logic buttons that can have their selected state toggled.

---

Member Function Documentation

void CEGUI::ToggleButton::onMouseButtonUp

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been released within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::ButtonBase.

---

Member Data Documentation

const String CEGUI::ToggleButton::EventSelectStateChanged [static]

Event fired when then selected state of the ToggleButton changes. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ToggleButton whose state has changed.