Crazy Eddie's GUI System  0.8.7
CEGUI::PropertyInitialiser Class Reference

Class that holds information about a property and it's required initial value. More...

+ Inheritance diagram for CEGUI::PropertyInitialiser:
+ Collaboration diagram for CEGUI::PropertyInitialiser:

Public Member Functions

 PropertyInitialiser (const String &property, const String &value)
 Constructor. More...
 
void apply (PropertySet &target) const
 Apply this property initialiser to the specified target CEGUI::PropertySet object. More...
 
void setTargetPropertyName (const String &name)
 Sets the name of the property targetted by this PropertyInitialiser. More...
 
const StringgetTargetPropertyName () const
 Return the name of the property targetted by this PropertyInitialiser. More...
 
void setInitialiserValue (const String &value)
 Sets the value string to be set on the property targetted by this PropertyInitialiser. More...
 
const StringgetInitialiserValue () const
 Return the value string to be set on the property targetted by this PropertyInitialiser. More...
 
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this PropertyInitialiser to out_stream. More...
 

Detailed Description

Class that holds information about a property and it's required initial value.

Constructor & Destructor Documentation

CEGUI::PropertyInitialiser::PropertyInitialiser ( const String property,
const String value 
)

Constructor.

Parameters
propertyString holding the name of the property targetted by this PropertyInitialiser.
valueString holding the value to be set by this PropertyInitialiser.

Member Function Documentation

void CEGUI::PropertyInitialiser::apply ( PropertySet target) const

Apply this property initialiser to the specified target CEGUI::PropertySet object.

Parameters
targetCEGUI::PropertySet object to be initialised by this PropertyInitialiser.
Returns
Nothing.
const String& CEGUI::PropertyInitialiser::getInitialiserValue ( ) const

Return the value string to be set on the property targetted by this PropertyInitialiser.

Returns
String object holding the value string.
const String& CEGUI::PropertyInitialiser::getTargetPropertyName ( ) const

Return the name of the property targetted by this PropertyInitialiser.

Returns
String object holding the name of the target property.
void CEGUI::PropertyInitialiser::setInitialiserValue ( const String value)

Sets the value string to be set on the property targetted by this PropertyInitialiser.

Returns
String object holding the value string.
Nothing.
void CEGUI::PropertyInitialiser::setTargetPropertyName ( const String name)

Sets the name of the property targetted by this PropertyInitialiser.

Parameters
nameString object holding the name of the target property.
Returns
Nothing.
void CEGUI::PropertyInitialiser::writeXMLToStream ( XMLSerializer xml_stream) const

Writes an xml representation of this PropertyInitialiser to out_stream.

Parameters
xml_streamStream where xml data should be output.
Returns
Nothing.