DigitalSpaces::DICEGUIRadioButton Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	isSelected ()
	return true if the radio button is selected (has the checkmark)
unsigned long	getGroupID ()
	return the groupID assigned to this radio button
DICEGUIRadioButton *	getSelectedButtonInGroup ()
	Return a pointer to the RadioButton object within the same group as this RadioButton, that is currently selected.
void	setSelected (bool select)
	set whether the radio button is selected or not
void	setGroupID (unsigned long group)
	set the groupID for this radio button

---

Member Function Documentation

bool DigitalSpaces::DICEGUIRadioButton::isSelected

(

)

return true if the radio button is selected (has the checkmark)

Returns:

true if this widget is selected, false if the widget is not selected.

unsigned long DigitalSpaces::DICEGUIRadioButton::getGroupID

(

)

return the groupID assigned to this radio button

Returns:

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

DICEGUIRadioButton* DigitalSpaces::DICEGUIRadioButton::getSelectedButtonInGroup

(

)

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 NULL if no button within the group is selected, or if 'this' is not attached to a parent window.

void DigitalSpaces::DICEGUIRadioButton::setSelected

(

bool

select

)

set whether the radio button is selected or not

Parameters:

select

true to put the radio button in the selected state, false to put the radio button in the deselected state. If changing to the selected state, any previously selected radio button within the same group is automatically deselected.

Returns:

Nothing.

void DigitalSpaces::DICEGUIRadioButton::setGroupID

(

unsigned long

group

)

set the groupID for this radio button

Parameters:

group

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

Returns:

Nothing.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h