X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Ftype-info.h;h=bcce2bc87ba4a0fdee2ab84d4c4ea99b35fa559c;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=bc7376f55ed8dbe153db09e11b7740f4f74bb1f9;hpb=125ec6872f317edb3a6e2fd4707896877e74c42c;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/object/type-info.h b/dali/public-api/object/type-info.h index bc7376f..bcce2bc 100644 --- a/dali/public-api/object/type-info.h +++ b/dali/public-api/object/type-info.h @@ -43,22 +43,24 @@ namespace Internal DALI_INTERNAL * their actions and signals. * * See TypeRegistry for methods of type registration and TypeInfo retrieval. + * @SINCE_1_0.0 */ class DALI_IMPORT_API TypeInfo : public BaseHandle { public: - typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type. + typedef BaseHandle (*CreateFunction)(); ///< Function signature for creating an instance of the associated object type. @SINCE_1_0.0 - typedef bool (*ActionFunction)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions + typedef bool (*ActionFunction)(BaseObject*, const std::string&, const Property::Map&); ///< Function signature for creating scriptable actions @SINCE_1_0.0 /** * @brief Connects a callback function with the object's signals. * - * @param[in] object The object providing the signal. - * @param[in] tracker Used to disconnect the signal. - * @param[in] signalName The signal to connect to. - * @param[in] functor A newly allocated FunctorDelegate. - * @return True if the signal was connected. + * @SINCE_1_0.0 + * @param[in] object The object providing the signal + * @param[in] tracker Used to disconnect the signal + * @param[in] signalName The signal to connect to + * @param[in] functor A newly allocated FunctorDelegate + * @return True if the signal was connected * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. */ typedef bool (*SignalConnectorFunction)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor); @@ -66,112 +68,127 @@ public: /** * @brief Callback to set an event-thread only property. * + * @SINCE_1_0.0 + * @param[in] object The object whose property should be set + * @param[in] index The index of the property being set + * @param[in] value The new value of the property for the object specified * @see PropertyRegistration. - * @param[in] object The object whose property should be set. - * @param[in] index The index of the property being set. - * @param[in] value The new value of the property for the object specified. */ typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value ); /** * @brief Callback to get the value of an event-thread only property. * + * @SINCE_1_0.0 + * @param[in] object The object whose property value is required + * @param[in] index The index of the property required + * @return The current value of the property for the object specified * @see PropertyRegistration. - * @param[in] object The object whose property value is required. - * @param[in] index The index of the property required. - * @return The current value of the property for the object specified. */ typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index ); /** * @brief Allows the creation of an empty TypeInfo handle. + * @SINCE_1_0.0 */ TypeInfo(); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~TypeInfo(); /** * @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 */ TypeInfo(const TypeInfo& 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 */ TypeInfo& operator=(const TypeInfo& rhs); /** - * @brief Retrieve the type name for this type. + * @brief Retrieves the type name for this type. * - * @return string name + * @SINCE_1_0.0 + * @return String name */ const std::string& GetName() const; /** - * @brief Retrieve the base type name for this type. + * @brief Retrieves the base type name for this type. * - * @return string of base name + * @SINCE_1_0.0 + * @return String of base name */ const std::string& GetBaseName() const; /** - * @brief Create an object from this type. + * @brief Creates an object from this type. * - * @return the BaseHandle for the newly created object + * @SINCE_1_0.0 + * @return The BaseHandle for the newly created object */ BaseHandle CreateInstance() const; /** - * @brief Retrieve the creator function for this type. + * @brief Retrieves the creator function for this type. * - * @return the creator function + * @SINCE_1_0.0 + * @return The creator function */ CreateFunction GetCreator() const; /** - * @brief Retrieve the number of actions for this type. + * @brief Retrieves the number of actions for this type. * + * @SINCE_1_0.0 * @return The count */ size_t GetActionCount() const; /** - * @brief Retrieve the action name for the index. + * @brief Retrieves the action name for the index. * + * @SINCE_1_0.0 * @param[in] index Index to lookup - * @return action name or empty string where index is invalid + * @return Action name or empty string where index is invalid */ std::string GetActionName(size_t index); /** - * @brief Retrieve the number of signals for this type. + * @brief Retrieves the number of signals for this type. * + * @SINCE_1_0.0 * @return The count */ size_t GetSignalCount() const; /** - * @brief Retrieve the signal name for the index. + * @brief Retrieves the signal name for the index. * + * @SINCE_1_0.0 * @param[in] index Index to lookup - * @return signal name or empty string where index is invalid + * @return Signal name or empty string where index is invalid */ std::string GetSignalName(size_t index); /** - * @brief Retrieve the number of event side type registered properties for this type. + * @brief Retrieves the number of event side type registered properties for this type. * - * This count does not include all properties + * This count does not include all properties. + * @SINCE_1_0.0 * @return The count */ size_t GetPropertyCount() const; @@ -179,8 +196,9 @@ public: // Properties /** - * @brief Retrieve all the property indices for this type. + * @brief Retrieves all the property indices for this type. * + * @SINCE_1_0.0 * @param[out] indices Container of property indices * @note The container will be cleared */ @@ -189,19 +207,22 @@ public: /** * @brief Given a property index, retrieve the property name associated with it. * + * @SINCE_1_0.0 + * @param[in] index The property index + * @return The name of the property at the given index * @exception DaliException If index is not valid. * - * @param[in] index The property index. - * @return The name of the property at the given index. */ const std::string& GetPropertyName( Property::Index index ) const; public: // Not intended for application developers /** + * @internal * @brief This constructor is used by Dali Get() method. * - * @param [in] typeInfo A pointer to a Dali resource + * @SINCE_1_0.0 + * @param[in] typeInfo A pointer to a Dali resource */ explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);