1 #ifndef __DALI_GESTURE_H__
2 #define __DALI_GESTURE_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_EVENTS_MODULE
26 #include <dali/public-api/common/dali-common.h>
28 namespace Dali DALI_IMPORT_API
32 * @brief Base structure for different gestures that an application can receive.
34 * A gesture is an event that is produced from a combination of
35 * several touch events in a particular order or within a certain time
38 * To receive a particular gesture, the application has to create and connect to the appropriate
41 * @see GestureDetector
43 * @note An instance of this class cannot be created.
48 * @brief Copy constructor.
50 Gesture( const Gesture& rhs );
53 * @brief Assignment operator.
55 Gesture& operator=( const Gesture& rhs );
60 * @brief Virtual destructor.
65 * @brief Type of gesture.
69 Pinch = 1 << 0, ///< When two touch points move away or towards each other.
70 Pan = 1 << 1, ///< When the user drags their finger(s) in a particular direction.
71 Tap = 1 << 2, ///< When the user taps the screen.
72 LongPress = 1 << 3 ///< When the user continues to touch the same area on the screen for the device configured time.
76 * @brief State of the gesture.
80 Clear, ///< There is no state associated with this gesture.
81 Started, ///< The touched points on the screen have moved enough to be considered a gesture.
82 Continuing, ///< The gesture is continuing.
83 Finished, ///< The user has lifted a finger or touched an additional point on the screen.
84 Cancelled, ///< The gesture has been cancelled.
85 Possible ///< A gesture is possible.
91 * @brief The gesture type.
96 * @brief The gesture state.
98 * Please see the description in the sub-classes to see the states
99 * used by the actual gesture.
104 * @brief The time the gesture took place.
108 protected: // Creation
111 * @brief This constructor is only used by derived classes.
113 * @param[in] gestureType The type of gesture event.
114 * @param[in] gestureState The state of the gesture event.
116 Gesture(Type gestureType, State gestureState);
125 #endif // __DALI_GESTURE_H__