summaryrefslogtreecommitdiff
path: root/src/lib/evas/gesture/efl_canvas_gesture_recognizer.eo
blob: e24fc7e9dfa443b090872d57f6cea817e615b236 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import efl_canvas_gesture_types;

abstract @beta Efl.Canvas.Gesture_Recognizer extends Efl.Object
{
   [[Base abstract class for Gesture Recognizers. For internal use only.

     Gesture recognizers listen to events that occur on a target object
     to see if a particular gesture has occurred.

     Recognizer-specific configuration values can be modified through @.config.
     Default configuration values are taken from the system's configuration.
   ]]
   c_prefix: efl_gesture_recognizer;
   methods {
      add @pure_virtual {
         [[This function is called to create a new @Efl.Canvas.Gesture object for the given target.]]
         params {
            @in target: Efl.Object; [[The target canvas object.]]
         }
         return: Efl.Canvas.Gesture; [[Returns the gesture object that will be used to track this gesture.]]
      }
      recognize @pure_virtual {
         [[Analyzes the given $event and the current state of the $gesture object to see if the state
           has to be modified. For example, to signal a complete gesture detection.

           Updates the state of the gesture object as required, and returns a
           suitable result for the current recognition step.
         ]]
         params {
            @in gesture: Efl.Canvas.Gesture; [[The gesture object.]]
            @in watched: Efl.Object; [[The target canvas object.]]
            @in event: Efl.Canvas.Gesture_Touch; [[The pointer event being analyzed.]]
         }
         return: Efl.Canvas.Gesture_Recognizer_Result; [[Returns the result of the analysis.]]
      }
      /* FIXME: This function is not used? */
      reset {
         [[This function is called by the framework to reset a given gesture.]]
         params {
            @in gesture: Efl.Canvas.Gesture; [[The gesture object.]]
         }
      }
      @property config {
         [[This property holds configuration values for the recognizer.]]
         get {
         }
         keys {
            name: string; [[Property name.]]
         }
         values {
            value: any_value_ref; [[Value of the property.]]
         }
      }
   }
   implements {
      Efl.Object.constructor;
   }
}