summaryrefslogtreecommitdiff
path: root/src/lib/evas/gesture/efl_canvas_gesture.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-19 11:17:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-19 11:17:49 +0200
commitac531f881fe084b4683e96f6de6b8a64a2ca0c9d (patch)
treea5ede7ba1fb840918f4810c78e299ce61ef8846f /src/lib/evas/gesture/efl_canvas_gesture.eo
parent8a66c2eaea1b4001d6ec3bc7967ab0e5753d0a95 (diff)
docs: Update documentation on Gestures
We need to keep in mind that the Manager and the Recognizers are not visible to the user. The user only sees the events and the different Efl.Canvas.Gesture_* payloads.
Diffstat (limited to 'src/lib/evas/gesture/efl_canvas_gesture.eo')
-rw-r--r--src/lib/evas/gesture/efl_canvas_gesture.eo27
1 files changed, 16 insertions, 11 deletions
diff --git a/src/lib/evas/gesture/efl_canvas_gesture.eo b/src/lib/evas/gesture/efl_canvas_gesture.eo
index b76aac0..eaced25 100644
--- a/src/lib/evas/gesture/efl_canvas_gesture.eo
+++ b/src/lib/evas/gesture/efl_canvas_gesture.eo
@@ -1,44 +1,49 @@
1import efl_canvas_gesture_types; 1import efl_canvas_gesture_types;
2parse efl_gesture_events;
2 3
3abstract @beta Efl.Canvas.Gesture extends Efl.Object 4abstract @beta Efl.Canvas.Gesture extends Efl.Object
4{ 5{
5 [[EFL Gesture abstract class 6 [[Base abstract class to support gesture-specific classes.
6 7
7 A gesture class defines a method that specific gesture event and privides information 8 A gesture object holds the current state of that gesture (i.e. whether the gesture has
8 about the gesture's type, state, and associated pointer information. 9 just been started, it is in progress or it has finished) along with any gesture-specific
10 information it needs (like the number of taps so far, to detect triple-taps, for example).
9 11
10 For cetain gesture types, additional methods are defined to provide meaningful gesture 12 Typically this class is not used directly, instead, some sub-class of it (like
11 information to the user.]] 13 @Efl.Canvas.Gesture_Tap or @Efl.Canvas.Gesture_Zoom) is retrieved from gesture events
14 (like @[Efl.Gesture.Events.gesture,tap] or @[Efl.Gesture.Events.gesture,zoom]).
15 ]]
12 c_prefix: efl_gesture; 16 c_prefix: efl_gesture;
13 methods { 17 methods {
14 @property state { 18 @property state {
15 [[This property holds the current state of the gesture.]] 19 [[Current state of the gesture, from initial detection to successful recognition.]]
16 get { 20 get {
17 } 21 }
18 set { 22 set {
19 } 23 }
20 values { 24 values {
21 state: Efl.Canvas.Gesture_State; [[gesture state]] 25 state: Efl.Canvas.Gesture_State; [[State.]]
22 } 26 }
23 } 27 }
24 @property hotspot { 28 @property hotspot {
25 [[This property holds the hotspot of the current gesture.]] 29 [[Hotspot of the gesture currently being analyzed.
30 The exact meaning depends on the gesture type.]]
26 get { 31 get {
27 } 32 }
28 set { 33 set {
29 } 34 }
30 values { 35 values {
31 hotspot: Eina.Position2D;[[hotspot co-ordinate]] 36 hotspot: Eina.Position2D;[[Hotspot coordinates.]]
32 } 37 }
33 } 38 }
34 @property timestamp { 39 @property timestamp {
35 [[This property holds the timestamp of the current gesture.]] 40 [[Moment when the gesture currently being analyzed started.]]
36 get { 41 get {
37 } 42 }
38 set { 43 set {
39 } 44 }
40 values { 45 values {
41 timestamp: uint;[[The timestamp]] 46 timestamp: uint;[[The time-stamp.]]
42 } 47 }
43 } 48 }
44 } 49 }