Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::PropertyInitialiser Class Reference

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

#include <CEGUIFalPropertyInitialiser.h>

Collaboration diagram for CEGUI::PropertyInitialiser:

Collaboration graph
[legend]
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 (OutStream &out_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.

Definition at line 37 of file CEGUIFalPropertyInitialiser.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
property String holding the name of the property targetted by this PropertyInitialiser.
value String holding the value to be set by this PropertyInitialiser.

Definition at line 31 of file CEGUIFalPropertyInitialiser.cpp.


Member Function Documentation

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

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

Parameters:
target CEGUI::PropertySet object to be initialised by this PropertyInitialiser.
Returns:
Nothing.

Definition at line 36 of file CEGUIFalPropertyInitialiser.cpp.

References CEGUI::PropertySet::setProperty().

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.

Definition at line 52 of file CEGUIFalPropertyInitialiser.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

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.

Definition at line 47 of file CEGUIFalPropertyInitialiser.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::PropertyInitialiser::writeXMLToStream OutStream out_stream  )  const
 

Writes an xml representation of this PropertyInitialiser to out_stream.

Parameters:
out_stream Stream where xml data should be output.
Returns:
Nothing.

Definition at line 57 of file CEGUIFalPropertyInitialiser.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:10:10 2005 for Crazy Eddies GUI System by  doxygen 1.4.3