dali/public-api/object/object-registry.h

   1 #ifndef __DALI_OBJECT_REGISTRY_H__
   2 #define __DALI_OBJECT_REGISTRY_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/handle.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali_core_object
  29  * @{
  30  */
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class ObjectRegistry;
  35 }
  36
  37 /**
  38  * @brief The ObjectRegistry notifies it's observers when an object is created.
  39  *
  40  * Handle to the created Object is passed in the call back function.
  41  * The Handle is passed as Dali::Object handle, which can be DownCast
  42  * to the appropriate type.
  43  *
  44  * Care should be taken to not store the handle in the Observer, as this will
  45  * have adverse effect on the life time of the Internal Object. The Handle
  46  * should only be used to connect to signals
  47  *
  48  * Usage:
  49  * ObjectRegistry registry = Stage::GetObjectRegistry();
  50  * registry.ObjectCreatedSignal().Connect( ObjectCreatedCallbackFunc );
  51  *
  52  * Signals
  53  * | %Signal Name     | Method                       |
  54  * |------------------|------------------------------|
  55  * | object-created   | @ref ObjectCreatedSignal()   |
  56  * | object-destroyed | @ref ObjectDestroyedSignal() |
  57  */
  58 class DALI_IMPORT_API ObjectRegistry : public BaseHandle
  59 {
  60 public:
  61
  62   // Typedefs
  63
  64   /**
  65    * @brief Object created signal
  66    */
  67   typedef Signal< void ( BaseHandle ) > ObjectCreatedSignalType;
  68
  69   /**
  70    * @brief Object destroyed signal
  71    */
  72   typedef Signal< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType;
  73
  74   /**
  75    * @brief Allows the creation of an empty objectRegistry handle.
  76    *
  77    * To retrieve the current objectRegistry,
  78    * this handle can be set using Stage::GetCurrent().GetObjectRegistry().
  79    */
  80   ObjectRegistry();
  81
  82   /**
  83    * @brief Destructor
  84    *
  85    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  86    */
  87   ~ObjectRegistry();
  88
  89   /**
  90    * @brief This copy constructor is required for (smart) pointer semantics.
  91    *
  92    * @param [in] handle A reference to the copied handle
  93    */
  94   ObjectRegistry(const ObjectRegistry& handle);
  95
  96   /**
  97    * @brief This assignment operator is required for (smart) pointer semantics.
  98    *
  99    * @param [in] rhs  A reference to the copied handle
 100    * @return A reference to this
 101    */
 102   ObjectRegistry& operator=(const ObjectRegistry& rhs);
 103
 104 public: // Signals
 105
 106   /**
 107    * @brief This signal is emitted when an object is created.
 108    *
 109    * A callback of the following type may be connected:
 110    * @code
 111    *   void YourCallbackName(BaseHandle object);
 112    * @endcode
 113    * @pre The Object has been initialized.
 114    * @return The signal to connect to.
 115    */
 116   ObjectCreatedSignalType& ObjectCreatedSignal();
 117
 118   /**
 119    * @brief This signal is emitted when an object is destroyed.
 120    *
 121    * WARNING: Since this signal is emitted when the object is
 122    * in the process of being destroyed, the RefObject pointer
 123    * passed in the signal should not be modified in anyways.
 124    * And should NOT be used to create an handle. which will
 125    * affect the life time of this destroyed object and leads to
 126    * undefined behaviour.
 127    *
 128    * The only intended use is for Toolkit controls which want to
 129    * keep track of objects being created and destroyed for internal
 130    * bookkeeping.
 131    *
 132    * A callback of the following type may be connected:
 133    * @code
 134    *   void YourCallbackName(const Dali::RefObject* objectPointer);
 135    * @endcode
 136    * @pre The Object has been initialized.
 137    * @return The signal to connect to.
 138    */
 139   ObjectDestroyedSignalType& ObjectDestroyedSignal();
 140
 141 public: // Not intended for application developers
 142
 143   /**
 144    * @brief This constructor is used by Dali Get() method.
 145    *
 146    * @param [in] objectRegistry A pointer to a Dali resource
 147    */
 148   explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
 149 };
 150
 151 /**
 152  * @}
 153  */
 154 } // namespace Dali
 155
 156 #endif // __DALI_OBJECT_REGISTRY_H__