CEGUI::PropertyLinkDefinition Class Reference
Class representing a property that links to another property defined on an attached child widget.
More...
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 Window * | getTargetWindow (const PropertyReceiver *receiver) const |
| return a pointer to the window containing the target property to be accessed.
|
Window * | getTargetWindow (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
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.
const Window* CEGUI::PropertyLinkDefinition::getTargetWindow |
( |
const PropertyReceiver * |
receiver |
) |
const [protected] |
return a pointer to the window containing the target property to be accessed.
- Exceptions:
-
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.
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.