Crazy Eddie's GUI System  0.8.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::PropertyDefinition< T > Class Template Reference
+ Inheritance diagram for CEGUI::PropertyDefinition< T >:
+ Collaboration diagram for CEGUI::PropertyDefinition< T >:

Public Types

typedef TypedProperty< T >::Helper Helper
- Public Types inherited from CEGUI::FalagardPropertyBase< T >
typedef TypedProperty< T >::Helper Helper
- Public Types inherited from CEGUI::TypedProperty< T >
typedef PropertyHelper< T > Helper

Public Member Functions

 PropertyDefinition (const String &name, const String &initialValue, const String &help, const String &origin, bool redrawOnWrite, bool layoutOnWrite, const String &fireEvent, const String &eventNamespace)
void initialisePropertyReceiver (PropertyReceiver *receiver) const
 function to allow initialisation of a PropertyReceiver.
Propertyclone () const
- Public Member Functions inherited from CEGUI::FalagardPropertyBase< T >
 FalagardPropertyBase (const String &name, const String &help, const String &initialValue, const String &origin, bool redrawOnWrite, bool layoutOnWrite, const String &fireEvent, const String &eventNamespace)
- Public Member Functions inherited from CEGUI::PropertyDefinitionBase
 PropertyDefinitionBase (const String &name, const String &help, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite, const String &fireEvent, const String &eventNamespace)
const StringgetPropertyName () const
void setPropertyName (const String &name)
const StringgetInitialValue () const
void setInitialValue (const String &value)
const StringgetHelpString () const
void setHelpString (const String &help)
bool isRedrawOnWrite () const
void setRedrawOnWrite (bool value)
bool isLayoutOnWrite () const
void setLayoutOnWrite (bool value)
const StringgetEventFiredOnWrite () const
void setEventFiredOnWrite (const String &eventName)
const StringgetEventNamespace () const
void setEventNamespace (const String &eventNamespace)
virtual void writeDefinitionXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of the PropertyDefinitionBase based object to out_stream.
- Public Member Functions inherited from CEGUI::TypedProperty< T >
 TypedProperty (const String &name, const String &help, const String &origin="Unknown", typename Helper::pass_type defaultValue=T(), bool writesXML=true)
virtual String get (const PropertyReceiver *receiver) const
 Return the current value of the Property as a String.
virtual void set (PropertyReceiver *receiver, const String &value)
 Sets the value of the property.
virtual void setNative (PropertyReceiver *receiver, typename Helper::pass_type value)
 native set method, sets the property given a native type
virtual
Helper::safe_method_return_type 
getNative (const PropertyReceiver *receiver) const
 native get method, returns the native type by copy
- 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.
virtual ~Property (void)
 Destructor for Property objects.
const StringgetHelp (void) const
 Return a String that describes the purpose and usage of this Property.
const StringgetName (void) const
 Return a the name of this Property.
const StringgetDataType (void) const
 Return string data type of this Property.
const StringgetOrigin (void) const
 Return string origin of this Property.
virtual bool isDefault (const PropertyReceiver *receiver) const
 Returns whether the property is at it's default value.
virtual String getDefault (const PropertyReceiver *receiver) const
 Returns the default value of the Property as a String.
virtual void writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
 Writes out an XML representation of this class to the given stream.
virtual bool isReadable () const
 Returns whether the property is readable.
virtual bool isWritable () const
 Returns whether the property is writable.
virtual bool doesWriteXML () const
 Returns whether the property writes to XML streams.

Protected Member Functions

Helper::safe_method_return_type getNative_impl (const PropertyReceiver *receiver) const
void setNative_impl (PropertyReceiver *receiver, typename Helper::pass_type value)
void setWindowUserString (Window *window, const String &value) const
void writeDefinitionXMLElementType (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.

Protected Attributes

String d_userStringName

Additional Inherited Members

- Static Public Attributes inherited from CEGUI::Property
static const String XMLElementName
static const String NameXMLAttributeName
static const String ValueXMLAttributeName

Member Function Documentation

template<typename T >
void CEGUI::PropertyDefinition< T >::writeDefinitionXMLElementType ( XMLSerializer xml_stream) const
inlineprotectedvirtual

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_streamXMLSerializer where xml data should be output.

Implements CEGUI::PropertyDefinitionBase.

References CEGUI::XMLSerializer::openTag().