X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Ftap-gesture-detector.h;h=d9a3eeca59d9d0592c773024b4c6d08bc34be5ca;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=020558ebd215f7ad0826e6389c5c6570134b5bb6;hpb=abadefab322adc7d09b1a139ff2cc6fe8a271801;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/events/tap-gesture-detector.h b/dali/public-api/events/tap-gesture-detector.h index 020558e..d9a3eec 100644 --- a/dali/public-api/events/tap-gesture-detector.h +++ b/dali/public-api/events/tap-gesture-detector.h @@ -54,7 +54,8 @@ struct TapGesture; * @endcode * * @SINCE_1_0.0 - * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) are supported. + * @note Multi-touch taps (two or more points of contact with the surface) are not currently + * supported. However, multiple taps (double & triple tap etc.) are supported. * * Signals * | %Signal Name | Method | @@ -76,7 +77,7 @@ public: // Typedefs public: // Creation & Destruction /** - * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New(). + * @brief Creates an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New(). * * Calling member functions with an uninitialized TapGestureDetector handle is not allowed. * @SINCE_1_0.0 @@ -84,28 +85,28 @@ public: // Creation & Destruction TapGestureDetector(); /** - * @brief Create an initialized TapGestureDetector. + * @brief Creates an initialized TapGestureDetector. * * By default, this would create a gesture detector which requires one tap with one touch. * @SINCE_1_0.0 - * @return A handle to a newly allocated Dali resource. + * @return A handle to a newly allocated Dali resource */ static TapGestureDetector New(); /** - * @brief Create an initialized TapGestureDetector with the specified parameters. + * @brief Creates an initialized TapGestureDetector with the specified parameters. * * @SINCE_1_0.0 - * @param[in] tapsRequired The minimum & maximum number of taps required. - * @return A handle to a newly allocated Dali resource. + * @param[in] tapsRequired The minimum & maximum number of taps required + * @return A handle to a newly allocated Dali resource */ static TapGestureDetector New( unsigned int tapsRequired ); /** - * @brief Downcast a handle to TapGestureDetector handle. + * @brief Downcasts a handle to TapGestureDetector handle. * - * If handle points to a TapGestureDetector object the - * downcast produces valid handle. If not the returned handle is left uninitialized. + * If handle points to a TapGestureDetector object, the + * downcast produces valid handle. If not, the returned handle is left uninitialized. * @SINCE_1_0.0 * @param[in] handle Handle to an object * @return Handle to a TapGestureDetector object or an uninitialized handle @@ -113,7 +114,7 @@ public: // Creation & Destruction static TapGestureDetector DownCast( BaseHandle handle ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -124,7 +125,7 @@ public: // Creation & Destruction * @brief This copy constructor is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] handle A reference to the copied handle + * @param[in] handle A reference to the copied handle */ TapGestureDetector(const TapGestureDetector& handle); @@ -132,7 +133,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 + * @param[in] rhs A reference to the copied handle * @return A reference to this */ TapGestureDetector& operator=(const TapGestureDetector& rhs); @@ -140,22 +141,22 @@ public: // Creation & Destruction public: // Setters /** - * @brief Set the minimum number of taps required. + * @brief Sets the minimum number of taps required. * * The tap count is the number of times a user should "tap" the screen. * @SINCE_1_0.0 - * @param[in] minimumTaps The minimum taps required. + * @param[in] minimumTaps The minimum taps required * @pre The gesture detector has been initialized. * @note The default is '1'. */ void SetMinimumTapsRequired( unsigned int minimumTaps ); /** - * @brief Set the maximum number of taps required. + * @brief Sets the maximum number of taps required. * * The tap count is the number of times a user should "tap" the screen. * @SINCE_1_0.0 - * @param[in] maximumTaps The maximum taps required. + * @param[in] maximumTaps The maximum taps required * @pre The gesture detector has been initialized. * @note The default is '1'. */ @@ -167,7 +168,7 @@ public: // Getters * @brief Retrieves the minimum number of taps required. * * @SINCE_1_0.0 - * @return The minimum taps required. + * @return The minimum taps required * @pre The gesture detector has been initialized. */ unsigned int GetMinimumTapsRequired() const; @@ -176,7 +177,7 @@ public: // Getters * @brief Retrieves the maximum number of taps required. * * @SINCE_1_0.0 - * @return The maximum taps required. + * @return The maximum taps required * @pre The gesture detector has been initialized. */ unsigned int GetMaximumTapsRequired() const; @@ -191,7 +192,7 @@ public: // Signals * void YourCallbackName( Actor actor, const TapGesture& gesture ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The gesture detector has been initialized. */ DetectedSignalType& DetectedSignal(); @@ -199,10 +200,11 @@ public: // Signals public: // Not intended for Application developers /** + * @internal * @brief This constructor is used by TapGestureDetector::New() methods. * * @SINCE_1_0.0 - * @param [in] internal A pointer to a newly allocated Dali resource. + * @param[in] internal A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal); };