X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Ftype-registry.h;h=21a9a302f87a51ee277e7b7912f8aca71bffd718;hb=db9a4df3f86a7cc95b73329c780ccb38ca2f1b49;hp=561231bf44be208ea9326022c7514da1de9e499c;hpb=48da56010c22526d2aa19332d7ebfadc22b3967f;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/object/type-registry.h b/dali/public-api/object/type-registry.h index 561231b..21a9a30 100644 --- a/dali/public-api/object/type-registry.h +++ b/dali/public-api/object/type-registry.h @@ -2,7 +2,7 @@ #define __DALI_TYPE_REGISTRY_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,9 +18,9 @@ * */ - // EXTERNAL INCLUDES #include +#include // uint32_t // INTERNAL INCLUDES #include @@ -28,11 +28,16 @@ namespace Dali { +/** + * @addtogroup dali_core_object + * @{ + */ namespace Internal DALI_INTERNAL { class TypeRegistry; } +class DefaultPropertyMetadata; /** * @brief The TypeRegistry allows registration of type instance creation functions. @@ -87,89 +92,110 @@ class TypeRegistry; * Signal and action names follow properties and are by convention lower case hyphen * separated ie 'next-page'. This maintains consistency with the scripted interface. * + * @SINCE_1_0.0 */ -class DALI_IMPORT_API TypeRegistry : public BaseHandle +class DALI_CORE_API TypeRegistry : public BaseHandle { public: - typedef std::vector NameContainer; ///< Container of type names - /** - * @brief Get Type Registry handle. + * @brief Gets Type Registry handle. * + * @SINCE_1_0.0 * @return TypeRegistry handle */ static TypeRegistry Get(); /** * @brief Allows the creation of an empty typeRegistry handle. + * @SINCE_1_0.0 */ TypeRegistry(); /** - * @brief destructor. + * @brief Destructor. + * @SINCE_1_0.0 */ ~TypeRegistry(); /** * @brief This copy constructor is required for (smart) pointer semantics. * - * @param [in] handle A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] handle A reference to the copied handle */ TypeRegistry(const TypeRegistry& handle); /** * @brief This assignment operator is required for (smart) pointer semantics. * - * @param [in] rhs A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] rhs A reference to the copied handle * @return A reference to this */ TypeRegistry& operator=(const TypeRegistry& rhs); /** - * @brief Get TypeInfo for a registered type. + * @brief Gets TypeInfo for a registered type. * - * @param [in] uniqueTypeName A unique type name - * @return TypeInfo if the type exists otherwise an empty handle + * @SINCE_1_0.0 + * @param[in] uniqueTypeName A unique type name + * @return TypeInfo if the type exists, otherwise an empty handle */ TypeInfo GetTypeInfo( const std::string &uniqueTypeName ); /** - * @brief Get TypeInfo for a registered type. + * @brief Gets TypeInfo for a registered type. * - * @param [in] registerType The registered type info - * @return TypeInfo if the type exists otherwise an empty handle + * @SINCE_1_0.0 + * @param[in] registerType The registered type info + * @return TypeInfo if the type exists, otherwise an empty handle */ TypeInfo GetTypeInfo( const std::type_info& registerType ); /** - * @brief Get type names. + * @brief Gets type name count. + * + * @SINCE_1_0.0 + * @return The count + */ + size_t GetTypeNameCount() const; + + /** + * @brief Gets type names by index. * - * @return list of known types by name + * @SINCE_1_0.0 + * @param[in] index The index to get the type name + * @return The type name or an empty string when index is not valid */ - NameContainer GetTypeNames() const; + std::string GetTypeName(size_t index) const; public: // Not intended for application developers + /// @cond internal /** * @brief This constructor is used by Dali Get() method. * - * @param [in] typeRegistry A pointer to a Dali resource + * @SINCE_1_0.0 + * @param[in] typeRegistry A pointer to a Dali resource */ explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry); + /// @endcond }; /** - * @brief Register a type from type info. + * @brief Registers a type from type info. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API TypeRegistration +class DALI_CORE_API TypeRegistration { public: /** * @brief Constructor registers the type creation function. * - * @param [in] registerType the type info for the type to be registered - * @param [in] baseType the base type info of registerType - * @param [in] f registerType instance creation function + * @SINCE_1_0.0 + * @param[in] registerType The type info for the type to be registered + * @param[in] baseType The base type info of registerType + * @param[in] f registerType Instance creation function */ TypeRegistration( const std::type_info& registerType, const std::type_info& baseType, TypeInfo::CreateFunction f ); @@ -177,22 +203,36 @@ public: /** * @brief Constructor registers the type creation function. * - * @param [in] registerType the type info for the type to be registered - * @param [in] baseType the base type info of registerType - * @param [in] f registerType instance creation function - * @param [in] callCreateOnInit If true the creation function is called as part of Dali initialisation + * @SINCE_1_0.0 + * @param[in] registerType the type info for the type to be registered + * @param[in] baseType the base type info of registerType + * @param[in] f registerType instance creation function + * @param[in] callCreateOnInit If true the creation function is called as part of Dali initialization */ TypeRegistration( const std::type_info& registerType, const std::type_info& baseType, TypeInfo::CreateFunction f, bool callCreateOnInit ); /** + * @brief Constructor registers the type creation function. + * + * @SINCE_1_4.0 + * @param[in] registerType the type info for the type to be registered + * @param[in] baseType the base type info of registerType + * @param[in] f registerType instance creation function + * @param[in] defaultProperties the default property meta-data + */ + TypeRegistration( const std::type_info& registerType, const std::type_info& baseType, + TypeInfo::CreateFunction f, const DefaultPropertyMetadata& defaultProperties ); + + /** * @brief Constructor registers the type creation function for a named class or type. * * This allows types to be created dynamically from script. The name must be * unique for successful registration. - * @param [in] name the name of the type to be registered - * @param [in] baseType the base type info of registerType - * @param [in] f registerType instance creation function + * @SINCE_1_0.0 + * @param[in] name the name of the type to be registered + * @param[in] baseType the base type info of registerType + * @param[in] f registerType instance creation function */ TypeRegistration( const std::string& name, const std::type_info& baseType, TypeInfo::CreateFunction f ); @@ -200,7 +240,8 @@ public: /** * @brief The name the type is registered under (derived from type_info). * - * @return the registered name or empty if unregistered + * @SINCE_1_0.0 + * @return The registered name or empty if unregistered */ const std::string RegisteredName() const; @@ -210,41 +251,46 @@ private: }; /** - * @brief Register a signal connector function to a registered type. + * @brief Registers a signal connector function to a registered type. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API SignalConnectorType +class DALI_CORE_API SignalConnectorType { public: /** * @brief Constructor registers the type creation function. * - * @param [in] typeRegistration The TypeRegistration object - * @param [in] name The signal name - * @param [in] func The signal connector function + * @SINCE_1_0.0 + * @param[in] typeRegistration The TypeRegistration object + * @param[in] name The signal name + * @param[in] func The signal connector function */ SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func ); }; /** - * @brief Register an action function. + * @brief Registers an action function. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API TypeAction +class DALI_CORE_API TypeAction { public: /** * @brief Constructor registers the type creation function. * - * @param [in] registered The TypeRegistration object - * @param [in] name The action name - * @param [in] f The action function + * @SINCE_1_0.0 + * @param[in] registered The TypeRegistration object + * @param[in] name The action name + * @param[in] f The action function */ TypeAction( TypeRegistration ®istered, const std::string &name, TypeInfo::ActionFunction f); }; /** - * @brief Register a property for the given type. + * @brief Registers a property for the given type. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API PropertyRegistration +class DALI_CORE_API PropertyRegistration { public: @@ -261,18 +307,18 @@ public: * Property::Value GetProperty( BaseObject* object, Property::Index index ); * @endcode * - * @param [in] registered The TypeRegistration object - * @param [in] name The name of the property - * @param [in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive. - * @param [in] type The property value type. - * @param [in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only. - * @param [in] getFunc The function to call to retrieve the current value of the property. MUST be provided. - * + * @SINCE_1_0.0 + * @param[in] registered The TypeRegistration object + * @param[in] name The name of the property + * @param[in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] type The property value type + * @param[in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only + * @param[in] getFunc The function to call to retrieve the current value of the property. MUST be provided + * @pre "registered" must be registered with the TypeRegistry. * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive. * @note If "setFunc" is NULL, then the property becomes a read-only property. - * @note "getFunc" MUST be provided + * @note "getFunc" MUST be provided. * - * @pre "registered" must be registered with the TypeRegistry. */ PropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type, @@ -280,9 +326,10 @@ public: }; /** - * @brief Register an animatable property for the given type. + * @brief Registers an animatable property for the given type. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API AnimatablePropertyRegistration +class DALI_CORE_API AnimatablePropertyRegistration { public: @@ -293,16 +340,99 @@ public: * value of the property can be retrieved and set via specified * functions. * - * @param [in] registered The TypeRegistration object - * @param [in] name The name of the property - * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive. - * @param [in] type The property value type. - * + * @SINCE_1_0.0 + * @param[in] registered The TypeRegistration object + * @param[in] name The name of the property + * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] type The property value type * @pre "registered" must be registered with the TypeRegistry. */ AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type ); + + /** + * @brief This constructor registers the animatable property with the registered default value. + * + * This constructor is for scene-graph only properties where the + * value of the property can be retrieved and set via specified + * functions. + * + * @SINCE_1_1.18 + * @param[in] registered The TypeRegistration object + * @param[in] name The name of the property + * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] value The property default value + * @pre "registered" must be registered with the TypeRegistry. + */ + AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, const Property::Value& value ); +}; + +/** + * @brief Registers a component of animatable property for the given component index. + * @SINCE_1_0.0 + */ +class DALI_CORE_API AnimatablePropertyComponentRegistration +{ +public: + + /** + * @brief This constructor registers a component of an animatable property where + * the base animatable property must be a property that supports property component + * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have + * been registered. + * + * This constructor is for a component of scene-graph only properties where the + * value of the property can be retrieved and set via specified functions. + * + * @SINCE_1_0.0 + * @param[in] registered The TypeRegistration object + * @param[in] name The name of the component + * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] baseIndex The index of the base animatable property. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] componentIndex The index of the component (e.g. 0 for the x component of a Vector2 property and 1 for the y component of a Vector2 property) + * @pre "registered" must be registered with the TypeRegistry. + */ + AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, uint32_t componentIndex ); }; +/** + * @brief Registers a child property for the given type. + * @SINCE_1_1.35 + */ +class DALI_CORE_API ChildPropertyRegistration +{ +public: + + /** + * @brief This constructor registers an event-thread only child property (i.e. a property + * that the parent supports in its children) with the registered type. + * + * @SINCE_1_1.35 + * @param[in] registered The TypeRegistration object + * @param[in] name The name of the property + * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] type The property value type + * @pre "registered" must be registered with the TypeRegistry. + */ + ChildPropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type ); + + /** + * @brief This constructor registers an event-thread only child property (i.e. a property + * that the parent supports in its children) with the registered type. + * + * @SINCE_1_3.20 + * @param[in] registered The name of the registered type + * @param[in] name The name of the property + * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive + * @param[in] type The property value type + * @pre "registered" must be registered with the TypeRegistry. + */ + ChildPropertyRegistration( const std::string& registered, const std::string& name, Property::Index index, Property::Type type ); +}; + + +/** + * @} + */ } // namespace Dali #endif // header