Merge "Add descriptions and example codes" into devel/master
[platform/core/uifw/dali-core.git] / dali / public-api / events / long-press-gesture-detector.h
index 262935a..a0502c5 100644 (file)
@@ -38,7 +38,7 @@ struct LongPressGesture;
 
 /**
  * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
- * @see LongPressGestureDetector::SetTouchesRequired.
+ * @SINCE_1_0.0
  *
  * For any valid long press, two signals will be emitted:
  * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
@@ -62,14 +62,15 @@ class DALI_IMPORT_API LongPressGestureDetector : public GestureDetector
 {
 public: // Typedefs
 
-  typedef Signal< void ( Actor, const LongPressGesture& ) > DetectedSignalType; ///< Gesture detected signal type
+  typedef Signal< void ( Actor, const LongPressGesture& ) > DetectedSignalType; ///< Gesture detected signal type @SINCE_1_0.0
 
 public: // Creation & Destruction
 
   /**
    * @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized LongPressGestureDetector handle is not allowed.
+   * @SINCE_1_0.0
    */
   LongPressGestureDetector();
 
@@ -77,6 +78,7 @@ public: // Creation & Destruction
    * @brief Create an initialized LongPressGestureDetector.
    *
    * By default, this would create a gesture detector that requires only one touch.
+   * @SINCE_1_0.0
    * @return A handle to a newly allocated Dali resource.
    */
   static LongPressGestureDetector New();
@@ -86,6 +88,7 @@ public: // Creation & Destruction
    *
    * A long press gesture will be emitted from this detector if the number of fingers touching the
    * screen is equal to the touches required.
+   * @SINCE_1_0.0
    * @param[in]  touchesRequired  The number of touches required.
    * @return A handle to a newly allocated Dali resource.
    */
@@ -96,6 +99,7 @@ public: // Creation & Destruction
    *
    * A long press gesture will be emitted from this detector if the number of fingers touching the screen
    * falls between the minimum and maximum touches set.
+   * @SINCE_1_0.0
    * @param[in]  minTouches  The minimum number of touches required.
    * @param[in]  maxTouches  The maximum number of touches required.
    * @return A handle to a newly allocated Dali resource.
@@ -103,12 +107,13 @@ public: // Creation & Destruction
   static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
 
   /**
-   * @brief Downcast an Object handle to LongPressGestureDetector handle.
+   * @brief Downcast a handle to LongPressGestureDetector handle.
    *
    * If handle points to a LongPressGestureDetector object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
-   * @param[in] handle to An object
-   * @return handle to a LongPressGestureDetector object or an uninitialized handle
+   * @SINCE_1_0.0
+   * @param[in] handle Handle to an object
+   * @return Handle to a LongPressGestureDetector object or an uninitialized handle
    */
   static LongPressGestureDetector DownCast( BaseHandle handle );
 
@@ -116,12 +121,14 @@ public: // Creation & Destruction
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~LongPressGestureDetector();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
+   * @SINCE_1_0.0
    * @param [in] handle A reference to the copied handle
    */
   LongPressGestureDetector(const LongPressGestureDetector& handle);
@@ -129,6 +136,7 @@ public: // Creation & Destruction
   /**
    * @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
    */
@@ -143,6 +151,7 @@ public: // Setters
    * has on the screen.  This sets the minimum and maximum touches to
    * the input parameter.
    *
+   * @SINCE_1_0.0
    * @param[in]  touches  Touches required.
    * @pre The gesture detector has been initialized.
    * @note The default is '1'.
@@ -155,6 +164,7 @@ public: // Setters
    * The number of touches corresponds to the number of fingers a user
    * has on the screen.
    *
+   * @SINCE_1_0.0
    * @param[in]  minTouches  Minimum Touches required.
    * @param[in]  maxTouches  Maximum Touches required.
    * @pre The gesture detector has been initialized.
@@ -167,6 +177,7 @@ public: // Getters
   /**
    * @brief Retrieves the minimum number of touches required.
    *
+   * @SINCE_1_0.0
    * @return The minimum number of touches required.
    * @pre The gesture detector has been initialized.
    */
@@ -175,6 +186,7 @@ public: // Getters
   /**
    * @brief Retrieves the maximum number of touches required.
    *
+   * @SINCE_1_0.0
    * @return The maximum number of touches required.
    * @pre The gesture detector has been initialized.
    */
@@ -189,19 +201,23 @@ public: // Signals
    * @code
    *   void YourCallbackName( Actor actor, const LongPressGesture& gesture );
    * @endcode
-   * @pre The gesture detector has been initialized.
+   * @SINCE_1_0.0
    * @return The signal to connect to.
+   * @pre The gesture detector has been initialized.
    */
   DetectedSignalType& DetectedSignal();
 
 public: // Not intended for Application developers
 
+  /// @cond internal
   /**
-   * @brief This constructor is used by Dali New() methods.
+   * @brief This constructor is used by LongPressGestureDetector::New() methods.
    *
+   * @SINCE_1_0.0
    * @param [in]  internal  A pointer to a newly allocated Dali resource.
    */
   explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);
+  /// @endcond
 
 };