CEGUI::Window::WindowRendererProperty Class Reference

Property to access/change the assigned window renderer object. More...

Inheritance diagram for CEGUI::Window::WindowRendererProperty:

Collaboration diagram for CEGUI::Window::WindowRendererProperty:

Public Member Functions
void	writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
	Writes out an XML representation of this class to the given stream. More...
Public Member Functions inherited from CEGUI::TplWindowProperty< Window, String >
	TplWindowProperty (const String &name, const String &help, const String &origin, typename TplProperty< Window, String >::Setter setter, typename TplProperty< Window, String >::GetterFunctor getter, typename TplProperty< Window, String >::Helper::pass_type defaultValue=String(), bool writesXML=true)
virtual Property *	clone () const
Public Member Functions inherited from CEGUI::TplProperty< Window, String >
	TplProperty (const String &name, const String &help, const String &origin, Setter setter, GetterFunctor getter, typename Helper::pass_type defaultValue=String(), bool writesXML=true)
virtual bool	isReadable () const
virtual bool	isWritable () const
Public Member Functions inherited from CEGUI::TypedProperty< String >
	TypedProperty (const String &name, const String &help, const String &origin="Unknown", typename Helper::pass_type defaultValue=String(), bool writesXML=true)
virtual String	get (const PropertyReceiver *receiver) const
virtual void	set (PropertyReceiver *receiver, const String &value)
virtual void	setNative (PropertyReceiver *receiver, typename Helper::pass_type value)
	native set method, sets the property given a native type More...
virtual Helper::safe_method_return_type	getNative (const PropertyReceiver *receiver) const
	native get method, returns the native type by copy More...
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 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 bool	doesWriteXML () const
	Returns whether the property writes to XML streams.
virtual void	initialisePropertyReceiver (PropertyReceiver *) const
	function to allow initialisation of a PropertyReceiver.

Additional Inherited Members
Public Types inherited from CEGUI::TplProperty< Window, String >
typedef PropertyHelper< String >	Helper
typedef void(Window::*	Setter) (typename Helper::pass_type)
Public Types inherited from CEGUI::TypedProperty< String >
typedef PropertyHelper< String >	Helper
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::TplWindowProperty< Window, String >
void	setNative_impl (PropertyReceiver *receiver, typename TplProperty< Window, String >::Helper::pass_type value)
TplProperty< Window, String >::Helper::safe_method_return_type	getNative_impl (const PropertyReceiver *receiver) const
Protected Member Functions inherited from CEGUI::TypedProperty< String >
virtual void	setNative_impl (PropertyReceiver *receiver, typename Helper::pass_type value)=0
Protected Attributes inherited from CEGUI::TplProperty< Window, String >
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.

Detailed Description

Property to access/change the assigned window renderer object.

Usage:

• Name: WindowRenderer
• Format: "[windowRendererName]"

Where [windowRendererName] is the factory name of the window

renderer type you wish to assign.

Member Function Documentation

void CEGUI::Window::WindowRendererProperty::writeXMLToStream ( const PropertyReceiver *  receiver, XMLSerializer &  xml_stream  ) const

virtual

Writes out an XML representation of this class to the given stream.

Note

This would normally have been implemented via XMLGenerator base class, but in this case we require the target PropertyReceiver in order to obtain the property value.

Reimplemented from CEGUI::Property.