X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Flong-press-gesture-detector.h;h=3696df037e0dfa0157596b85f14559bc7762a0bb;hb=646f736e77b085c86e982c0d1d4b895c2a431330;hp=4a9c8491d41ee8d4b500123c03b2a846c9c3150c;hpb=0b20f2f643041737052d6bc54de4c5be3a8d4780;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 4a9c849..3696df0 100644 --- a/dali/public-api/events/long-press-gesture-detector.h +++ b/dali/public-api/events/long-press-gesture-detector.h @@ -2,7 +2,7 @@ #define __DALI_LONG_PRESS_GESTURE_DETECTOR_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -18,6 +18,9 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES #include #include @@ -39,7 +42,6 @@ struct LongPressGesture; /** * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application. * @SINCE_1_0.0 - * @see LongPressGestureDetector::SetTouchesRequired. * * 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. @@ -59,7 +61,7 @@ struct LongPressGesture; * |-------------------|-----------------------| * | longPressDetected | @ref DetectedSignal() | */ -class DALI_IMPORT_API LongPressGestureDetector : public GestureDetector +class DALI_CORE_API LongPressGestureDetector : public GestureDetector { public: // Typedefs @@ -68,7 +70,7 @@ public: // Typedefs 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 LongPressGestureDetector handle is not allowed. * @SINCE_1_0.0 @@ -76,42 +78,42 @@ public: // Creation & Destruction LongPressGestureDetector(); /** - * @brief Create an initialized LongPressGestureDetector. + * @brief Creates 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. + * @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. * @SINCE_1_0.0 - * @param[in] touchesRequired The number of touches required. - * @return A handle to a newly allocated Dali resource. + * @param[in] touchesRequired The number of touches required + * @return A handle to a newly allocated Dali resource */ - static LongPressGestureDetector New(unsigned int touchesRequired); + static LongPressGestureDetector New(uint32_t 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. * @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. + * @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); + static LongPressGestureDetector New(uint32_t minTouches, uint32_t maxTouches); /** - * @brief Downcast a 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. + * 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 @@ -119,7 +121,7 @@ public: // Creation & Destruction 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 @@ -130,7 +132,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 */ LongPressGestureDetector(const LongPressGestureDetector& handle); @@ -138,7 +140,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 */ LongPressGestureDetector& operator=(const LongPressGestureDetector& rhs); @@ -146,18 +148,18 @@ 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. * * @SINCE_1_0.0 - * @param[in] touches Touches required. + * @param[in] touches Touches required * @pre The gesture detector has been initialized. * @note The default is '1'. */ - void SetTouchesRequired(unsigned int touches); + void SetTouchesRequired(uint32_t touches); /** * @brief Sets the minimum and maximum touches required. @@ -166,12 +168,12 @@ public: // Setters * has on the screen. * * @SINCE_1_0.0 - * @param[in] minTouches Minimum Touches required. - * @param[in] maxTouches Maximum Touches required. + * @param[in] minTouches Minimum Touches required + * @param[in] maxTouches Maximum Touches required * @pre The gesture detector has been initialized. * @note The default is '1'. */ - void SetTouchesRequired(unsigned int minTouches, unsigned int maxTouches); + void SetTouchesRequired(uint32_t minTouches, uint32_t maxTouches); public: // Getters @@ -179,44 +181,46 @@ public: // Getters * @brief Retrieves the minimum number of touches required. * * @SINCE_1_0.0 - * @return The minimum number of touches required. + * @return The minimum number of touches required * @pre The gesture detector has been initialized. */ - unsigned int GetMinimumTouchesRequired() const; + uint32_t GetMinimumTouchesRequired() const; /** * @brief Retrieves the maximum number of touches required. * * @SINCE_1_0.0 - * @return The maximum number of touches required. + * @return The maximum number of touches required * @pre The gesture detector has been initialized. */ - unsigned int GetMaximumTouchesRequired() const; + uint32_t GetMaximumTouchesRequired() const; 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. + * @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 LongPressGestureDetector::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 LongPressGestureDetector(Internal::LongPressGestureDetector* internal); + /// @endcond };