X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Flong-press-gesture-detector.h;h=23c3d3c71c5674a8ce10eb796b4f9e2fcf847656;hb=refs%2Fchanges%2F57%2F114957%2F2;hp=262935af51b6ed8b07dc6907d3cefb35de64043b;hpb=8b0b50bb14b39e34a119c573cad63fd03c96b09a;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/events/long-press-gesture-detector.h b/dali/public-api/events/long-press-gesture-detector.h index 262935a..23c3d3c 100644 --- a/dali/public-api/events/long-press-gesture-detector.h +++ b/dali/public-api/events/long-press-gesture-detector.h @@ -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,74 +62,82 @@ 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(). + * @brief Creates 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(); /** - * @brief Create an initialized LongPressGestureDetector. + * @brief Creates an initialized LongPressGestureDetector. * * By default, this would create a gesture detector that requires only one touch. - * @return A handle to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @return A handle to a newly allocated Dali resource */ static LongPressGestureDetector New(); /** - * @brief Create an initialized LongPressGestureDetector with the number of touches required. + * @brief Creates an initialized LongPressGestureDetector with the number of touches required. * * A long press gesture will be emitted from this detector if the number of fingers touching the * screen is equal to the touches required. - * @param[in] touchesRequired The number of touches required. - * @return A handle to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @param[in] touchesRequired The number of touches required + * @return A handle to a newly allocated Dali resource */ static LongPressGestureDetector New(unsigned int touchesRequired); /** - * @brief Create an initialized LongPressGestureDetector with the minimum and maximum number of touches required. + * @brief Creates an initialized LongPressGestureDetector with the minimum and maximum number of touches required. * * 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. - * @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. + * @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 */ static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches); /** - * @brief Downcast an Object handle to LongPressGestureDetector handle. + * @brief Downcasts 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 + * If handle points to a LongPressGestureDetector 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 LongPressGestureDetector object or an uninitialized handle */ static LongPressGestureDetector 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 */ ~LongPressGestureDetector(); /** * @brief This copy constructor is required for (smart) pointer semantics. * - * @param [in] handle A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] handle A reference to the copied handle */ LongPressGestureDetector(const LongPressGestureDetector& handle); /** * @brief This assignment operator is required for (smart) pointer semantics. * - * @param [in] rhs A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] rhs A reference to the copied handle * @return A reference to this */ LongPressGestureDetector& operator=(const LongPressGestureDetector& rhs); @@ -137,13 +145,14 @@ public: // Creation & Destruction public: // Setters /** - * @brief Set the number of touches required. + * @brief Sets the number of touches required. * * The number of touches corresponds to the number of fingers a user * has on the screen. This sets the minimum and maximum touches to * the input parameter. * - * @param[in] touches Touches required. + * @SINCE_1_0.0 + * @param[in] touches Touches required * @pre The gesture detector has been initialized. * @note The default is '1'. */ @@ -155,8 +164,9 @@ public: // Setters * The number of touches corresponds to the number of fingers a user * has on the screen. * - * @param[in] minTouches Minimum Touches required. - * @param[in] maxTouches Maximum Touches required. + * @SINCE_1_0.0 + * @param[in] minTouches Minimum Touches required + * @param[in] maxTouches Maximum Touches required * @pre The gesture detector has been initialized. * @note The default is '1'. */ @@ -167,7 +177,8 @@ public: // Getters /** * @brief Retrieves the minimum number of touches required. * - * @return The minimum number of touches required. + * @SINCE_1_0.0 + * @return The minimum number of touches required * @pre The gesture detector has been initialized. */ unsigned int GetMinimumTouchesRequired() const; @@ -175,7 +186,8 @@ public: // Getters /** * @brief Retrieves the maximum number of touches required. * - * @return The maximum number of touches required. + * @SINCE_1_0.0 + * @return The maximum number of touches required * @pre The gesture detector has been initialized. */ unsigned int GetMaximumTouchesRequired() const; @@ -183,23 +195,26 @@ public: // Getters public: // Signals /** - * @brief This signal is emitted when the specified long press is detected on the attached actor. + * @brief This signal is emitted when the specified long press is detected on the attached actor. * * A callback of the following type may be connected: * @code * void YourCallbackName( Actor actor, const LongPressGesture& gesture ); * @endcode + * @SINCE_1_0.0 + * @return The signal to connect to * @pre The gesture detector has been initialized. - * @return The signal to connect to. */ DetectedSignalType& DetectedSignal(); public: // Not intended for Application developers /** - * @brief This constructor is used by Dali New() methods. + * @internal + * @brief This constructor is used by LongPressGestureDetector::New() methods. * - * @param [in] internal A pointer to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @param[in] internal A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);