Property_wrapper Struct Reference
Inheritance diagram for Property_wrapper:
Collaboration diagram for Property_wrapper:
Public Member Functions | |
| Property_wrapper (::CEGUI::String const &name, ::CEGUI::String const &help, ::CEGUI::String const &defaultValue="", bool writesXML=true, ::CEGUI::String const &dataType="Unknown", ::CEGUI::String const &origin="Unknown") | |
| virtual ::CEGUI::Property * | clone () const |
| virtual bool | doesWriteXML () const |
| Returns whether the property writes to XML streams. | |
| bool | default_doesWriteXML () const |
| virtual ::CEGUI::String | get (::CEGUI::PropertyReceiver const *receiver) const |
| virtual ::CEGUI::String | getDefault (::CEGUI::PropertyReceiver const *receiver) const |
| ::CEGUI::String | default_getDefault (::CEGUI::PropertyReceiver const *receiver) const |
| virtual void | initialisePropertyReceiver (::CEGUI::PropertyReceiver *arg0) const |
| void | default_initialisePropertyReceiver (::CEGUI::PropertyReceiver *arg0) const |
| virtual bool | isDefault (::CEGUI::PropertyReceiver const *receiver) const |
| bool | default_isDefault (::CEGUI::PropertyReceiver const *receiver) const |
| virtual bool | isReadable () const |
| Returns whether the property is readable. More... | |
| bool | default_isReadable () const |
| virtual bool | isWritable () const |
| Returns whether the property is writable. More... | |
| bool | default_isWritable () const |
| virtual void | set (::CEGUI::PropertyReceiver *receiver, ::CEGUI::String const &value) |
| virtual void | writeXMLToStream (::CEGUI::PropertyReceiver const *receiver, ::CEGUI::XMLSerializer &xml_stream) const |
| void | default_writeXMLToStream (::CEGUI::PropertyReceiver const *receiver, ::CEGUI::XMLSerializer &xml_stream) const |
| Public Member Functions inherited from CEGUI::Property | |
| Property (const String &name, const String &help, const String &defaultValue="", bool writesXML=true, const String &dataType="Unknown", const String &origin="Unknown") | |
| Creates a new Property object. More... | |
| virtual | ~Property (void) |
| Destructor for Property objects. | |
| const String & | getHelp (void) const |
| Return a String that describes the purpose and usage of this Property. More... | |
| const String & | getName (void) const |
| Return a the name of this Property. More... | |
| const String & | getDataType (void) const |
| Return string data type of this Property. More... | |
| const String & | getOrigin (void) const |
| Return string origin of this Property. More... | |
| virtual String | get (const PropertyReceiver *receiver) const =0 |
| Return the current value of the Property as a String. More... | |
| virtual void | set (PropertyReceiver *receiver, const String &value)=0 |
| Sets the value of the property. More... | |
| virtual bool | isDefault (const PropertyReceiver *receiver) const |
| Returns whether the property is at it's default value. More... | |
| virtual String | getDefault (const PropertyReceiver *receiver) const |
| Returns the default value of the Property as a String. More... | |
| virtual void | writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const |
| Writes out an XML representation of this class to the given stream. More... | |
| virtual void | initialisePropertyReceiver (PropertyReceiver *) const |
| function to allow initialisation of a PropertyReceiver. | |
| Property (const String &name, const String &help, const String &defaultValue="", bool writesXML=true, const String &dataType="Unknown", const String &origin="Unknown") | |
| Creates a new Property object. More... | |
| virtual | ~Property (void) |
| Destructor for Property objects. | |
| const String & | getHelp (void) const |
| Return a String that describes the purpose and usage of this Property. More... | |
| const String & | getName (void) const |
| Return a the name of this Property. More... | |
| const String & | getDataType (void) const |
| Return string data type of this Property. More... | |
| const String & | getOrigin (void) const |
| Return string origin of this Property. More... | |
| virtual String | get (const PropertyReceiver *receiver) const =0 |
| Return the current value of the Property as a String. More... | |
| virtual void | set (PropertyReceiver *receiver, const String &value)=0 |
| Sets the value of the property. More... | |
| virtual bool | isDefault (const PropertyReceiver *receiver) const |
| Returns whether the property is at it's default value. More... | |
| virtual String | getDefault (const PropertyReceiver *receiver) const |
| Returns the default value of the Property as a String. More... | |
| virtual void | writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const |
| Writes out an XML representation of this class to the given stream. More... | |
| virtual void | initialisePropertyReceiver (PropertyReceiver *) const |
| function to allow initialisation of a PropertyReceiver. | |
Additional Inherited Members | |
| Static Public Attributes inherited from CEGUI::Property | |
| static const String | XMLElementName |
| static const String | NameXMLAttributeName |
| static const String | ValueXMLAttributeName |
| Protected Attributes inherited from CEGUI::Property | |
| String | d_name |
| String that stores the Property name. | |
| String | d_help |
| String that stores the Property help text. | |
| String | d_default |
| String that stores the Property default value string. | |
| bool | d_writeXML |
| Specifies whether writeXMLToStream should do anything for this property. | |
| String | d_dataType |
| Holds data type of this property. | |
| String | d_origin |
| Holds origin of this property. | |
Member Function Documentation
◆ isReadable()
|
inlinevirtual |
Returns whether the property is readable.
- Returns
- true if the property is readable.
- false if the property isn't readable.
Reimplemented from CEGUI::Property.
References CEGUI::Property::isReadable().
◆ isWritable()
|
inlinevirtual |
Returns whether the property is writable.
- Returns
- true if the property is writable.
- false if the property isn't writable.
Reimplemented from CEGUI::Property.
References CEGUI::Property::doesWriteXML(), CEGUI::Property::get(), CEGUI::Property::getDataType(), CEGUI::Property::getDefault(), CEGUI::Property::getHelp(), CEGUI::Property::getName(), CEGUI::Property::getOrigin(), CEGUI::Property::initialisePropertyReceiver(), CEGUI::Property::isDefault(), CEGUI::Property::isReadable(), CEGUI::Property::isWritable(), CEGUI::Property::set(), and CEGUI::Property::writeXMLToStream().
