CEGUI::TplProperty< C, T > Class Template Reference

Inherits CEGUI::TypedProperty< T >.

Inherited by CEGUI::TplWindowProperty< Window, String >, CEGUI::TplWindowProperty< C, T >, and CEGUI::TplWindowRendererProperty< C, T >.

Collaboration diagram for CEGUI::TplProperty< C, T >:

Classes
struct	GetterFunctor

Public Types
typedef PropertyHelper< T >	Helper
typedef void(C::*	Setter) (typename Helper::pass_type)
Public Types inherited from CEGUI::TypedProperty< T >
typedef PropertyHelper< T >	Helper

Public Member Functions
	TplProperty (const String &name, const String &help, const String &origin, Setter setter, GetterFunctor getter, typename Helper::pass_type defaultValue=T(), bool writesXML=true)
virtual bool	isReadable () const
	Returns whether the property is readable.
virtual bool	isWritable () const
	Returns whether the property is writable.
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")
virtual	~Property (void)
	Destructor for Property objects.
const String &	getHelp (void) const
	Return a String that describes the purpose and usage of this Property.
const String &	getName (void) const
	Return a the name of this Property.
const String &	getDataType (void) const
	Return string data type of this Property.
const String &	getOrigin (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	doesWriteXML () const
	Returns whether the property writes to XML streams.
virtual void	initialisePropertyReceiver (PropertyReceiver *) const
	function to allow initialisation of a PropertyReceiver.
virtual Property *	clone () const =0

Protected Attributes
Setter	d_setter
GetterFunctor	d_getter
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.

Additional Inherited Members
Static Public Attributes inherited from CEGUI::Property
static const String	XMLElementName
static const String	NameXMLAttributeName
static const String	ValueXMLAttributeName
Protected Member Functions inherited from CEGUI::TypedProperty< T >
virtual void	setNative_impl (PropertyReceiver *receiver, typename Helper::pass_type value)=0
virtual Helper::safe_method_return_type	getNative_impl (const PropertyReceiver *receiver) const =0

Member Function Documentation

isReadable()

template<class C , typename T >

virtual bool CEGUI::TplProperty< C, T >::isReadable ( ) const

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.

isWritable()

template<class C , typename T >

virtual bool CEGUI::TplProperty< C, T >::isWritable ( ) const

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.