Tizen(Headed) Native API  6.5
Public Member Functions
Dali::PropertyRegistration Class Reference
Object

Registers a property for the given type. More...

Public Member Functions

 PropertyRegistration (TypeRegistration &registered, const std::string &name, Property::Index index, Property::Type type, TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc)
 This constructor registers the property with the registered type.

Detailed Description

Registers a property for the given type.

Since:
2.4, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::PropertyRegistration::PropertyRegistration ( TypeRegistration &  registered,
const std::string &  name,
Property::Index  index,
Property::Type  type,
TypeInfo::SetPropertyFunction  setFunc,
TypeInfo::GetPropertyFunction  getFunc 
)

This constructor registers the property with the registered type.

This constructor is for event-thread only properties where the value of the property can be retrieved and set via specified functions.

Functions of the following type may be used for setFunc and getFunc respectively: 

   void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
   Property::Value GetProperty( BaseObject* object, Property::Index index );
Since:
2.4, DALi version 1.0.0
Parameters:
[in]registeredThe TypeRegistration object
[in]nameThe name of the property
[in]indexThe property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive
[in]typeThe property value type
[in]setFuncThe function to call when setting the property. If NULL, then the property becomes read-only
[in]getFuncThe function to call to retrieve the current value of the property. MUST be provided
Precondition:
"registered" must be registered with the TypeRegistry.
Note:
The "index" value must be between START_INDEX and MAX_INDEX inclusive.
If "setFunc" is NULL, then the property becomes a read-only property.
"getFunc" MUST be provided.