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

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

Collaboration diagram for CEGUI::PropertyInitialiser:

List of all members.

Public Member Functions

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

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