1 #ifndef __DALI_HANDLE_H__
2 #define __DALI_HANDLE_H__
5 * Copyright (c) 2014 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.
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/object/property-types.h>
28 #include <dali/public-api/object/property-value.h>
29 #include <dali/public-api/object/property-notification-declarations.h>
30 #include <dali/public-api/object/ref-object.h>
35 class PropertyNotification;
36 class PropertyCondition;
38 namespace Internal DALI_INTERNAL
44 * @brief Dali::Handle is a handle to an internal property owning Dali object.
46 class DALI_IMPORT_API Handle : public BaseHandle
51 * @brief An Handle's capabilities can be queried using Handle::Supports()
56 * @brief Some objects support dynamic property creation at run-time.
58 * New properties are registered by calling RegisterProperty() with an unused property name.
60 DYNAMIC_PROPERTIES = 0x01,
66 * @brief This constructor is used by Dali New() methods.
68 * @param [in] handle A pointer to a newly allocated Dali resource
70 Handle(Dali::Internal::Object* handle);
73 * @brief This constructor provides an uninitialized Dali::Handle.
75 * This should be initialized with a Dali New() method before use.
76 * Methods called on an uninitialized Dali::Handle will assert.
78 * Handle handle; // uninitialized
79 * handle.SomeMethod(); // unsafe! This will assert
81 * handle = SomeClass::New(); // now initialized
82 * handle.SomeMethod(); // safe
88 * @brief Dali::Handle is intended as a base class
90 * This is non-virtual since derived Handle types must not contain data or virtual methods.
95 * @brief This copy constructor is required for (smart) pointer semantics.
97 * @param [in] handle A reference to the copied handle
99 Handle(const Handle& handle);
102 * @brief This assignment operator is required for (smart) pointer semantics.
104 * @param [in] rhs A reference to the copied handle
105 * @return A reference to this
107 Handle& operator=(const Handle& rhs);
110 * @brief Downcast to a handle.
112 * If not the returned handle is left uninitialized.
113 * @param[in] handle to An object
114 * @return handle or an uninitialized handle
116 static Handle DownCast( BaseHandle handle );
121 * @brief Query whether an handle supports a given capability.
123 * @param[in] capability The queried capability.
124 * @return True if the capability is supported.
126 bool Supports(Capability capability) const;
129 * @brief Query how many properties are provided by an handle.
131 * This may vary between instances of a class, if dynamic properties are supported.
132 * @return The number of properties.
134 unsigned int GetPropertyCount() const;
137 * @brief Query the name of a property.
139 * @param [in] index The index of the property.
140 * @return The name of the property.
142 const std::string& GetPropertyName(Property::Index index) const;
145 * @brief Query the index of a property.
147 * @param [in] name The name of the property.
148 * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name.
150 Property::Index GetPropertyIndex(std::string name) const;
153 * @brief Query whether a property can be set using SetProperty().
155 * @pre Property::INVALID_INDEX < index.
156 * @param [in] index The index of the property.
157 * @return True if the property is writable.
159 bool IsPropertyWritable(Property::Index index) const;
162 * @brief Query whether a writable property can be the target of an animation or constraint.
164 * @param [in] index The index of the property.
165 * @return True if the property is animatable.
167 bool IsPropertyAnimatable(Property::Index index) const;
170 * @brief Query whether a property can be used as in input to a constraint.
172 * @param [in] index The index of the property.
173 * @return True if the property can be used as a constraint input.
175 bool IsPropertyAConstraintInput(Property::Index index) const;
178 * @brief Query the type of a property.
180 * @param [in] index The index of the property.
181 * @return The type of the property.
183 Property::Type GetPropertyType(Property::Index index) const;
186 * @brief Set the value of an existing property.
188 * @pre Handle::IsPropertyWritable(index) returns true.
189 * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
190 * @param [in] index The index of the property.
191 * @param [in] propertyValue The new value of the property.
193 void SetProperty(Property::Index index, Property::Value propertyValue);
196 * @brief Register a new animatable property.
198 * @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
199 * @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
200 * @note Only the following types can be animated:
201 * - Property::BOOLEAN
203 * - Property::INTEGER
204 * - Property::VECTOR2
205 * - Property::VECTOR3
206 * - Property::VECTOR4
207 * - Property::MATRIX3
209 * - Property::ROTATION
210 * @param [in] name The name of the property.
211 * @param [in] propertyValue The new value of the property.
212 * @return The index of the property
214 Property::Index RegisterProperty(std::string name, Property::Value propertyValue);
217 * @brief Register a new property.
219 * Properties can be set as non animatable using property attributes.
220 * @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
221 * @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
222 * @note Only the following types can be animated:
223 * - Property::BOOLEAN
225 * - Property::INTEGER
226 * - Property::VECTOR2
227 * - Property::VECTOR3
228 * - Property::VECTOR4
229 * - Property::MATRIX3
231 * - Property::ROTATION
232 * @param [in] name The name of the property.
233 * @param [in] propertyValue The new value of the property.
234 * @param [in] accessMode The property access mode (writable, animatable etc).
235 * @return The index of the property
237 Property::Index RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode);
240 * @brief Retrieve a property value.
242 * @param [in] index The index of the property.
243 * @return The property value.
245 Property::Value GetProperty(Property::Index index) const;
248 * @brief Convenience function for obtaining a property of a known type.
250 * @pre The property types match i.e. PropertyTypes::Get<T>() is equal to GetPropertyType(index).
251 * @param [in] index The index of the property.
252 * @return The property value.
254 template <typename T>
255 T GetProperty(Property::Index index) const
257 Property::Value value = GetProperty(index);
259 return T( value.Get<T>() );
263 * @brief Retrieve all the property indices for this object (including custom properties).
265 * @param[out] indices A container of property indices for this object.
266 * @note the added container is cleared
268 void GetPropertyIndices( Property::IndexContainer& indices ) const;
271 * @brief Add a property notification to this object.
273 * @param [in] index The index of the property.
274 * @param [in] condition The notification will be triggered when this condition is satisfied.
276 * @return A handle to the newly created PropertyNotification
278 PropertyNotification AddPropertyNotification(Property::Index index,
279 const PropertyCondition& condition);
282 * @brief Add a property notification to this object.
284 * @param [in] index The index of the property.
285 * @param [in] componentIndex Index to the component of a complex property such as a Vector
286 * @param [in] condition The notification will be triggered when this condition is satisfied.
288 * @return A handle to the newly created PropertyNotification
290 PropertyNotification AddPropertyNotification(Property::Index index,
292 const PropertyCondition& condition);
295 * @brief Remove a property notification from this object.
297 * @param [in] propertyNotification The propertyNotification to be removed.
299 void RemovePropertyNotification(Dali::PropertyNotification propertyNotification);
302 * @brief Remove all property notifications from this object.
304 void RemovePropertyNotifications();
310 #endif // __DALI_HANDLE_H__