Crazy Eddies GUI System  0.7.7
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:
+ Collaboration diagram for CEGUI::PropertyDefinition:

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.
void initialisePropertyReceiver (PropertyReceiver *receiver) const
 function to allow initialisation of a PropertyReceiver.
- Public Member Functions inherited from CEGUI::PropertyDefinitionBase
 PropertyDefinitionBase (const String &name, const String &help, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite)
virtual void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of the PropertyDefinitionBase based object to out_stream.
- Public Member Functions inherited from CEGUI::Property
 Property (const String &name, const String &help, const String &defaultValue="", bool writesXML=true)
 Creates a new Property object.
virtual ~Property (void)
 Destructor for Property objects.
const StringgetHelp (void) const
 Return a String that describes the purpose and usage of this Property.
const StringgetName (void) const
 Return a the name of this Property.
virtual bool isDefault (const PropertyReceiver *receiver) const
 Returns whether the property is at it's default value.
virtual String getDefault (const PropertyReceiver *receiver) const
 Returns the default value of the Property as a String.
virtual void writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
 Writes out an XML representation of this class to the given stream.

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 Member Functions inherited from CEGUI::PropertyDefinitionBase
virtual void writeXMLAttributes (XMLSerializer &xml_stream) const
 Write out any xml attributes added in a sub-class. Note that you should not write the closing '/>' character sequence, nor any other information in this function. You should always call the base class implementation of this function when overriding.

Protected Attributes

String d_userStringName
- Protected Attributes inherited from CEGUI::PropertyDefinitionBase
bool d_writeCausesRedraw
bool d_writeCausesLayout
- Protected Attributes inherited from CEGUI::Property
String d_name
 String that stores the Property name.
String d_help
 String that stores the Property help text.
String d_default
 String that stores the Property default value string.
bool d_writeXML
 Specifies whether writeXMLToStream should do anything for this property.

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:
receiverPointer 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:
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.

Reimplemented from CEGUI::PropertyDefinitionBase.

void CEGUI::PropertyDefinition::writeXMLElementType ( XMLSerializer xml_stream) const
protectedvirtual

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_streamStream where xml data should be output.

Implements CEGUI::PropertyDefinitionBase.