All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Valuable::FlagAliasT< T > Class Template Reference

This class provides a mechanism to toggle individual flags on and off using their name from CSS. More...

#include <Valuable/AttributeFlags.hpp>

Inheritance diagram for Valuable::FlagAliasT< T >:
Valuable::FlagAlias Valuable::Attribute Valuable::Serializable

Public Member Functions

virtual int asInt (bool *const ok, Layer layer) const
 Converts the value object in an integer. More...
 
void clearValue (Layer layout)
 Unsets the value from a specific layer. More...
 
bool deserialize (const ArchiveElement &e)
 Deserializes (reads) this object from serializer element. More...
 
 FlagAliasT (Node *parent, AttributeFlagsT< T > &master, const QByteArray &name, Radiant::FlagsT< T > flags)
 
Radiant::FlagsT< T > flags () const
 
virtual bool handleShorthand (const Valuable::StyleValue &value, Radiant::ArrayMap< Valuable::Attribute *, Valuable::StyleValue > &expanded)
 If attribute supports shorthand properties, this should be used to parse those. More...
 
virtual bool isValueDefinedOnLayer (Layer layer) const
 Check if the given layer defines a value. More...
 
ArchiveElement serialize (Archive &archive) const
 The object is serialized using its name as a tag name. More...
 
virtual bool set (int v, Layer layer, ValueUnit)
 Sets the value of the object.
 
bool set (const StyleValue &v, Layer layer)
 Sets the value of the object.
 
void setSources (std::vector< FlagAliasT< T > * > sources)
 
std::vector< FlagAliasT< T > * > & sources ()
 
- Public Member Functions inherited from Valuable::FlagAlias
 FlagAlias (Node *parent, const QByteArray &name)
 
- 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...
 
virtual float asFloat (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object in a floating point number. More...
 
virtual QString asString (bool *const ok=0, Layer layer=LAYER_CURRENT) const
 Converts the value object to a string. 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 Attributeattribute (const QByteArray &name) const
 Gets an Attribute with the given name. More...
 
virtual void emitChange ()
 Invokes the change valueChanged function of all listeners.
 
virtual void eventProcess (const QByteArray &id, Radiant::BinaryData &data)
 Process a message. More...
 
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.
 
Nodehost () const
 The host object of the value object (is any). More...
 
virtual bool isChanged () const
 
bool layerForSerialization (SerializationOptions flags, Layer &layer) const
 
const QByteArray & name () const
 Returns the name of the object.
 
const Attributeoperator= (const Attribute &)
 Create a copy of the given Attribute WITHOUT the link to host, listeners, or the attribute name. More...
 
AttributeownerShorthand () 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.
 
virtual bool set (float v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const QString &v, Layer layer=USER, ValueUnit unit=VU_UNKNOWN)
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector2f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector3f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual bool set (const Nimble::Vector4f &v, Layer layer=USER, QList< ValueUnit > units=QList< ValueUnit >())
 Sets the value of the object.
 
virtual void setAsDefaults ()
 Sets the current USER attribute value as the default value and clears the USER value. More...
 
void setName (const QByteArray &s)
 Sets the name of the object.
 
void setOwnerShorthand (Attribute *owner)
 
virtual QByteArray type () const
 Get the type id of the attribute. More...
 
- 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)
 

Friends

class AttributeFlagsT< T >
 

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

template<typename T>
class Valuable::FlagAliasT< T >

This class provides a mechanism to toggle individual flags on and off using their name from CSS.

With this class we can write things like:

input-pass-to-children: true;
}

Member Function Documentation

template<typename T >
virtual int Valuable::FlagAliasT< T >::asInt ( bool *const  ok,
Layer  layer 
) const
inlinevirtual

Converts the value object in an integer.

Parameters
okIf non-null, *ok is set to true/false on success/error
Returns
Object as a int, the default implementation returns zero

Reimplemented from Valuable::Attribute.

template<typename T >
void Valuable::FlagAliasT< T >::clearValue ( Layer  layer)
inlinevirtual

Unsets the value from a specific layer.

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

Reimplemented from Valuable::Attribute.

template<typename T >
bool Valuable::FlagAliasT< T >::deserialize ( const ArchiveElement element)
inlinevirtual

Deserializes (reads) this object from serializer element.

Parameters
elementSerialized element that holds the data that should be deserialized.
Returns
Returns true if the read process worked correctly, and false otherwise.

Implements Valuable::Serializable.

template<typename T >
virtual bool Valuable::FlagAliasT< T >::handleShorthand ( const Valuable::StyleValue value,
Radiant::ArrayMap< Valuable::Attribute *, Valuable::StyleValue > &  expanded 
)
inlinevirtual

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]valueshorthand value
[out]expandedshorthand 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.

template<typename T >
virtual bool Valuable::FlagAliasT< T >::isValueDefinedOnLayer ( Layer  layer) const
inlinevirtual

Check if the given layer defines a value.

Parameters
layerlayer to check
Returns
true if the given value defines a layer; otherwise false

Reimplemented from Valuable::Attribute.

template<typename T >
ArchiveElement Valuable::FlagAliasT< T >::serialize ( Archive archive) const
inlinevirtual

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

Parameters
archiveSerialization archive that is used to create new elements.
Returns
Serialized object as an ArchiveElement

Reimplemented from Valuable::Attribute.