[dali_1.2.11] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / public-api / object / property-notification.h

diff --git a/dali/public-api/object/property-notification.h b/dali/public-api/object/property-notification.h
index ef14b7f..0bb56ac 100644 (file)
--- a/dali/public-api/object/property-notification.h
+++ b/dali/public-api/object/property-notification.h
@@ -2,7 +2,7 @@
 #define __DALI_PROPERTY_NOTIFICATION_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -36,6 +40,7 @@ class PropertyNotification;
  * @brief This is used to issue a notification upon a condition of the property being met.
  *
  * For example checking if Actor::POSITION_X > 100.0.
+ * @SINCE_1_0.0
  * @see Dali::PropertyCondition
  */
 class DALI_IMPORT_API PropertyNotification : public BaseHandle
@@ -43,13 +48,14 @@ class DALI_IMPORT_API PropertyNotification : public BaseHandle
 public:
   /**
    * @brief Enumeration to describe how to check condition
+   * @SINCE_1_0.0
    */
   enum NotifyMode
   {
-    Disabled,                             ///< Don't notify, regardless of result of Condition
-    NotifyOnTrue,                         ///< Notify whenever condition changes from false to true.
-    NotifyOnFalse,                        ///< Notify whenever condition changes from true to false.
-    NotifyOnChanged                       ///< Notify whenever condition changes (false to true, and true to false)
+    Disabled,                             ///< Don't notify, regardless of result of Condition @SINCE_1_0.0
+    NotifyOnTrue,                         ///< Notify whenever condition changes from false to true. @SINCE_1_0.0
+    NotifyOnFalse,                        ///< Notify whenever condition changes from true to false. @SINCE_1_0.0
+    NotifyOnChanged                       ///< Notify whenever condition changes (false to true, and true to false) @SINCE_1_0.0
   };
 
 public:
@@ -58,16 +64,18 @@ public:
    * @brief Create an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().
    *
    * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * @SINCE_1_0.0
    */
   PropertyNotification();
 
   /**
-   * @brief Downcast an Object handle to PropertyNotification.
+   * @brief Downcast a handle to PropertyNotification handle.
    *
    * If handle points to an PropertyNotification object the downcast
    * produces valid handle. If not the returned handle is left
    * uninitialized.
    *
+   * @SINCE_1_0.0
    * @param[in] handle to An object
    * @return handle to a PropertyNotification object or an uninitialized handle
    */
@@ -77,12 +85,14 @@ public:
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~PropertyNotification();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] handle A reference to the copied handle
    */
   PropertyNotification(const PropertyNotification& handle);
@@ -90,24 +100,16 @@ public:
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] rhs  A reference to the copied handle
    * @return A reference to this
    */
   PropertyNotification& operator=(const PropertyNotification& rhs);
 
   /**
-   * @brief This method is defined to allow assignment of the NULL value,
-   * and will throw an exception if passed any other value.
-   *
-   * Assigning to NULL is an alias for Reset().
-   * @param [in] rhs  A NULL pointer
-   * @return A reference to this handle
-   */
-  PropertyNotification& operator=(BaseHandle::NullType* rhs);
-
-  /**
    * @brief Get the condition of this notification
    *
+   * @SINCE_1_0.0
    * @return The condition is returned
    */
   PropertyCondition GetCondition();
@@ -115,12 +117,15 @@ public:
   /**
    * @brief Get the condition of this notification
    *
+   * @SINCE_1_0.0
    * @return The condition is returned
    */
   const PropertyCondition& GetCondition() const;
 
   /**
    * @brief Get the target handle that this notification is observing.
+   * @SINCE_1_0.0
+   * @return The target handle
    */
   Dali::Handle GetTarget() const;
 
@@ -128,14 +133,18 @@ public:
    * @brief Get the target handle's property index that this notification
    * is observing.
    *
+   * @SINCE_1_0.0
    * @return The target property.
    */
   Property::Index GetTargetProperty() const;
 
   /**
-   * @brief Sets the Notification mode. This determines how the property
+   * @brief Sets the Notification mode.
+   *
+   * This determines how the property
    * notification should respond to the result of a condition.
    *
+   * @SINCE_1_0.0
    * @param[in] mode Notification mode (Default is PropertyNotification::NotifyOnTrue)
    */
   void SetNotifyMode( NotifyMode mode );
@@ -143,6 +152,7 @@ public:
   /**
    * @brief Retrieves the current Notification mode.
    *
+   * @SINCE_1_0.0
    * @return Notification mode.
    */
   NotifyMode GetNotifyMode();
@@ -151,6 +161,7 @@ public:
    * @brief Gets the result of the last condition check that caused a signal emit,
    * useful when using NotifyOnChanged mode and need to know what it changed to.
    *
+   * @SINCE_1_0.0
    * @return whether condition result that triggered last emit was true or false
    */
   bool GetNotifyResult() const;
@@ -158,20 +169,27 @@ public:
   /**
    * @brief Connect to this signal to be notified when the notification has occurred.
    *
+   * @SINCE_1_0.0
    * @return A signal object to Connect() with.
    */
-  PropertyNotifySignalV2& NotifySignal();
+  PropertyNotifySignalType& NotifySignal();
 
 public: // Not intended for use by Application developers
 
+  /// @cond internal
   /**
    * @brief This constructor is used by Dali New() methods.
    *
+   * @SINCE_1_0.0
    * @param [in] propertyNotification A pointer to a newly allocated Dali resource
    */
   explicit DALI_INTERNAL PropertyNotification(Internal::PropertyNotification* propertyNotification);
+  /// @endcond
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_NOTIFICATION_H__