dali/public-api/object/handle.h

   1 #ifndef __DALI_HANDLE_H__
   2 #define __DALI_HANDLE_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  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>
  31
  32 namespace Dali DALI_IMPORT_API
  33 {
  34
  35 class PropertyNotification;
  36 class PropertyCondition;
  37
  38 namespace Internal DALI_INTERNAL
  39 {
  40 class Object;
  41 }
  42
  43 /**
  44  * @brief Dali::Handle is a handle to an internal property owning Dali object.
  45  */
  46 class Handle : public BaseHandle
  47 {
  48 public:
  49
  50   /**
  51    * @brief An Handle's capabilities can be queried using Handle::Supports()
  52    */
  53   enum Capability
  54   {
  55     /**
  56      * @brief Some objects support dynamic property creation at run-time.
  57      *
  58      * New properties are registered by calling RegisterProperty() with an unused property name.
  59      */
  60     DYNAMIC_PROPERTIES = 0x01,
  61   };
  62
  63 public:
  64
  65   /**
  66    * @brief This constructor is used by Dali New() methods.
  67    *
  68    * @param [in] handle A pointer to a newly allocated Dali resource
  69    */
  70   Handle(Dali::Internal::Object* handle);
  71
  72   /**
  73    * @brief This constructor provides an uninitialized Dali::Handle.
  74    *
  75    * This should be initialized with a Dali New() method before use.
  76    * Methods called on an uninitialized Dali::Handle will assert.
  77    * @code
  78    * Handle handle; // uninitialized
  79    * handle.SomeMethod(); // unsafe! This will assert
  80    *
  81    * handle = SomeClass::New(); // now initialized
  82    * handle.SomeMethod(); // safe
  83    * @endcode
  84    */
  85   Handle();
  86
  87   /**
  88    * @brief Dali::Handle is intended as a base class
  89    *
  90    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  91    */
  92   ~Handle();
  93
  94   /**
  95    * @brief This copy constructor is required for (smart) pointer semantics.
  96    *
  97    * @param [in] handle A reference to the copied handle
  98    */
  99   Handle(const Handle& handle);
 100
 101   /**
 102    * @brief This assignment operator is required for (smart) pointer semantics.
 103    *
 104    * @param [in] rhs  A reference to the copied handle
 105    * @return A reference to this
 106    */
 107   Handle& operator=(const Handle& rhs);
 108
 109   /**
 110    * @copydoc Dali::BaseHandle::operator=
 111    */
 112   using BaseHandle::operator=;
 113
 114   /**
 115    * @brief Downcast to a handle.
 116    *
 117    * If not the returned handle is left uninitialized.
 118    * @param[in] handle to An object
 119    * @return handle or an uninitialized handle
 120    */
 121   static Handle DownCast( BaseHandle handle );
 122
 123 public:
 124
 125   /**
 126    * @brief Query whether an handle supports a given capability.
 127    *
 128    * @param[in] capability The queried capability.
 129    * @return True if the capability is supported.
 130    */
 131   bool Supports(Capability capability) const;
 132
 133   /**
 134    * @brief Query how many properties are provided by an handle.
 135    *
 136    * This may vary between instances of a class, if dynamic properties are supported.
 137    * @return The number of properties.
 138    */
 139   unsigned int GetPropertyCount() const;
 140
 141   /**
 142    * @brief Query the name of a property.
 143    *
 144    * @param [in] index The index of the property.
 145    * @return The name of the property.
 146    */
 147   const std::string& GetPropertyName(Property::Index index) const;
 148
 149   /**
 150    * @brief Query the index of a property.
 151    *
 152    * @param [in] name The name of the property.
 153    * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name.
 154    */
 155   Property::Index GetPropertyIndex(std::string name) const;
 156
 157   /**
 158    * @brief Query whether a property can be set using SetProperty().
 159    *
 160    * @pre Property::INVALID_INDEX < index.
 161    * @param [in] index The index of the property.
 162    * @return True if the property is writable.
 163    */
 164   bool IsPropertyWritable(Property::Index index) const;
 165
 166   /**
 167    * @brief Query whether a writable property can be the target of an animation or constraint.
 168    *
 169    * @param [in] index The index of the property.
 170    * @return True if the property is animatable.
 171    */
 172   bool IsPropertyAnimatable(Property::Index index) const;
 173
 174   /**
 175    * @brief Query whether a property can be used as in input to a constraint.
 176    *
 177    * @param [in] index The index of the property.
 178    * @return True if the property can be used as a constraint input.
 179    */
 180   bool IsPropertyAConstraintInput(Property::Index index) const;
 181
 182   /**
 183    * @brief Query the type of a property.
 184    *
 185    * @param [in] index The index of the property.
 186    * @return The type of the property.
 187    */
 188   Property::Type GetPropertyType(Property::Index index) const;
 189
 190   /**
 191    * @brief Set the value of an existing property.
 192    *
 193    * @pre Handle::IsPropertyWritable(index) returns true.
 194    * @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
 195    * @param [in] index The index of the property.
 196    * @param [in] propertyValue The new value of the property.
 197    */
 198   void SetProperty(Property::Index index, Property::Value propertyValue);
 199
 200   /**
 201    * @brief Register a new property.
 202    *
 203    * @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
 204    * @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
 205    * @param [in] name The name of the property.
 206    * @param [in] propertyValue The new value of the property.
 207    * @return The index of the property
 208    */
 209   Property::Index RegisterProperty(std::string name, Property::Value propertyValue);
 210
 211   /**
 212    * @brief Register a new property.
 213    *
 214    * Properties can be set as non animatable using property attributes.
 215    * @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
 216    * @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
 217    * @param [in] name The name of the property.
 218    * @param [in] propertyValue The new value of the property.
 219    * @param [in] accessMode The property access mode (writable, animatable etc).
 220    * @return The index of the property
 221    */
 222   Property::Index RegisterProperty(std::string name, Property::Value propertyValue, Property::AccessMode accessMode);
 223
 224   /**
 225    * @brief Retrieve a property value.
 226    *
 227    * @param [in] index The index of the property.
 228    * @return The property value.
 229    */
 230   Property::Value GetProperty(Property::Index index) const;
 231
 232   /**
 233    * @brief Convenience function for obtaining a property of a known type.
 234    *
 235    * @pre The property types match i.e. PropertyTypes::Get<T>() is equal to GetPropertyType(index).
 236    * @param [in] index The index of the property.
 237    * @return The property value.
 238    */
 239   template <typename T>
 240   T GetProperty(Property::Index index) const
 241   {
 242     Property::Value value = GetProperty(index);
 243
 244     return T( value.Get<T>() );
 245   }
 246
 247   /**
 248    * @brief Retrieve all the property indices for this object (including custom properties).
 249    *
 250    * @param[out] indices A container of property indices for this object.
 251    * @note the added container is cleared
 252    */
 253   void GetPropertyIndices( Property::IndexContainer& indices ) const;
 254
 255   /**
 256    * @brief Add a property notification to this object.
 257    *
 258    * @param [in] index The index of the property.
 259    * @param [in] condition The notification will be triggered when this condition is satisfied.
 260    *
 261    * @return A handle to the newly created PropertyNotification
 262    */
 263   PropertyNotification AddPropertyNotification(Property::Index index,
 264                                                const PropertyCondition& condition);
 265
 266   /**
 267    * @brief Add a property notification to this object.
 268    *
 269    * @param [in] index The index of the property.
 270    * @param [in] componentIndex Index to the component of a complex property such as a Vector
 271    * @param [in] condition The notification will be triggered when this condition is satisfied.
 272    *
 273    * @return A handle to the newly created PropertyNotification
 274    */
 275   PropertyNotification AddPropertyNotification(Property::Index index,
 276                                                int componentIndex,
 277                                                const PropertyCondition& condition);
 278
 279   /**
 280    * @brief Remove a property notification from this object.
 281    *
 282    * @param [in] propertyNotification The propertyNotification to be removed.
 283    */
 284   void RemovePropertyNotification(Dali::PropertyNotification propertyNotification);
 285
 286   /**
 287    * @brief Remove all property notifications from this object.
 288    */
 289   void RemovePropertyNotifications();
 290
 291 };
 292
 293 } // namespace Dali
 294
 295 #endif // __DALI_HANDLE_H__