CEGUI::PropertyLinkDefinition Class Reference

Class representing a property that links to another property defined on an attached child widget. More...

Inheritance diagram for CEGUI::PropertyLinkDefinition:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::PropertyLinkDefinition:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 PropertyLinkDefinition (const String &propertyName, const String &widgetNameSuffix, const String &targetProperty, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite)
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.
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.
const WindowgetTargetWindow (const PropertyReceiver *receiver) const
 return a pointer to the window containing the target property to be accessed.
WindowgetTargetWindow (PropertyReceiver *receiver)

Protected Attributes

String d_widgetNameSuffix
String d_targetProperty


Detailed Description

Class representing a property that links to another property defined on an attached child widget.

Member Function Documentation

String CEGUI::PropertyLinkDefinition::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.

References CEGUI::Property::d_name, CEGUI::String::empty(), CEGUI::PropertySet::getProperty(), and getTargetWindow().

const Window * CEGUI::PropertyLinkDefinition::getTargetWindow ( const PropertyReceiver receiver  )  const [protected]

return a pointer to the window containing the target property to be accessed.

Exceptions:
UnknownObjectException thrown if no such target window exists within the system.

References CEGUI::String::empty(), and CEGUI::Property::getName().

Referenced by get(), and set().

void CEGUI::PropertyLinkDefinition::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.

References CEGUI::Property::d_name, CEGUI::String::empty(), getTargetWindow(), and CEGUI::PropertySet::setProperty().

void CEGUI::PropertyLinkDefinition::writeXMLAttributes ( XMLSerializer xml_stream  )  const [protected, virtual]

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.

Parameters:
xml_stream Stream where xml data should be output.

Reimplemented from CEGUI::PropertyDefinitionBase.

References CEGUI::XMLSerializer::attribute(), and CEGUI::String::empty().

void CEGUI::PropertyLinkDefinition::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.

References CEGUI::XMLSerializer::openTag().


Generated on Thu Nov 27 20:34:41 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1