Crazy Eddies GUI System  0.7.6
Public Member Functions
CEGUI::CheckboxProperties::Selected Class Reference

Property to access the selected state of the check box. More...

+ Inheritance diagram for CEGUI::CheckboxProperties::Selected:
+ Collaboration diagram for CEGUI::CheckboxProperties::Selected:

List of all members.

Public Member Functions

String get (const PropertyReceiver *receiver) const
 Return the current value of the Property as a String.
void set (PropertyReceiver *receiver, const String &value)
 Sets the value of the property.

Detailed Description

Property to access the selected state of the check box.

This property offers access to the select state for the Checkbox object.

Usage:
Where [Text] is:
  • "True" to indicate the check box is selected (has check mark).
  • "False" to indicate the check box is not selected (does not have check mark).

Member Function Documentation

String CEGUI::CheckboxProperties::Selected::get ( const PropertyReceiver receiver) const [virtual]

Return the current value of the Property as a String.

Parameters:
receiverPointer to the target object.
Returns:
String object containing a textual representation of the current value of the Property

Implements CEGUI::Property.

void CEGUI::CheckboxProperties::Selected::set ( PropertyReceiver receiver,
const String value 
) [virtual]

Sets the value of the property.

Parameters:
receiverPointer to the target object.
valueA String object that contains a textual representation of the new value to assign to the Property.
Returns:
Nothing.
Exceptions:
InvalidRequestExceptionThrown when the Property was unable to interpret the content of value.

Implements CEGUI::Property.