projects
/
platform
/
core
/
uifw
/
dali-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Making DALi public API typesafe using guaranteed types; uint8_t, uint32_t
[platform/core/uifw/dali-core.git]
/
dali
/
public-api
/
object
/
object-registry.h
diff --git
a/dali/public-api/object/object-registry.h
b/dali/public-api/object/object-registry.h
index
507db99
..
203d676
100644
(file)
--- 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__
/*
#define __DALI_OBJECT_REGISTRY_H__
/*
- * Copyright (c) 201
4
Samsung Electronics Co., Ltd.
+ * Copyright (c) 201
8
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.
*
* 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 <boost/function.hpp>
-
// INTERNAL INCLUDES
#include <dali/public-api/object/handle.h>
// INTERNAL INCLUDES
#include <dali/public-api/object/handle.h>
-#include <dali/public-api/signals/dali-signal
-v2
.h>
+#include <dali/public-api/signals/dali-signal.h>
namespace Dali
{
namespace Dali
{
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
namespace Internal DALI_INTERNAL
{
namespace Internal DALI_INTERNAL
{
@@
-42,59
+43,67
@@
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
*
* 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();
* registry.ObjectCreatedSignal().Connect( ObjectCreatedCallbackFunc );
*
*
* Usage:
* ObjectRegistry registry = Stage::GetObjectRegistry();
* registry.ObjectCreatedSignal().Connect( ObjectCreatedCallbackFunc );
*
+ * Signals
+ * | %Signal Name | Method |
+ * |------------------|------------------------------|
+ * | 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:
{
public:
- //Signal Names
- static const char* const SIGNAL_OBJECT_CREATED; ///< Created signal name
- static const char* const SIGNAL_OBJECT_DESTROYED; ///< Destroyed signal name
-
// Typedefs
/**
// Typedefs
/**
- * @brief Object created signal
+ * @brief Object created signal.
+ * @SINCE_1_0.0
*/
*/
- typedef Signal
V2< void (BaseHandle) > ObjectCreatedSignalV2
;
+ typedef Signal
< void ( BaseHandle ) > ObjectCreatedSignalType
;
/**
/**
- * @brief Object destroyed signal
+ * @brief Object destroyed signal.
+ * @SINCE_1_0.0
*/
*/
- typedef Signal
V2< void (const Dali::RefObject*) > ObjectDestroyedSignalV2
;
+ typedef Signal
< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType
;
/**
* @brief Allows the creation of an empty objectRegistry handle.
*
* To retrieve the current objectRegistry,
* this handle can be set using Stage::GetCurrent().GetObjectRegistry().
/**
* @brief Allows the creation of an empty objectRegistry handle.
*
* To retrieve the current objectRegistry,
* this handle can be set using Stage::GetCurrent().GetObjectRegistry().
+ * @SINCE_1_0.0
*/
ObjectRegistry();
/**
*/
ObjectRegistry();
/**
- * @brief Destructor
+ * @brief Destructor
.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
*
* 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.
*
*/
~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.
*
*/
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);
* @return A reference to this
*/
ObjectRegistry& operator=(const ObjectRegistry& rhs);
@@
-108,10
+117,11
@@
public: // Signals
* @code
* void YourCallbackName(BaseHandle object);
* @endcode
* @code
* void YourCallbackName(BaseHandle object);
* @endcode
+ * @SINCE_1_0.0
+ * @return The signal to connect to
* @pre The Object has been initialized.
* @pre The Object has been initialized.
- * @return The signal to connect to.
*/
*/
- ObjectCreatedSignal
V2
& ObjectCreatedSignal();
+ ObjectCreatedSignal
Type
& ObjectCreatedSignal();
/**
* @brief This signal is emitted when an object is destroyed.
/**
* @brief This signal is emitted when an object is destroyed.
@@
-131,21
+141,28
@@
public: // Signals
* @code
* void YourCallbackName(const Dali::RefObject* objectPointer);
* @endcode
* @code
* void YourCallbackName(const Dali::RefObject* objectPointer);
* @endcode
+ * @SINCE_1_0.0
+ * @return The signal to connect to
* @pre The Object has been initialized.
* @pre The Object has been initialized.
- * @return The signal to connect to.
*/
*/
- ObjectDestroyedSignal
V2
& ObjectDestroyedSignal();
+ ObjectDestroyedSignal
Type
& ObjectDestroyedSignal();
public: // Not intended for application developers
public: // Not intended for application developers
+ /// @cond internal
/**
* @brief This constructor is used by Dali Get() method.
*
/**
* @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);
*/
explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
+ /// @endcond
};
};
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_OBJECT_REGISTRY_H__
} // namespace Dali
#endif // __DALI_OBJECT_REGISTRY_H__