X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Fobject-registry.h;h=203d676368b411c858d3ec983b93fa0ad4bc0a92;hb=646f736e77b085c86e982c0d1d4b895c2a431330;hp=c6bb7ef947b128fa9b6871e634ffda9c44b9c62c;hpb=f874caf255436bf9ca3b5ef6844c17d0811c84a4;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/object/object-registry.h b/dali/public-api/object/object-registry.h index c6bb7ef..203d676 100644 --- a/dali/public-api/object/object-registry.h +++ b/dali/public-api/object/object-registry.h @@ -2,7 +2,7 @@ #define __DALI_OBJECT_REGISTRY_H__ /* - * Copyright (c) 2015 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. @@ -43,7 +43,7 @@ class ObjectRegistry; * * Care should be taken to not store the handle in the Observer, as this will * have adverse effect on the life time of the Internal Object. The Handle - * should only be used to connect to signals + * should only be used to connect to signals. * * Usage: * ObjectRegistry registry = Stage::GetObjectRegistry(); @@ -54,20 +54,23 @@ class ObjectRegistry; * |------------------|------------------------------| * | objectCreated | @ref ObjectCreatedSignal() | * | objectDestroyed | @ref ObjectDestroyedSignal() | + * @SINCE_1_0.0 */ -class DALI_IMPORT_API ObjectRegistry : public BaseHandle +class DALI_CORE_API ObjectRegistry : public BaseHandle { public: // Typedefs /** - * @brief Object created signal + * @brief Object created signal. + * @SINCE_1_0.0 */ typedef Signal< void ( BaseHandle ) > ObjectCreatedSignalType; /** - * @brief Object destroyed signal + * @brief Object destroyed signal. + * @SINCE_1_0.0 */ typedef Signal< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType; @@ -76,27 +79,31 @@ public: * * To retrieve the current objectRegistry, * this handle can be set using Stage::GetCurrent().GetObjectRegistry(). + * @SINCE_1_0.0 */ ObjectRegistry(); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~ObjectRegistry(); /** * @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 */ ObjectRegistry(const ObjectRegistry& 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 */ ObjectRegistry& operator=(const ObjectRegistry& rhs); @@ -110,8 +117,9 @@ public: // Signals * @code * void YourCallbackName(BaseHandle object); * @endcode + * @SINCE_1_0.0 + * @return The signal to connect to * @pre The Object has been initialized. - * @return The signal to connect to. */ ObjectCreatedSignalType& ObjectCreatedSignal(); @@ -133,19 +141,23 @@ public: // Signals * @code * void YourCallbackName(const Dali::RefObject* objectPointer); * @endcode + * @SINCE_1_0.0 + * @return The signal to connect to * @pre The Object has been initialized. - * @return The signal to connect to. */ ObjectDestroyedSignalType& ObjectDestroyedSignal(); public: // Not intended for application developers + /// @cond internal /** * @brief This constructor is used by Dali Get() method. * - * @param [in] objectRegistry A pointer to a Dali resource + * @SINCE_1_0.0 + * @param[in] objectRegistry A pointer to a Dali resource */ explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry); + /// @endcond }; /**