X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Ftap-gesture-detector.h;h=778223185512273b6b1bd1462472bd8fc427316d;hb=92b051cadd0db5d9f985aacbbbf832995fb55f53;hp=f51ebb43a918cfda9360bc6efa2ee21100f55d36;hpb=8bccadc96b3773fb10c562a5ccdf1b071b2efe8e;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 f51ebb4..7782231 100644 --- a/dali/public-api/events/tap-gesture-detector.h +++ b/dali/public-api/events/tap-gesture-detector.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TAP_GESTURE_DETECTOR_H__ -#define __DALI_TAP_GESTURE_DETECTOR_H__ +#ifndef DALI_TAP_GESTURE_DETECTOR_H +#define DALI_TAP_GESTURE_DETECTOR_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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 @@ -34,7 +37,7 @@ namespace Internal DALI_INTERNAL class TapGestureDetector; } -struct TapGesture; +class TapGesture; /** * @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the @@ -67,15 +70,13 @@ struct TapGesture; class DALI_CORE_API TapGestureDetector : public GestureDetector { public: // Typedefs - /** * @brief Signal type for detected signal. * @SINCE_1_0.0 */ - typedef Signal< void ( Actor, const TapGesture& ) > DetectedSignalType; + using DetectedSignalType = Signal; public: // Creation & Destruction - /** * @brief Creates an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New(). * @@ -100,7 +101,7 @@ public: // Creation & Destruction * @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 ); + static TapGestureDetector New(uint32_t tapsRequired); /** * @brief Downcasts a handle to TapGestureDetector handle. @@ -111,7 +112,7 @@ public: // Creation & Destruction * @param[in] handle Handle to an object * @return Handle to a TapGestureDetector object or an uninitialized handle */ - static TapGestureDetector DownCast( BaseHandle handle ); + static TapGestureDetector DownCast(BaseHandle handle); /** * @brief Destructor. @@ -139,7 +140,6 @@ public: // Creation & Destruction TapGestureDetector& operator=(const TapGestureDetector& rhs); public: // Setters - /** * @brief Sets the minimum number of taps required. * @@ -147,9 +147,10 @@ public: // Setters * @SINCE_1_0.0 * @param[in] minimumTaps The minimum taps required * @pre The gesture detector has been initialized. - * @note The default is '1'. + * @note The default is '1', the maximum is 2. + * @see ReceiveAllTapEvents */ - void SetMinimumTapsRequired( unsigned int minimumTaps ); + void SetMinimumTapsRequired(uint32_t minimumTaps); /** * @brief Sets the maximum number of taps required. @@ -158,12 +159,21 @@ public: // Setters * @SINCE_1_0.0 * @param[in] maximumTaps The maximum taps required * @pre The gesture detector has been initialized. - * @note The default is '1'. + * @note The default is '1', the maximum is 2. + * @see ReceiveAllTapEvents */ - void SetMaximumTapsRequired( unsigned int maximumTaps ); + void SetMaximumTapsRequired(uint32_t maximumTaps); -public: // Getters + /** + * @brief When set to true, all tap gestures will be received when multiple taps are supported by the gesture detector. + * + * @param[in] receive The receiving all tap events flag + * @pre The gesture detector has been initialized. + * @note The default is false. + */ + void ReceiveAllTapEvents(bool receive); +public: // Getters /** * @brief Retrieves the minimum number of taps required. * @@ -171,7 +181,7 @@ public: // Getters * @return The minimum taps required * @pre The gesture detector has been initialized. */ - unsigned int GetMinimumTapsRequired() const; + uint32_t GetMinimumTapsRequired() const; /** * @brief Retrieves the maximum number of taps required. @@ -180,10 +190,9 @@ public: // Getters * @return The maximum taps required * @pre The gesture detector has been initialized. */ - unsigned int GetMaximumTapsRequired() const; + uint32_t GetMaximumTapsRequired() const; public: // Signals - /** * @brief This signal is emitted when the specified tap is detected on the attached actor. * @@ -198,7 +207,6 @@ public: // Signals DetectedSignalType& DetectedSignal(); public: // Not intended for Application developers - /// @cond internal /** * @brief This constructor is used by TapGestureDetector::New() methods. @@ -216,4 +224,4 @@ public: // Not intended for Application developers } // namespace Dali -#endif // __DALI_TAP_GESTURE_DETECTOR_H__ +#endif // DALI_TAP_GESTURE_DETECTOR_H