1 #ifndef __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
2 #define __DALI_LONG_PRESS_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 namespace Internal DALI_INTERNAL
30 class LongPressGestureDetector;
33 struct LongPressGesture;
36 * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
37 * @see LongPressGestureDetector::SetTouchesRequired.
39 * For any valid long press, two signals will be emitted:
40 * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
41 * - Second identifying the ending (state = Finished) i.e. when fingers are released.
43 * The application programmer can use this gesture detector as follows:
45 * LongPressGestureDetector detector = LongPressGestureDetector::New();
46 * detector.Attach(myActor);
47 * detector.DetectedSignal().Connect(this, &MyApplication::OnLongPress);
50 * @see LongPressGesture
53 * | %Signal Name | Method |
54 * |---------------------|-----------------------|
55 * | long-press-detected | @ref DetectedSignal() |
57 class DALI_IMPORT_API LongPressGestureDetector : public GestureDetector
61 typedef Signal< void ( Actor, const LongPressGesture& ) > DetectedSignalType; ///< Gesture detected signal type
63 public: // Creation & Destruction
66 * @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
68 * Calling member functions with an uninitialized Dali::Object is not allowed.
70 LongPressGestureDetector();
73 * @brief Create an initialized LongPressGestureDetector.
75 * By default, this would create a gesture detector that requires only one touch.
76 * @return A handle to a newly allocated Dali resource.
78 static LongPressGestureDetector New();
81 * @brief Create an initialized LongPressGestureDetector with the number of touches required.
83 * A long press gesture will be emitted from this detector if the number of fingers touching the
84 * screen is equal to the touches required.
85 * @param[in] touchesRequired The number of touches required.
86 * @return A handle to a newly allocated Dali resource.
88 static LongPressGestureDetector New(unsigned int touchesRequired);
91 * @brief Create an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
93 * A long press gesture will be emitted from this detector if the number of fingers touching the screen
94 * falls between the minimum and maximum touches set.
95 * @param[in] minTouches The minimum number of touches required.
96 * @param[in] maxTouches The maximum number of touches required.
97 * @return A handle to a newly allocated Dali resource.
99 static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
102 * @brief Downcast an Object handle to LongPressGestureDetector handle.
104 * If handle points to a LongPressGestureDetector object the
105 * downcast produces valid handle. If not the returned handle is left uninitialized.
106 * @param[in] handle to An object
107 * @return handle to a LongPressGestureDetector object or an uninitialized handle
109 static LongPressGestureDetector DownCast( BaseHandle handle );
114 * This is non-virtual since derived Handle types must not contain data or virtual methods.
116 ~LongPressGestureDetector();
119 * @brief This copy constructor is required for (smart) pointer semantics.
121 * @param [in] handle A reference to the copied handle
123 LongPressGestureDetector(const LongPressGestureDetector& handle);
126 * @brief This assignment operator is required for (smart) pointer semantics.
128 * @param [in] rhs A reference to the copied handle
129 * @return A reference to this
131 LongPressGestureDetector& operator=(const LongPressGestureDetector& rhs);
136 * @brief Set the number of touches required.
138 * The number of touches corresponds to the number of fingers a user
139 * has on the screen. This sets the minimum and maximum touches to
140 * the input parameter.
142 * @param[in] touches Touches required.
143 * @pre The gesture detector has been initialized.
144 * @note The default is '1'.
146 void SetTouchesRequired(unsigned int touches);
149 * @brief Sets the minimum and maximum touches required.
151 * The number of touches corresponds to the number of fingers a user
154 * @param[in] minTouches Minimum Touches required.
155 * @param[in] maxTouches Maximum Touches required.
156 * @pre The gesture detector has been initialized.
157 * @note The default is '1'.
159 void SetTouchesRequired(unsigned int minTouches, unsigned int maxTouches);
164 * @brief Retrieves the minimum number of touches required.
166 * @return The minimum number of touches required.
167 * @pre The gesture detector has been initialized.
169 unsigned int GetMinimumTouchesRequired() const;
172 * @brief Retrieves the maximum number of touches required.
174 * @return The maximum number of touches required.
175 * @pre The gesture detector has been initialized.
177 unsigned int GetMaximumTouchesRequired() const;
182 * @brief This signal is emitted when the specified long press is detected on the attached actor.
184 * A callback of the following type may be connected:
186 * void YourCallbackName( Actor actor, const LongPressGesture& gesture );
188 * @pre The gesture detector has been initialized.
189 * @return The signal to connect to.
191 DetectedSignalType& DetectedSignal();
193 public: // Not intended for Application developers
196 * @brief This constructor is used by Dali New() methods.
198 * @param [in] internal A pointer to a newly allocated Dali resource.
200 explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);
206 #endif // __DALI_LONG_PRESS_GESTURE_DETECTOR_H__