Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / dali / public-api / events / gesture.h
index 68ec415..0e89d41 100644 (file)
@@ -48,12 +48,15 @@ struct DALI_IMPORT_API Gesture
   /**
    * @brief Copy constructor.
    * @since_tizen 2.4
+   * @param[in] rhs A reference to the copied handle
    */
   Gesture( const Gesture& rhs );
 
   /**
    * @brief Assignment operator.
    * @since_tizen 2.4
+   * @param[in] rhs A reference to the copied handle
+   * @return A reference to this
    */
   Gesture& operator=( const Gesture& rhs );
 
@@ -71,10 +74,10 @@ struct DALI_IMPORT_API Gesture
    */
   enum Type
   {
-    Pinch      = 1 << 0, ///< When two touch points move away or towards each other.
-    Pan        = 1 << 1, ///< When the user drags their finger(s) in a particular direction.
-    Tap        = 1 << 2, ///< When the user taps the screen.
-    LongPress  = 1 << 3  ///< When the user continues to touch the same area on the screen for the device configured time.
+    Pinch      = 1 << 0, ///< When two touch points move away or towards each other. @since_tizen 2.4
+    Pan        = 1 << 1, ///< When the user drags their finger(s) in a particular direction. @since_tizen 2.4
+    Tap        = 1 << 2, ///< When the user taps the screen. @since_tizen 2.4
+    LongPress  = 1 << 3  ///< When the user continues to touch the same area on the screen for the device configured time. @since_tizen 2.4
   };
 
   /**
@@ -83,12 +86,12 @@ struct DALI_IMPORT_API Gesture
    */
   enum State
   {
-    Clear,      ///< There is no state associated with this gesture.
-    Started,    ///< The touched points on the screen have moved enough to be considered a gesture.
-    Continuing, ///< The gesture is continuing.
-    Finished,   ///< The user has lifted a finger or touched an additional point on the screen.
-    Cancelled,  ///< The gesture has been cancelled.
-    Possible    ///< A gesture is possible.
+    Clear,      ///< There is no state associated with this gesture. @since_tizen 2.4
+    Started,    ///< The touched points on the screen have moved enough to be considered a gesture. @since_tizen 2.4
+    Continuing, ///< The gesture is continuing. @since_tizen 2.4
+    Finished,   ///< The user has lifted a finger or touched an additional point on the screen. @since_tizen 2.4
+    Cancelled,  ///< The gesture has been cancelled. @since_tizen 2.4
+    Possible    ///< A gesture is possible. @since_tizen 2.4
   };
 
   // Data