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

   1 #ifndef DALI_OBJECT_REGISTRY_H
   2 #define DALI_OBJECT_REGISTRY_H
   3
   4 /*
   5  * Copyright (c) 2020 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  * | objectCreated    | @ref ObjectCreatedSignal()   |
  56  * | objectDestroyed  | @ref ObjectDestroyedSignal() |
  57  * @SINCE_1_0.0
  58  */
  59 class DALI_CORE_API ObjectRegistry : public BaseHandle
  60 {
  61 public:
  62
  63   // Typedefs
  64
  65   /**
  66    * @brief Object created signal.
  67    * @SINCE_1_0.0
  68    */
  69   typedef Signal< void ( BaseHandle ) > ObjectCreatedSignalType;
  70
  71   /**
  72    * @brief Object destroyed signal.
  73    * @SINCE_1_0.0
  74    */
  75   typedef Signal< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType;
  76
  77   /**
  78    * @brief Allows the creation of an empty objectRegistry handle.
  79    *
  80    * To retrieve the current objectRegistry,
  81    * this handle can be set using Stage::GetCurrent().GetObjectRegistry().
  82    * @SINCE_1_0.0
  83    */
  84   ObjectRegistry();
  85
  86   /**
  87    * @brief Destructor.
  88    *
  89    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  90    * @SINCE_1_0.0
  91    */
  92   ~ObjectRegistry();
  93
  94   /**
  95    * @brief This copy constructor is required for (smart) pointer semantics.
  96    *
  97    * @SINCE_1_0.0
  98    * @param[in] handle A reference to the copied handle
  99    */
 100   ObjectRegistry(const ObjectRegistry& handle);
 101
 102   /**
 103    * @brief This assignment operator is required for (smart) pointer semantics.
 104    *
 105    * @SINCE_1_0.0
 106    * @param[in] rhs A reference to the copied handle
 107    * @return A reference to this
 108    */
 109   ObjectRegistry& operator=(const ObjectRegistry& rhs);
 110
 111   /**
 112    * @brief Move constructor.
 113    *
 114    * @SINCE_1_9.22
 115    * @param[in] rhs A reference to the moved handle
 116    */
 117   ObjectRegistry( ObjectRegistry&& rhs );
 118
 119   /**
 120    * @brief Move assignment operator.
 121    *
 122    * @SINCE_1_9.22
 123    * @param[in] rhs A reference to the moved handle
 124    * @return A reference to this handle
 125    */
 126   ObjectRegistry& operator=( ObjectRegistry&& rhs );
 127
 128 public: // Signals
 129
 130   /**
 131    * @brief This signal is emitted when an object is created.
 132    *
 133    * A callback of the following type may be connected:
 134    * @code
 135    *   void YourCallbackName(BaseHandle object);
 136    * @endcode
 137    * @SINCE_1_0.0
 138    * @return The signal to connect to
 139    * @pre The Object has been initialized.
 140    */
 141   ObjectCreatedSignalType& ObjectCreatedSignal();
 142
 143   /**
 144    * @brief This signal is emitted when an object is destroyed.
 145    *
 146    * WARNING: Since this signal is emitted when the object is
 147    * in the process of being destroyed, the RefObject pointer
 148    * passed in the signal should not be modified in anyways.
 149    * And should NOT be used to create an handle. which will
 150    * affect the life time of this destroyed object and leads to
 151    * undefined behaviour.
 152    *
 153    * The only intended use is for Toolkit controls which want to
 154    * keep track of objects being created and destroyed for internal
 155    * bookkeeping.
 156    *
 157    * A callback of the following type may be connected:
 158    * @code
 159    *   void YourCallbackName(const Dali::RefObject* objectPointer);
 160    * @endcode
 161    * @SINCE_1_0.0
 162    * @return The signal to connect to
 163    * @pre The Object has been initialized.
 164    */
 165   ObjectDestroyedSignalType& ObjectDestroyedSignal();
 166
 167 public: // Not intended for application developers
 168
 169   /// @cond internal
 170   /**
 171    * @brief This constructor is used by Dali Get() method.
 172    *
 173    * @SINCE_1_0.0
 174    * @param[in] objectRegistry A pointer to a Dali resource
 175    */
 176   explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
 177   /// @endcond
 178 };
 179
 180 /**
 181  * @}
 182  */
 183 } // namespace Dali
 184
 185 #endif // DALI_OBJECT_REGISTRY_H