Tizen Native API
6.5
|
TypeInfo class for instantiation of registered types and introspection of their actions and signals. More...
Public Types | |
typedef int32_t | Index |
A valid property index is zero or greater. | |
typedef int32_t | Index |
A valid property index is zero or greater. | |
Public Member Functions | |
TypeInfo () | |
Allows the creation of an empty TypeInfo handle. | |
~TypeInfo () | |
Destructor. | |
TypeInfo (const TypeInfo &handle) | |
This copy constructor is required for (smart) pointer semantics. | |
TypeInfo & | operator= (const TypeInfo &rhs) |
This assignment operator is required for (smart) pointer semantics. | |
const std::string & | GetName () const |
Retrieves the type name for this type. | |
const std::string & | GetBaseName () const |
Retrieves the base type name for this type. | |
BaseHandle | CreateInstance () const |
Creates an object from this type. | |
CreateFunction | GetCreator () const |
Retrieves the creator function for this type. | |
size_t | GetActionCount () const |
Retrieves the number of actions for this type. | |
std::string | GetActionName (size_t index) |
Retrieves the action name for the index. | |
size_t | GetSignalCount () const |
Retrieves the number of signals for this type. | |
std::string | GetSignalName (size_t index) |
Retrieves the signal name for the index. | |
size_t | GetPropertyCount () const |
Retrieves the number of event side type registered properties for this type. | |
void | GetPropertyIndices (Property::IndexContainer &indices) const |
Retrieves all the property indices for this type. | |
void | GetChildPropertyIndices (Property::IndexContainer &indices) const |
Retrieves all the child property indices for this type. | |
const std::string & | GetPropertyName (Property::Index index) const |
Given a property index, retrieve the property name associated with it. | |
Property::Index | GetChildPropertyIndex (const std::string &name) const |
Given a child property name, retrieve the property index associated with it,. | |
const std::string & | GetChildPropertyName (Property::Index index) const |
Given a child property index, retrieve the property name associated with it. | |
Property::Type | GetChildPropertyType (Property::Index index) const |
Given a child property index, retrieve the property name associated with it. |
Detailed Description
TypeInfo class for instantiation of registered types and introspection of their actions and signals.
See TypeRegistry for methods of type registration and TypeInfo retrieval.
- Since:
- 2.4, DALi version 1.0.0
Member Typedef Documentation
typedef int32_t Dali::Property::Index |
A valid property index is zero or greater.
- Since:
- 2.4, DALi version 1.0.0
typedef int32_t Dali::Property::Index |
A valid property index is zero or greater.
- Since:
- 2.4, DALi version 1.0.0
Constructor & Destructor Documentation
Allows the creation of an empty TypeInfo handle.
- Since:
- 2.4, DALi version 1.0.0
Destructor.
This is non-virtual since derived Handle types must not contain data or virtual methods.
- Since:
- 2.4, DALi version 1.0.0
Dali::TypeInfo::TypeInfo | ( | const TypeInfo & | handle | ) |
This copy constructor is required for (smart) pointer semantics.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] handle A reference to the copied handle
Member Function Documentation
BaseHandle Dali::TypeInfo::CreateInstance | ( | ) | const |
Creates an object from this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The BaseHandle for the newly created object
size_t Dali::TypeInfo::GetActionCount | ( | ) | const |
Retrieves the number of actions for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The count
std::string Dali::TypeInfo::GetActionName | ( | size_t | index | ) |
Retrieves the action name for the index.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index Index to lookup
- Returns:
- Action name or empty string where index is invalid
const std::string& Dali::TypeInfo::GetBaseName | ( | ) | const |
Retrieves the base type name for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- String of base name
Property::Index Dali::TypeInfo::GetChildPropertyIndex | ( | const std::string & | name | ) | const |
Given a child property name, retrieve the property index associated with it,.
- Since:
- 5.0, DALi version 1.3.20
- Parameters:
-
[in] name The name of the property at the given index,
- Returns:
- The property index or Property::INVALID_INDEX
void Dali::TypeInfo::GetChildPropertyIndices | ( | Property::IndexContainer & | indices | ) | const |
Retrieves all the child property indices for this type.
- Since:
- 5.0, DALi version 1.3.20
- Parameters:
-
[out] indices Container of property indices
- Note:
- The container will be cleared
const std::string& Dali::TypeInfo::GetChildPropertyName | ( | Property::Index | index | ) | const |
Given a child property index, retrieve the property name associated with it.
- Since:
- 5.0, DALi version 1.3.20
- Parameters:
-
[in] index The property index
- Returns:
- The name of the property at the given index, or empty string if it does not exist
Property::Type Dali::TypeInfo::GetChildPropertyType | ( | Property::Index | index | ) | const |
Given a child property index, retrieve the property name associated with it.
- Since:
- 5.0, DALi version 1.3.20
- Parameters:
-
[in] index The property index
- Returns:
- The name of the property at the given index, or empty string if it does not exist
CreateFunction Dali::TypeInfo::GetCreator | ( | ) | const |
Retrieves the creator function for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The creator function
const std::string& Dali::TypeInfo::GetName | ( | ) | const |
Retrieves the type name for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- String name
size_t Dali::TypeInfo::GetPropertyCount | ( | ) | const |
Retrieves the number of event side type registered properties for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The count
void Dali::TypeInfo::GetPropertyIndices | ( | Property::IndexContainer & | indices | ) | const |
Retrieves all the property indices for this type.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[out] indices Container of property indices
- Note:
- The container will be cleared
const std::string& Dali::TypeInfo::GetPropertyName | ( | Property::Index | index | ) | const |
Given a property index, retrieve the property name associated with it.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index The property index
- Returns:
- The name of the property at the given index
- Exceptions:
-
DaliException If index is not valid.
- Note:
- this method only works for custom registered properties
size_t Dali::TypeInfo::GetSignalCount | ( | ) | const |
Retrieves the number of signals for this type.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The count
std::string Dali::TypeInfo::GetSignalName | ( | size_t | index | ) |
Retrieves the signal name for the index.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index Index to lookup
- Returns:
- Signal name or empty string where index is invalid