dali/public-api/object/property-notification.h

   1 #ifndef __DALI_PROPERTY_NOTIFICATION_H__
   2 #define __DALI_PROPERTY_NOTIFICATION_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/base-handle.h>
  23 #include <dali/public-api/object/property-notification-declarations.h>
  24 #include <dali/public-api/object/property-conditions.h>
  25 #include <dali/public-api/object/property.h>
  26
  27 namespace Dali
  28 {
  29 /**
  30  * @addtogroup dali_core_object
  31  * @{
  32  */
  33
  34 namespace Internal DALI_INTERNAL
  35 {
  36 class PropertyNotification;
  37 }
  38
  39 /**
  40  * @brief This is used to issue a notification upon a condition of the property being met.
  41  *
  42  * For example checking if Actor::POSITION_X > 100.0.
  43  * @SINCE_1_0.0
  44  * @see Dali::PropertyCondition
  45  */
  46 class DALI_IMPORT_API PropertyNotification : public BaseHandle
  47 {
  48 public:
  49   /**
  50    * @brief Enumeration for description of how to check condition.
  51    * @SINCE_1_0.0
  52    */
  53   enum NotifyMode
  54   {
  55     Disabled,                             ///< Don't notify, regardless of result of Condition @SINCE_1_0.0
  56     NotifyOnTrue,                         ///< Notify whenever condition changes from false to true. @SINCE_1_0.0
  57     NotifyOnFalse,                        ///< Notify whenever condition changes from true to false. @SINCE_1_0.0
  58     NotifyOnChanged                       ///< Notify whenever condition changes (false to true, and true to false) @SINCE_1_0.0
  59   };
  60
  61 public:
  62
  63   /**
  64    * @brief Creates an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().
  65    *
  66    * Calling member functions with an uninitialized Dali::Object is not allowed.
  67    * @SINCE_1_0.0
  68    */
  69   PropertyNotification();
  70
  71   /**
  72    * @brief Downcasts a handle to PropertyNotification handle.
  73    *
  74    * If handle points to a PropertyNotification object, the downcast
  75    * produces valid handle. If not, the returned handle is left
  76    * uninitialized.
  77    *
  78    * @SINCE_1_0.0
  79    * @param[in] handle to An object
  80    * @return handle to a PropertyNotification object or an uninitialized handle
  81    */
  82   static PropertyNotification DownCast( BaseHandle handle );
  83
  84   /**
  85    * @brief Destructor.
  86    *
  87    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  88    * @SINCE_1_0.0
  89    */
  90   ~PropertyNotification();
  91
  92   /**
  93    * @brief This copy constructor is required for (smart) pointer semantics.
  94    *
  95    * @SINCE_1_0.0
  96    * @param[in] handle A reference to the copied handle
  97    */
  98   PropertyNotification(const PropertyNotification& handle);
  99
 100   /**
 101    * @brief This assignment operator is required for (smart) pointer semantics.
 102    *
 103    * @SINCE_1_0.0
 104    * @param[in] rhs A reference to the copied handle
 105    * @return A reference to this
 106    */
 107   PropertyNotification& operator=(const PropertyNotification& rhs);
 108
 109   /**
 110    * @brief Gets the condition of this notification.
 111    *
 112    * @SINCE_1_0.0
 113    * @return The condition is returned
 114    */
 115   PropertyCondition GetCondition();
 116
 117   /**
 118    * @brief Gets the condition of this notification.
 119    *
 120    * @SINCE_1_0.0
 121    * @return The condition is returned
 122    */
 123   const PropertyCondition& GetCondition() const;
 124
 125   /**
 126    * @brief Gets the target handle that this notification is observing.
 127    * @SINCE_1_0.0
 128    * @return The target handle
 129    */
 130   Dali::Handle GetTarget() const;
 131
 132   /**
 133    * @brief Gets the target handle's property index that this notification
 134    * is observing.
 135    *
 136    * @SINCE_1_0.0
 137    * @return The target property
 138    */
 139   Property::Index GetTargetProperty() const;
 140
 141   /**
 142    * @brief Sets the Notification mode.
 143    *
 144    * This determines how the property
 145    * notification should respond to the result of a condition.
 146    *
 147    * @SINCE_1_0.0
 148    * @param[in] mode Notification mode (Default is PropertyNotification::NotifyOnTrue)
 149    */
 150   void SetNotifyMode( NotifyMode mode );
 151
 152   /**
 153    * @brief Retrieves the current Notification mode.
 154    *
 155    * @SINCE_1_0.0
 156    * @return Notification mode
 157    */
 158   NotifyMode GetNotifyMode();
 159
 160   /**
 161    * @brief Gets the result of the last condition check that caused a signal emit,
 162    * useful when using NotifyOnChanged mode and need to know what it changed to.
 163    *
 164    * @SINCE_1_0.0
 165    * @return whether condition result that triggered last emit was true or false
 166    */
 167   bool GetNotifyResult() const;
 168
 169   /**
 170    * @brief Connects to this signal to be notified when the notification has occurred.
 171    *
 172    * @SINCE_1_0.0
 173    * @return A signal object to Connect() with
 174    */
 175   PropertyNotifySignalType& NotifySignal();
 176
 177 public: // Not intended for use by Application developers
 178
 179   /**
 180    * @internal
 181    * @brief This constructor is used by Dali New() methods.
 182    *
 183    * @SINCE_1_0.0
 184    * @param[in] propertyNotification A pointer to a newly allocated Dali resource
 185    */
 186   explicit DALI_INTERNAL PropertyNotification(Internal::PropertyNotification* propertyNotification);
 187 };
 188
 189 /**
 190  * @}
 191  */
 192 } // namespace Dali
 193
 194 #endif // __DALI_PROPERTY_NOTIFICATION_H__