CEGUI::PropertyLinkDefinition< T > Class Template Reference

Class representing a property that links to another property defined on an attached child widget. More...

Inheritance diagram for CEGUI::PropertyLinkDefinition< T >:

Collaboration diagram for CEGUI::PropertyLinkDefinition< T >:

Public Types
typedef TypedProperty< T >::Helper	Helper
typedef ConstVectorIterator < LinkTargetCollection >	LinkTargetIterator
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
	PropertyLinkDefinition (const String &propertyName, const String &widgetName, const String &targetProperty, const String &initialValue, const String &origin, bool redrawOnWrite, bool layoutOnWrite, const String &fireEvent, const String &eventNamespace)
void	addLinkTarget (const String &widget, const String &property)
	add a new link target to property on widget (name).
void	clearLinkTargets ()
	clear all link targets from this link definition.
bool	isTargetProperty (const String &widget, const String &property) const
void	initialisePropertyReceiver (PropertyReceiver *receiver) const
	function to allow initialisation of a PropertyReceiver.
Property *	clone () const
LinkTargetIterator	getLinkTargetIterator () 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 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...
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. More...
virtual void	set (PropertyReceiver *receiver, const String &value)
	Sets the value of the property. More...
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 void	writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
	Writes out an XML representation of this class to the given stream. More...
virtual bool	isReadable () const
	Returns whether the property is readable. More...
virtual bool	isWritable () const
	Returns whether the property is writable. More...
virtual bool	doesWriteXML () const
	Returns whether the property writes to XML streams.

Protected Types
typedef std::pair< String, String >	StringPair
typedef std::vector < StringPair CEGUI_VECTOR_ALLOC(StringPair)>	LinkTargetCollection
	type used for the collection of targets.

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	updateLinkTargets (PropertyReceiver *receiver, typename Helper::pass_type 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. More...
void	writeDefinitionXMLAdditionalAttributes (XMLSerializer &xml_stream) const
void	writeFalagardXMLAttributes (XMLSerializer &xml_stream) const
const Window *	getTargetWindow (const PropertyReceiver *receiver, const String &name) const
	Return a pointer to the target window with the given name.
Window *	getTargetWindow (PropertyReceiver *receiver, const String &name) const
	Return a pointer to the target window with the given name.

Protected Attributes
LinkTargetCollection	d_targets
	collection of targets for this PropertyLinkDefinition.

Additional Inherited Members
Static Public Attributes inherited from CEGUI::PropertyDefinitionBase
static const String	UserStringNameSuffix
	The PropertyDefinition's user string name suffix, which is appended to each #d_userStringName.
Static Public Attributes inherited from CEGUI::Property
static const String	XMLElementName
static const String	NameXMLAttributeName
static const String	ValueXMLAttributeName

Detailed Description

template<typename T>
class CEGUI::PropertyLinkDefinition< T >

Class representing a property that links to another property defined on an attached child widget.

Member Function Documentation

template<typename T >

void CEGUI::PropertyLinkDefinition< 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.

Parameters

xml_stream

XMLSerializer where xml data should be output.

Implements CEGUI::PropertyDefinitionBase.

References CEGUI::XMLSerializer::openTag(), and CEGUI::Falagard_xmlHandler::PropertyLinkDefinitionElement.