1 #ifndef __DALI_TAP_GESTURE_DETECTOR_H__
2 #define __DALI_TAP_GESTURE_DETECTOR_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/events/gesture-detector.h>
23 #include <dali/public-api/signals/dali-signal.h>
28 * @addtogroup dali_core_events
32 namespace Internal DALI_INTERNAL
34 class TapGestureDetector;
40 * @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the
43 * See @ref TapGestureDetector::SetMinimumTapsRequired
44 * See @ref TapGestureDetector::SetMaximumTapsRequired
46 * A TapGesture is a discrete gesture, which means it does not have any state information attached
47 * to it. Please see TapGesture for more information.
49 * The application programmer can use this gesture detector as follows:
51 * TapGestureDetector detector = TapGestureDetector::New();
52 * detector.Attach(myActor);
53 * detector.DetectedSignal().Connect(this, &MyApplication::OnTap);
57 * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) are supported.
60 * | %Signal Name | Method |
61 * |--------------|-----------------------|
62 * | tapDetected | @ref DetectedSignal() |
66 class DALI_IMPORT_API TapGestureDetector : public GestureDetector
71 * @brief Signal type for detected signal.
74 typedef Signal< void ( Actor, const TapGesture& ) > DetectedSignalType;
76 public: // Creation & Destruction
79 * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
81 * Calling member functions with an uninitialized TapGestureDetector handle is not allowed.
87 * @brief Create an initialized TapGestureDetector.
89 * By default, this would create a gesture detector which requires one tap with one touch.
91 * @return A handle to a newly allocated Dali resource.
93 static TapGestureDetector New();
96 * @brief Create an initialized TapGestureDetector with the specified parameters.
99 * @param[in] tapsRequired The minimum & maximum number of taps required.
100 * @return A handle to a newly allocated Dali resource.
102 static TapGestureDetector New( unsigned int tapsRequired );
105 * @brief Downcast a handle to TapGestureDetector handle.
107 * If handle points to a TapGestureDetector object the
108 * downcast produces valid handle. If not the returned handle is left uninitialized.
110 * @param[in] handle Handle to an object
111 * @return Handle to a TapGestureDetector object or an uninitialized handle
113 static TapGestureDetector DownCast( BaseHandle handle );
118 * This is non-virtual since derived Handle types must not contain data or virtual methods.
121 ~TapGestureDetector();
124 * @brief This copy constructor is required for (smart) pointer semantics.
127 * @param [in] handle A reference to the copied handle
129 TapGestureDetector(const TapGestureDetector& handle);
132 * @brief This assignment operator is required for (smart) pointer semantics.
135 * @param [in] rhs A reference to the copied handle
136 * @return A reference to this
138 TapGestureDetector& operator=(const TapGestureDetector& rhs);
143 * @brief Set the minimum number of taps required.
145 * The tap count is the number of times a user should "tap" the screen.
147 * @param[in] minimumTaps The minimum taps required.
148 * @pre The gesture detector has been initialized.
149 * @note The default is '1'.
151 void SetMinimumTapsRequired( unsigned int minimumTaps );
154 * @brief Set the maximum number of taps required.
156 * The tap count is the number of times a user should "tap" the screen.
158 * @param[in] maximumTaps The maximum taps required.
159 * @pre The gesture detector has been initialized.
160 * @note The default is '1'.
162 void SetMaximumTapsRequired( unsigned int maximumTaps );
167 * @brief Retrieves the minimum number of taps required.
170 * @return The minimum taps required.
171 * @pre The gesture detector has been initialized.
173 unsigned int GetMinimumTapsRequired() const;
176 * @brief Retrieves the maximum number of taps required.
179 * @return The maximum taps required.
180 * @pre The gesture detector has been initialized.
182 unsigned int GetMaximumTapsRequired() const;
187 * @brief This signal is emitted when the specified tap is detected on the attached actor.
189 * A callback of the following type may be connected:
191 * void YourCallbackName( Actor actor, const TapGesture& gesture );
194 * @return The signal to connect to.
195 * @pre The gesture detector has been initialized.
197 DetectedSignalType& DetectedSignal();
199 public: // Not intended for Application developers
203 * @brief This constructor is used by TapGestureDetector::New() methods.
206 * @param [in] internal A pointer to a newly allocated Dali resource.
208 explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
217 #endif // __DALI_TAP_GESTURE_DETECTOR_H__