cohtml::ConcretePropertyReadOnly

More…

#include <Property.h>

Inherits from cohtml::TypedProperty< ReturnsByRef< Getter >::ValuePassType >, cohtml::Property

Public Types

	Name
typedef TypedProperty< typename ReturnsByRef< Getter >::ValuePassType >	BaseProperty

Public Functions

	Name
	ConcretePropertyReadOnly(const char * name, Getter getter)
	ConcretePropertyReadOnly(const ConcretePropertyReadOnly & o)
virtual void *	Bind(Binder * binder, void * object) const override Expose the property’s name and value to a binder.
virtual void *	BindValue(Binder * binder, void * object) const override Expose only the value of the property to a binder.
virtual bool	ToArray(Binder * binder, void * object, ArrayInfo * arrayInfo) const override Convert the property value to an array type information. Conversion should succeed only when the underlying type is an array.
virtual void *	Read(Binder * binder, void * object) const override Read the value from a binder.
virtual void *	ReadValue(Binder * binder, void * object) const override Read only the value of the property from a binder.
virtual ConcretePropertyReadOnly *	Clone() const override Clone the property.
virtual BaseProperty::ValuePassType	GetValue(void * object) const override

Additional inherited members

Public Types inherited from cohtml::TypedProperty< ReturnsByRef< Getter >::ValuePassType >

	Name
typedef ValueType	ValuePassType
typedef RemoveConst< ValuePassType >::Type	NoConstValuePassType

Public Functions inherited from cohtml::TypedProperty< ReturnsByRef< Getter >::ValuePassType >

	Name
	TypedProperty(const char * name, bool isByRef =true)
virtual bool	ToBoolean(void * object, bool * boolean) const override Convert the property value to a boolean.
virtual bool	ToNumber(void * object, float * number) const override Convert the property value to a number.
virtual bool	ToNumber(void * object, double * number) const override Convert the property value to a number with double precision.
virtual bool	ToString(void * object, char * buffer, size_t * length) const override Convert the property value to a string representation.
virtual bool	ToColor(void * object, renoir::Color * color) const override Convert the property value to a color value. Implementation is optional. Provides improved performance for data-bind-style-* attributes that accept color values, such as background-color.
virtual bool	ToTransformMatrix2D(void * object, float matrix[6]) const override Convert the property value to a matrix. Implementation is optional. Provides improved performance for data-bind-style-transform2d.
virtual bool	ToPair(Binder * binder, void * object, PairInfo * pairInfo) const override Convert the property value to a pair type information. Conversion should succeed only when the underlying type is a pair.
virtual bool	ToMap(Binder * binder, void * object, MapInfo * mapInfo) const override Convert the property value to a map type information. Conversion should succeed only when the underlying type is a map.
virtual bool	ToObject(Binder * binder, void * object, ObjectInfo * typeInfo) const override Convert the property value to an object type information. Conversion should succeed only when the underlying type is an object (UserType).

Public Functions inherited from cohtml::Property

	Name
	Property(const char * name, bool isByRef =true) Create a new property.
virtual	~Property()
const char *	GetName() const Get the name of the property.
bool	IsByRef() const Can this property be exported By-Ref. Temporaries can not be exported by reference.
virtual bool	ToBoolean(void * object, bool * boolean) const =0 Convert the property value to a boolean.
virtual bool	ToNumber(void * object, float * number) const =0 Convert the property value to a number.
virtual bool	ToNumber(void * object, double * number) const Convert the property value to a number with double precision.
virtual bool	ToString(void * object, char * buffer, size_t * length) const =0 Convert the property value to a string representation.
virtual bool	ToColor(void * object, renoir::Color * color) const =0 Convert the property value to a color value. Implementation is optional. Provides improved performance for data-bind-style-* attributes that accept color values, such as background-color.
virtual bool	ToTransformMatrix2D(void * object, float matrix[6]) const =0 Convert the property value to a matrix. Implementation is optional. Provides improved performance for data-bind-style-transform2d.
virtual bool	ToPair(Binder * binder, void * object, PairInfo * pairInfo) const =0 Convert the property value to a pair type information. Conversion should succeed only when the underlying type is a pair.
virtual bool	ToMap(Binder * binder, void * object, MapInfo * mapInfo) const =0 Convert the property value to a map type information. Conversion should succeed only when the underlying type is a map.
virtual bool	ToObject(Binder * binder, void * object, ObjectInfo * typeInfo) const =0 Convert the property value to an object type information. Conversion should succeed only when the underlying type is an object (UserType).
void *COHERENT_CDECL	operator new(size_t bytes)
void COHERENT_CDECL	operator delete(void * memory)
void *COHERENT_CDECL	operator new[](size_t bytes)
void COHERENT_CDECL	operator delete[](void * memory)

Protected Attributes inherited from cohtml::Property

	Name
const char *	m_Name
bool	m_IsByRef

Detailed Description

template <typename Getter >
class cohtml::ConcretePropertyReadOnly;

Public Types Documentation

typedef BaseProperty

typedef TypedProperty<typename ReturnsByRef<Getter>::ValuePassType> cohtml::ConcretePropertyReadOnly< Getter >::BaseProperty;

Public Functions Documentation

function ConcretePropertyReadOnly

inline ConcretePropertyReadOnly(
    const char * name,
    Getter getter
)

function ConcretePropertyReadOnly

inline ConcretePropertyReadOnly(
    const ConcretePropertyReadOnly & o
)

function Bind

inline virtual void * Bind(
    Binder * binder,
    void * object
) const override

Expose the property’s name and value to a binder.

Parameters:

• binder - the binder to use
• object - object to get the property value from

Return: - adjusted object pointer if necessary

Reimplements: cohtml::Property::Bind

function BindValue

inline virtual void * BindValue(
    Binder * binder,
    void * object
) const override

Expose only the value of the property to a binder.

Parameters:

• binder - the binder to use
• object - object to get the property value from

Return: - adjusted object pointer if necessary

Note: This method should always bind a value. If there is no valid value, the implementation must call binder->BindNull();

Reimplements: cohtml::Property::BindValue

function ToArray

inline virtual bool ToArray(
    Binder * binder,
    void * object,
    ArrayInfo * arrayInfo
) const override

Convert the property value to an array type information. Conversion should succeed only when the underlying type is an array.

Parameters:

• binder - the binder to use
• object - object to get the property value from
• arrayInfo - output parameter. Information about array type - callbacks, properties, methods

Return: true if conversion is possible and successful

Reimplements: cohtml::TypedProperty::ToArray

function Read

inline virtual void * Read(
    Binder * binder,
    void * object
) const override

Read the value from a binder.

Parameters:

• binder - the binder to use
• object - the object to set the property into

Return: - adjusted object pointer if necessary

Reimplements: cohtml::Property::Read

function ReadValue

inline virtual void * ReadValue(
    Binder * binder,
    void * object
) const override

Read only the value of the property from a binder.

Parameters:

• binder - the binder to use
• object - the object to set the property into

Return: - adjusted object pointer if necessary

Reimplements: cohtml::Property::ReadValue

function Clone

inline virtual ConcretePropertyReadOnly * Clone() const override

Clone the property.

Return: a heap allocated copy of the property

Reimplements: cohtml::Property::Clone

function GetValue

inline virtual BaseProperty::ValuePassType GetValue(
    void * object
) const override

Reimplements: cohtml::TypedProperty::GetValue

---