1 #ifndef DALI_OBJECT_REGISTRY_H
2 #define DALI_OBJECT_REGISTRY_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/handle.h>
23 #include <dali/public-api/signals/dali-signal.h>
28 * @addtogroup dali_core_object
32 namespace Internal DALI_INTERNAL
38 * @brief The ObjectRegistry notifies it's observers when an object is created.
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.
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.
49 * ObjectRegistry registry = Stage::GetObjectRegistry();
50 * registry.ObjectCreatedSignal().Connect( ObjectCreatedCallbackFunc );
53 * | %Signal Name | Method |
54 * |------------------|------------------------------|
55 * | objectCreated | @ref ObjectCreatedSignal() |
56 * | objectDestroyed | @ref ObjectDestroyedSignal() |
59 class DALI_CORE_API ObjectRegistry : public BaseHandle
65 * @brief Object created signal.
68 using ObjectCreatedSignalType = Signal<void(BaseHandle)>;
71 * @brief Object destroyed signal.
74 using ObjectDestroyedSignalType = Signal<void(const Dali::RefObject*)>;
77 * @brief Allows the creation of an empty objectRegistry handle.
79 * To retrieve the current objectRegistry,
80 * this handle can be set using Stage::GetCurrent().GetObjectRegistry().
88 * This is non-virtual since derived Handle types must not contain data or virtual methods.
94 * @brief This copy constructor is required for (smart) pointer semantics.
97 * @param[in] handle A reference to the copied handle
99 ObjectRegistry(const ObjectRegistry& handle);
102 * @brief This assignment operator is required for (smart) pointer semantics.
105 * @param[in] rhs A reference to the copied handle
106 * @return A reference to this
108 ObjectRegistry& operator=(const ObjectRegistry& rhs);
111 * @brief Move constructor.
114 * @param[in] rhs A reference to the moved handle
116 ObjectRegistry(ObjectRegistry&& rhs) noexcept;
119 * @brief Move assignment operator.
122 * @param[in] rhs A reference to the moved handle
123 * @return A reference to this handle
125 ObjectRegistry& operator=(ObjectRegistry&& rhs) noexcept;
129 * @brief This signal is emitted when an object is created.
131 * A callback of the following type may be connected:
133 * void YourCallbackName(BaseHandle object);
136 * @return The signal to connect to
137 * @pre The Object has been initialized.
139 ObjectCreatedSignalType& ObjectCreatedSignal();
142 * @brief This signal is emitted when an object is destroyed.
144 * WARNING: Since this signal is emitted when the object is
145 * in the process of being destroyed, the RefObject pointer
146 * passed in the signal should not be modified in anyways.
147 * And should NOT be used to create an handle. which will
148 * affect the life time of this destroyed object and leads to
149 * undefined behaviour.
151 * The only intended use is for Toolkit controls which want to
152 * keep track of objects being created and destroyed for internal
155 * A callback of the following type may be connected:
157 * void YourCallbackName(const Dali::RefObject* objectPointer);
160 * @return The signal to connect to
161 * @pre The Object has been initialized.
163 ObjectDestroyedSignalType& ObjectDestroyedSignal();
165 public: // Not intended for application developers
168 * @brief This constructor is used by Dali Get() method.
171 * @param[in] objectRegistry A pointer to a Dali resource
173 explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
182 #endif // DALI_OBJECT_REGISTRY_H