CEGUI::RadioButton Class Reference

Base class to provide the logic for Radio Button widgets. More...

Inheritance diagram for CEGUI::RadioButton:

Collaboration diagram for CEGUI::RadioButton:

List of all members.

Public Member Functions
void	setGroupID (ulong group)
	set the groupID for this radio button
ulong	getGroupID () const
	return the groupID assigned to this radio button
RadioButton *	getSelectedButtonInGroup () const
	Return a pointer to the RadioButton object within the same group as this RadioButton, that is currently selected.
	RadioButton (const String &type, const String &name)
Static Public Attributes
static const String	WidgetTypeName
Protected Member Functions
void	deselectSiblingRadioButtonsInGroup () const
void	addRadioButtonProperties ()
bool	getPostClickSelectState () const
void	onSelectStateChange (WindowEventArgs &e)
	event triggered internally when toggle button select state changes.
Protected Attributes
ulong	d_groupID

---

Detailed Description

Base class to provide the logic for Radio Button widgets.

---

Member Function Documentation

ulong CEGUI::RadioButton::getGroupID

(

)

const [inline]

return the groupID assigned to this radio button

Returns:

ulong value that identifies the Radio Button group this widget belongs to.

RadioButton* CEGUI::RadioButton::getSelectedButtonInGroup

(

)

const

Return a pointer to the RadioButton object within the same group as this RadioButton, that is currently selected.

Returns:

Pointer to the RadioButton object that is the RadioButton within the same group as this RadioButton, and is attached to the same parent window as this RadioButton, that is currently selected. Returns 0 if no button within the group is selected, or if 'this' is not attached to a parent window.

void CEGUI::RadioButton::setGroupID

(

ulong

group

)

set the groupID for this radio button

Parameters:

group

ulong value specifying the radio button group that this widget belongs to.