X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fobject%2Fobject-registry.h;h=38950b21bf7e7aefc3f8be3ffa671e4a1f9ef5cf;hb=16fc4effc857badc41095ff3cb649e9545e2587a;hp=8adf1c3f80600f7c088c4f5f331af7f368201f8d;hpb=b6e41f0ba8c1908b0cc0c7900e3b84ce96d5ef20;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 8adf1c3..38950b2 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) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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,15 +18,16 @@ * */ -// EXTERNAL INCLUDES -#include - // INTERNAL INCLUDES #include #include namespace Dali { +/** + * @addtogroup dali_core_object + * @{ + */ namespace Internal DALI_INTERNAL { @@ -51,8 +52,9 @@ class ObjectRegistry; * Signals * | %Signal Name | Method | * |------------------|------------------------------| - * | object-created | @ref ObjectCreatedSignal() | - * | object-destroyed | @ref ObjectDestroyedSignal() | + * | objectCreated | @ref ObjectCreatedSignal() | + * | objectDestroyed | @ref ObjectDestroyedSignal() | + * @SINCE_1_0.0 */ class DALI_IMPORT_API ObjectRegistry : public BaseHandle { @@ -62,11 +64,13 @@ public: /** * @brief Object created signal + * @SINCE_1_0.0 */ typedef Signal< void ( BaseHandle ) > ObjectCreatedSignalType; /** * @brief Object destroyed signal + * @SINCE_1_0.0 */ typedef Signal< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType; @@ -75,6 +79,7 @@ public: * * To retrieve the current objectRegistry, * this handle can be set using Stage::GetCurrent().GetObjectRegistry(). + * @SINCE_1_0.0 */ ObjectRegistry(); @@ -82,12 +87,14 @@ public: * @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. * + * @SINCE_1_0.0 * @param [in] handle A reference to the copied handle */ ObjectRegistry(const ObjectRegistry& handle); @@ -95,6 +102,7 @@ public: /** * @brief This assignment operator is required for (smart) pointer semantics. * + * @SINCE_1_0.0 * @param [in] rhs A reference to the copied handle * @return A reference to this */ @@ -109,8 +117,9 @@ public: // Signals * @code * void YourCallbackName(BaseHandle object); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ ObjectCreatedSignalType& ObjectCreatedSignal(); @@ -132,8 +141,9 @@ public: // Signals * @code * void YourCallbackName(const Dali::RefObject* objectPointer); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ ObjectDestroyedSignalType& ObjectDestroyedSignal(); @@ -142,11 +152,15 @@ public: // Not intended for application developers /** * @brief This constructor is used by Dali Get() method. * + * @SINCE_1_0.0 * @param [in] objectRegistry A pointer to a Dali resource */ explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry); }; +/** + * @} + */ } // namespace Dali #endif // __DALI_OBJECT_REGISTRY_H__