Tizen Native API  5.0
Public Types | Public Member Functions | Public Attributes | Protected Member Functions
Dali::Gesture Struct Reference
Events

Base structure for different gestures that an application can receive. More...

Inheritance diagram for Dali::Gesture:
Dali::LongPressGesture Dali::PanGesture Dali::PinchGesture Dali::TapGesture

Public Types

enum  Type
 Enumeration for type of gesture. More...
enum  State
 Enumeration for state of the gesture. More...

Public Member Functions

 Gesture (const Gesture &rhs)
 Copy constructor.
Gesture & operator= (const Gesture &rhs)
 Assignment operator.
virtual ~Gesture ()
 Virtual destructor.

Public Attributes

Type type
 The gesture type.
State state
 The gesture state.
uint32_t time
 The time the gesture took place.

Protected Member Functions

 Gesture (Type gestureType, State gestureState)
 This constructor is only used by derived classes.

Detailed Description

Base structure for different gestures that an application can receive.

A gesture is an event that is produced from a combination of several touch events in a particular order or within a certain time frame (e.g pinch).

To receive a particular gesture, the application has to create and connect to the appropriate GestureDetector.

Since:
3.0, DALi version 1.0.0
Note:
An instance of this class cannot be created.
See also:
GestureDetector

Member Enumeration Documentation

enum Dali::Gesture::State

Enumeration for state of the gesture.

Since:
3.0, DALi version 1.0.0
Enumerator:
Clear 

There is no state associated with this gesture.

Since:
3.0, DALi version 1.0.0
Started 

The touched points on the screen have moved enough to be considered a gesture.

Since:
3.0, DALi version 1.0.0
Continuing 

The gesture is continuing.

Since:
3.0, DALi version 1.0.0
Finished 

The user has lifted a finger or touched an additional point on the screen.

Since:
3.0, DALi version 1.0.0
Cancelled 

The gesture has been cancelled.

Since:
3.0, DALi version 1.0.0
Possible 

A gesture is possible.

Since:
3.0, DALi version 1.0.0
enum Dali::Gesture::Type

Enumeration for type of gesture.

Since:
3.0, DALi version 1.0.0
Enumerator:
Pinch 

When two touch points move away or towards each other.

Since:
3.0, DALi version 1.0.0
Pan 

When the user drags their finger(s) in a particular direction.

Since:
3.0, DALi version 1.0.0
Tap 

When the user taps the screen.

Since:
3.0, DALi version 1.0.0
LongPress 

When the user continues to touch the same area on the screen for the device configured time.

Since:
3.0, DALi version 1.0.0

Constructor & Destructor Documentation

Dali::Gesture::Gesture ( const Gesture &  rhs)

Copy constructor.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
virtual Dali::Gesture::~Gesture ( ) [virtual]

Virtual destructor.

Since:
3.0, DALi version 1.0.0
Dali::Gesture::Gesture ( Type  gestureType,
State  gestureState 
) [protected]

This constructor is only used by derived classes.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]gestureTypeThe type of gesture event.
[in]gestureStateThe state of the gesture event.

Member Function Documentation

Gesture& Dali::Gesture::operator= ( const Gesture &  rhs)

Assignment operator.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]rhsA reference to the copied handle
Returns:
A reference to this

Member Data Documentation

State Dali::Gesture::state

The gesture state.

Please see the description in the sub-classes to see the states used by the actual gesture.