X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Flong-press-gesture-detector.h;h=a0502c50ab49f86244badc676a64718dee2c967c;hb=862739881783537447b62d475e12e1da9fd6ce8f;hp=c94de1730425687c6a512673b30520c72ab0d33b;hpb=7d955aff86a5045ee7bd8b7ccb2befe74864599b;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 c94de17..a0502c5 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) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -20,10 +20,14 @@ // INTERNAL INCLUDES #include -#include +#include namespace Dali { +/** + * @addtogroup dali_core_events + * @{ + */ namespace Internal DALI_INTERNAL { @@ -34,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. @@ -48,22 +52,25 @@ struct LongPressGesture; * @endcode * * @see LongPressGesture + * + * Signals + * | %Signal Name | Method | + * |-------------------|-----------------------| + * | longPressDetected | @ref DetectedSignal() | */ class DALI_IMPORT_API LongPressGestureDetector : public GestureDetector { public: // Typedefs - typedef SignalV2< void (Actor, LongPressGesture) > DetectedSignalV2; ///< Gesture detected signal type - - //Signal Names - static const char* const SIGNAL_LONG_PRESS_DETECTED; ///< name "long-press-detected" + 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(); @@ -71,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(); @@ -80,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. */ @@ -90,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. @@ -97,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 ); @@ -110,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); @@ -123,21 +136,12 @@ 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 */ LongPressGestureDetector& operator=(const LongPressGestureDetector& rhs); - /** - * @brief This method is defined to allow assignment of the NULL value, - * and will throw an exception if passed any other value. - * - * Assigning to NULL is an alias for Reset(). - * @param [in] rhs A NULL pointer - * @return A reference to this handle - */ - LongPressGestureDetector& operator=(BaseHandle::NullType* rhs); - public: // Setters /** @@ -147,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'. @@ -159,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. @@ -171,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. */ @@ -179,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. */ @@ -191,24 +199,31 @@ public: // Signals * * A callback of the following type may be connected: * @code - * void YourCallbackName(Actor actor, LongPressGesture gesture); + * 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. */ - DetectedSignalV2& DetectedSignal(); + 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 }; +/** + * @} + */ } // namespace Dali #endif // __DALI_LONG_PRESS_GESTURE_DETECTOR_H__