An abstract class that defines the interface to access object properties by name.
More...
Inherits CEGUI::AllocatedObject< Property >.
Inherited by CEGUI::TypedProperty< T >, CEGUI::XercesParserProperties::SchemaDefaultResourceGroup, and CEGUI::TypedProperty< String >.
|
static const String | XMLElementName |
|
static const String | NameXMLAttributeName |
|
static const String | ValueXMLAttributeName |
|
An abstract class that defines the interface to access object properties by name.
Property objects allow (via a PropertySet) access to certain properties of objects by using simple get/set functions and the name of the property to be accessed.
◆ Property()
CEGUI::Property::Property |
( |
const String & |
name, |
|
|
const String & |
help, |
|
|
const String & |
defaultValue = "" , |
|
|
bool |
writesXML = true , |
|
|
const String & |
dataType = "Unknown" , |
|
|
const String & |
origin = "Unknown" |
|
) |
| |
|
inline |
\brief
Creates a new Property object.
\param name
String containing the name of the new Property.
\param help
String containing a description of the Property and it's usage.
\param defaultValue
String holding the textual representation of the default value for this Property
- Parameters
-
writesXML | Specifies whether the writeXMLToStream method should do anything for this Property. This enables selectivity in what properties within a PropertySet will get output as XML. |
dataType | String representation of the data type this property is held in ("int", "UVector2", ...) |
origin | String describing the origin class of this Property (Window, FrameWindow, ...) |
◆ get()
◆ getDataType()
const String& CEGUI::Property::getDataType |
( |
void |
| ) |
const |
|
inline |
◆ getDefault()
Returns the default value of the Property as a String.
- Parameters
-
receiver | Pointer to the target object. |
- Returns
- String object containing a textual representation of the default value for this property.
◆ getHelp()
const String& CEGUI::Property::getHelp |
( |
void |
| ) |
const |
|
inline |
Return a String that describes the purpose and usage of this Property.
- Returns
- String that contains the help text
◆ getName()
const String& CEGUI::Property::getName |
( |
void |
| ) |
const |
|
inline |
◆ getOrigin()
const String& CEGUI::Property::getOrigin |
( |
void |
| ) |
const |
|
inline |
◆ isDefault()
virtual bool CEGUI::Property::isDefault |
( |
const PropertyReceiver * |
receiver | ) |
const |
|
virtual |
Returns whether the property is at it's default value.
- Parameters
-
receiver | Pointer to the target object. |
- Returns
- true if the property has it's default value.
- false if the property has been modified from it's default value.
◆ isReadable()
virtual bool CEGUI::Property::isReadable |
( |
| ) |
const |
|
virtual |
Returns whether the property is readable.
- Returns
- true if the property is readable.
- false if the property isn't readable.
Reimplemented in CEGUI::TplProperty< C, T >.
◆ isWritable()
virtual bool CEGUI::Property::isWritable |
( |
| ) |
const |
|
virtual |
Returns whether the property is writable.
- Returns
- true if the property is writable.
- false if the property isn't writable.
Reimplemented in CEGUI::TplProperty< C, T >.
◆ set()
◆ writeXMLToStream()