Crazy Eddies GUI System: CEGUI::PropertyDefinition Class Reference

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | Protected Attributes
CEGUI::PropertyDefinition Class Reference

Class representing a generic get/set property. More...

Inheritance diagram for CEGUI::PropertyDefinition:
[legend]
Collaboration diagram for CEGUI::PropertyDefinition:
[legend]

List of all members.

## Public Member Functions
| PropertyDefinition (const String &name, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite)
| PropertyDefinition (const String &name, const String &initialValue, const String &help, bool redrawOnWrite, bool layoutOnWrite)
| Constructor.
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.
## Protected Member Functions
void | writeXMLElementType (XMLSerializer &xml_stream) const
| Write out the text of the XML element type. Note that you should not write the opening '<' character, nor any other information such as attributes in this function. The writeExtraAttributes function can be used for writing attributes.
## Protected Attributes
String | d_userStringName

## Detailed Description

Class representing a generic get/set property.

## Constructor & Destructor Documentation

CEGUI::PropertyDefinition::PropertyDefinition | ( | const String & | name,
|  | const String & | initialValue,
|  | bool | redrawOnWrite,
|  | bool | layoutOnWrite
| ) |  |

Deprecated:
  This version of the constructor is deprecated in favour of the version taking a help string.

## Member Function Documentation

String CEGUI::PropertyDefinition::get | ( | const PropertyReceiver * | receiver | ) | const`[virtual]`

Return the current value of the Property as a String.

Parameters:

  receiver | Pointer to the target object.

Returns:
  String object containing a textual representation of the current value of the Property

Implements CEGUI::Property.

void CEGUI::PropertyDefinition::set | ( | PropertyReceiver * | receiver,
|  | const String & | value
| ) |  | `[virtual]`

Sets the value of the property.

Note:
  When overriding the set() member of PropertyDefinitionBase, you MUST call the base class implementation after you have set the property value (i.e. you must call PropertyDefinitionBase::set()).

Parameters:

  receiver | Pointer to the target object.
  value | A String object that contains a textual representation of the new value to assign to the Property.

Returns:
  Nothing.

Exceptions:

  InvalidRequestException | Thrown when the Property was unable to interpret the content of value.

Reimplemented from CEGUI::PropertyDefinitionBase.

void CEGUI::PropertyDefinition::writeXMLElementType | ( | XMLSerializer & | xml_stream | ) | const`[protected, virtual]`

Write out the text of the XML element type. Note that you should not write the opening '<' character, nor any other information such as attributes in this function. The writeExtraAttributes function can be used for writing attributes.

Parameters:

  xml_stream | Stream where xml data should be output.

Implements CEGUI::PropertyDefinitionBase.