Alias to another Attribute object. More...

#include <Valuable/AttributeAlias.hpp>

Inheritance diagram for Valuable::AttributeAlias:

Public Member Functions
virtual float	asFloat (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the target object to a floating point number. More...

virtual int	asInt (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the target object to an integer. More...

virtual QString	asString (bool *const ok=0, Layer layer=LAYER_CURRENT) const
	Converts the target value to a string. More...

Attribute *	attribute () const
	Get the target Attribute where this class points to.

virtual Attribute *	attribute (const QByteArray &name) const
	Gets an Attribute with the given name. More...

	AttributeAlias (Node host, const QByteArray &name, Attribute attribute)

virtual void	clearValue (Layer layout)
	Unsets the value from a specific layer. More...

virtual bool	deserialize (const ArchiveElement &element)
	Deserializes (reads) this object from serializer element. More...

virtual void	eventProcess (const QByteArray &id, Radiant::BinaryData &data)
	Calls the target eventProcess-function.

virtual bool	handleShorthand (const StyleValue &value, Radiant::ArrayMap< Attribute *, StyleValue > &expanded)
	If attribute supports shorthand properties, this should be used to parse those. More...

virtual bool	isChanged () const
	Returns true if the current value of the target object is different from the original value.

virtual bool	isValueDefinedOnLayer (Layer layer) const
	Check if the given layer defines a value. More...

virtual ArchiveElement	serialize (Archive &archive) const
	The object is serialized using its name as a tag name. More...

virtual bool	set (float v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the target object.

virtual bool	set (int v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the target object.

virtual bool	set (const QString &v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
	Sets the value of the target object.

virtual bool	set (const Nimble::Vector2f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the target object.

virtual bool	set (const Nimble::Vector3f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the target object.

virtual bool	set (const Nimble::Vector4f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
	Sets the value of the target object.

virtual bool	set (const StyleValue &v, Layer layer=USER)
	Sets the value of the target object.

virtual void	setAsDefaults ()
	Sets the current USER attribute value as the default value and clears the USER value. More...

void	setAttribute (Attribute *attribute)
	Set the target Attribute where this class points to.

virtual QByteArray	type () const
	Get the type id of the attribute. More...

Public Member Functions inherited from Valuable::Attribute
long	addListener (ListenerFunc func, int role=CHANGE_ROLE)
	Adds a listener that is invoked whenever the value is changed. More...

long	addListener (Node *listener, ListenerFunc func, int role=CHANGE_ROLE)
	Adds a listener that is invoked whenever the value is changed. More...

long	addListener (v8::Persistent< v8::Function > func, int role=CHANGE_ROLE)
	Adds a JavaScript listener that is invoked whenever the value is changed. More...

	Attribute (const Attribute &o)
	Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...

	Attribute (Node *host, const QByteArray &name, bool transit=false)
	Constructs a new value object and attaches it to its host. More...

virtual void	emitChange ()
	Invokes the change valueChanged function of all listeners.

void	eventProcessFloat (const char *id, float v)
	Utility function for sending a float message to the object.

void	eventProcessInt (const char *id, int v)
	Utility function for sending an int message to the object.

void	eventProcessString (const char *id, const QString &str)
	Utility function for sending string message to the object.

void	eventProcessString (const char id, const char str)
	Utility function for sending string message to the object.

void	eventProcessVector2 (const char *id, Nimble::Vector2)
	Utility function for sending a Nimble::Vector2f message to the object.

void	eventProcessVector3 (const char *id, Nimble::Vector3)
	Utility function for sending a Vector3 message to the object.

void	eventProcessVector4 (const char *id, Nimble::Vector4)
	Utility function for sending a Vector4 message to the object.

Node *	host () const
	The host object of the value object (is any). More...

bool	layerForSerialization (SerializationOptions flags, Layer &layer) const

const QByteArray &	name () const
	Returns the name of the object.

const Attribute &	operator= (const Attribute &)
	Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...

Attribute *	ownerShorthand () const

QByteArray	path () const
	Returns the path (separated by '/'s) from the root.

void	removeHost ()
	Sets the host pointer to zero and removes this object from the host. More...

bool	removeListener (Node *listener, int role=ALL_ROLES)
	Removes a listener from the listener list. More...

bool	removeListener (long id)
	Removes a listener from the listener list. More...

void	removeListeners (int role=ALL_ROLES)
	Removes listeners from the listener list.

void	setName (const QByteArray &s)
	Sets the name of the object.

void	setOwnerShorthand (Attribute *owner)

Public Member Functions inherited from Valuable::Serializable
virtual bool	deserializeXML (const DOMElement &element)
	Deserializes (reads) this object from an XML element. More...

bool	isSerializable () const

void	setSerializable (bool v)

Additional Inherited Members
Public Types inherited from Valuable::Attribute
enum	Layer { DEFAULT = 0, STYLE, USER, STYLE_IMPORTANT, LAYER_COUNT, LAYER_CURRENT }
	Attribute has multiple independent attribute values on LAYER_COUNT different layers. More...

typedef std::function< void()>	ListenerFunc
	Callback function type in the listener API.

enum	ListenerRole { DELETE_ROLE = 1 << 0, CHANGE_ROLE = 1 << 1, ALL_ROLES = (CHANGE_ROLE << 1) -1 }
	Different listener roles, used when adding a new listener.

enum	ValueUnit { VU_UNKNOWN, VU_PXS, VU_PERCENTAGE, VU_EMS, VU_EXS }
	Units of a value. More...

Protected Member Functions inherited from Valuable::Attribute
virtual void	emitDelete ()
	Invokes the change valueDeleted function of all listeners.

Detailed Description

Alias to another Attribute object.

Member Function Documentation

virtual float Valuable::AttributeAlias::asFloat	(	bool *const	ok = `0`,
		Layer	layer = `LAYER_CURRENT`
	)		const

virtual

Converts the target object to a floating point number.

Parameters

ok	If non-null, *ok is set to true/false on success/error

Returns: Object as a float

Reimplemented from Valuable::Attribute.

virtual int Valuable::AttributeAlias::asInt	(	bool *const	ok = `0`,
		Layer	layer = `LAYER_CURRENT`
	)		const

virtual

Converts the target object to an integer.

Parameters

ok	If non-null, *ok is set to true/false on success/error

Returns: Object as a int

Reimplemented from Valuable::Attribute.

virtual QString Valuable::AttributeAlias::asString	(	bool *const	ok = `0`,
		Layer	layer = `LAYER_CURRENT`
	)		const

virtual

Converts the target value to a string.

Parameters

ok	If non-null, *ok is set to true/false on success/error

Returns: Object as a string

Reimplemented from Valuable::Attribute.

virtual Attribute* Valuable::AttributeAlias::attribute ( const QByteArray & name ) const

virtual

Gets an Attribute with the given name.

Parameters

name	Attribute name to search for

Returns: Null if no object can be found

Reimplemented from Valuable::Attribute.

virtual void Valuable::AttributeAlias::clearValue ( Layer layer )

virtual

Unsets the value from a specific layer.

Parameters

layer layer to clear, must not be DEFAULT, since DEFAULT layer should always be set

Reimplemented from Valuable::Attribute.

virtual bool Valuable::AttributeAlias::deserialize ( const ArchiveElement & element )

virtual

Deserializes (reads) this object from serializer element.

Parameters

element Serialized element that holds the data that should be deserialized.

Returns: Returns true if the read process worked correctly, and false otherwise.

Implements Valuable::Serializable.

virtual bool Valuable::AttributeAlias::handleShorthand	(	const StyleValue &	value,
		Radiant::ArrayMap< Attribute *, StyleValue > &	expanded
	)

virtual

If attribute supports shorthand properties, this should be used to parse those.

For example "background: url('image.png') repeat" is a shorhand for setting background-image to "url('image.png')" and background-repeat to "repeat".

Parameters

[in]	value	shorthand value
[out]	expanded	shorthand property split to parts. With the previous background-example map should have two values.

Returns: true if shorthand was successfully handled

See Also: http://www.w3.org/TR/CSS21/about.html#shorthand

Reimplemented from Valuable::Attribute.

virtual bool Valuable::AttributeAlias::isValueDefinedOnLayer ( Layer layer ) const

virtual

Check if the given layer defines a value.

Parameters

layer layer to check

Returns: true if the given value defines a layer; otherwise false

Reimplemented from Valuable::Attribute.

virtual ArchiveElement Valuable::AttributeAlias::serialize ( Archive & archive ) const

virtual

The object is serialized using its name as a tag name.

Parameters

archive Serialization archive that is used to create new elements.

Returns: Serialized object as an ArchiveElement

Reimplemented from Valuable::Attribute.

virtual void Valuable::AttributeAlias::setAsDefaults ( )

virtual

Sets the current USER attribute value as the default value and clears the USER value.

Reimplemented from Valuable::Attribute.

virtual QByteArray Valuable::AttributeAlias::type ( ) const

virtual

Get the type id of the attribute.

Returns: type of the attribute

Reimplemented from Valuable::Attribute.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation