common base class used for types representing a new property to be available on all widgets that use the WidgetLook that the property definition is a part of. More...

Inheritance diagram for CEGUI::PropertyDefinitionBase:

Collaboration diagram for CEGUI::PropertyDefinitionBase:

Public Member Functions
	PropertyDefinitionBase (const String &name, const String &help, const String &initialValue, bool redrawOnWrite, bool layoutOnWrite, const String &fireEvent, const String &eventNamespace)

const String &	getPropertyName () const

void	setPropertyName (const String &name)

const String &	getInitialValue () const

void	setInitialValue (const String &value)

const String &	getHelpString () const

void	setHelpString (const String &help)

bool	isRedrawOnWrite () const

void	setRedrawOnWrite (bool value)

bool	isLayoutOnWrite () const

void	setLayoutOnWrite (bool value)

const String &	getEventFiredOnWrite () const

void	setEventFiredOnWrite (const String &eventName)

const String &	getEventNamespace () 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. More...

Static Public Attributes
static const String	UserStringNameSuffix
	The PropertyDefinition's user string name suffix, which is appended to each #d_userStringName.

Protected Member Functions
virtual void	writeDefinitionXMLElementType (XMLSerializer &xml_stream) const =0
	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. More...

virtual void	writeDefinitionXMLAttributes (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. More...

Protected Attributes
String	d_propertyName

String	d_initialValue

String	d_helpString

bool	d_writeCausesRedraw

bool	d_writeCausesLayout

String	d_eventFiredOnWrite

String	d_eventNamespace

Detailed Description

common base class used for types representing a new property to be available on all widgets that use the WidgetLook that the property definition is a part of.

Member Function Documentation

virtual void CEGUI::PropertyDefinitionBase::writeDefinitionXMLAttributes ( XMLSerializer & xml_stream ) const

protectedvirtual

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

virtual void CEGUI::PropertyDefinitionBase::writeDefinitionXMLElementType ( XMLSerializer & xml_stream ) const

protectedpure 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.

Parameters

xml_stream XMLSerializer where xml data should be output.

Implemented in CEGUI::PropertyLinkDefinition< T >, and CEGUI::PropertyDefinition< T >.

virtual void CEGUI::PropertyDefinitionBase::writeDefinitionXMLToStream ( XMLSerializer & xml_stream ) const

virtual

Writes an xml representation of the PropertyDefinitionBase based object to out_stream.

Parameters

xml_stream XMLSerializer where xml data should be output.

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation