summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:44:49 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:44:58 +0100
commit2a1fd61e5667860f860c842dbc375a5e692aaf0e (patch)
tree1afa5a6db9f70d760184aeabac31276cdaf8e6a0
parenta7162e8a873e730d76ac2badd200aea2ffb25db7 (diff)
gesture_layer: convert and fix docs
-rw-r--r--src/lib/elm_gesture_layer.eo183
1 files changed, 63 insertions, 120 deletions
diff --git a/src/lib/elm_gesture_layer.eo b/src/lib/elm_gesture_layer.eo
index c0e265e5b..ef6381a6a 100644
--- a/src/lib/elm_gesture_layer.eo
+++ b/src/lib/elm_gesture_layer.eo
@@ -3,175 +3,118 @@ class Elm.Gesture_Layer (Elm.Widget)
3 eo_prefix: elm_obj_gesture_layer; 3 eo_prefix: elm_obj_gesture_layer;
4 methods { 4 methods {
5 @property zoom_step { 5 @property zoom_step {
6 set { 6 [[Control step value for zoom action.]]
7 /*@ 7 set {}
8 This function sets step-value for zoom action. 8 get {}
9 Set step to any positive value.
10 Cancel step setting by setting to 0
11
12 @see elm_gesture_layer_zoom_step_get()
13 @ingroup Elm_Gesture_Layer
14 */
15 }
16 get {
17 /*@
18 This function returns step-value for zoom action.
19
20 @return zoom step value.
21
22 @see elm_gesture_layer_zoom_step_set()
23 @ingroup Elm_Gesture_Layer
24 */
25 }
26 values { 9 values {
27 step: double; /*@ new zoom step value. */ 10 step: double; [[The zoom step value.]]
28 } 11 }
29 } 12 }
30 @property tap_finger_size { 13 @property tap_finger_size {
31 set { 14 set {
32 /*@ 15 [[This function sets the gesture layer finger-size for taps.
33 This function sets the gesture layer finger-size for taps
34 If not set, this size taken from elm_config.
35 Set to ZERO if you want GLayer to use system finger size value (default)
36 16
37 @since 1.8 17 If not set, it's taken from elm_config.
38 @ingroup Elm_Gesture_Layer 18 Set to 0 if you want GLayer to use the system finger size
39 */ 19 value (default).
20
21 @since 1.8
22 ]]
40 } 23 }
41 get { 24 get {
42 /*@ 25 [[This function returns the gesture layer finger-size for taps
43 This function returns the gesture layer finger-size for taps
44
45 @return Finger size that is currently used by Gesture Layer for taps.
46 26
47 @since 1.8 27 @since 1.8
48 @ingroup Elm_Gesture_Layer 28 ]]
49 */
50 } 29 }
51 values { 30 values {
52 sz: Evas.Coord; /*@ Finger size */ 31 sz: Evas.Coord; [[The finger size.]]
53 } 32 }
54 } 33 }
55 @property hold_events { 34 @property hold_events {
56 set { 35 set {
57 /*@ 36 [[This function makes gesture-layer repeat events.
58 This function is to make gesture-layer repeat events. 37
59 Set this if you like to get the raw events only if gestures were not 38 Set this if you like to get the raw events only if gestures
60 detected. 39 were not detected.
61 Clear this if you like gesture layer to forward events as testing gestures. 40
62 @ingroup Elm_Gesture_Layer 41 Clear this if you like gesture layer to forward events as
63 */ 42 testing gestures.
43 ]]
64 } 44 }
65 get { 45 get {
66 /*@ 46 [[Get the repeat-events setting.]]
67 Call this function to get repeat-events settings.
68
69 @return repeat events settings.
70 @see elm_gesture_layer_hold_events_set()
71 @ingroup Elm_Gesture_Layer
72 */
73 } 47 }
74 values { 48 values {
75 hold_events: bool; /*@ hold events or not. */ 49 hold_events: bool;
76 } 50 }
77 } 51 }
78 @property rotate_step { 52 @property rotate_step {
79 set { 53 set {
80 /*@ 54 [[This function sets the step value for rotate action.
81 This function sets step-value for rotate action. 55
82 Set step to any positive value. 56 Set to 0 to cancel step setting.
83 Cancel step setting by setting to 0 57 ]]
84 @ingroup Elm_Gesture_Layer
85 */
86 } 58 }
87 get { 59 get {
88 /*@ 60 [[This function returns step-value for rotate action.]]
89 This function returns step-value for rotate action.
90
91 @return rotate step value.
92 @ingroup Elm_Gesture_Layer
93 */
94 } 61 }
95 values { 62 values {
96 step: double; /*@ new rotate step value. */ 63 step: double; [[New rotate step value.]]
97 } 64 }
98 } 65 }
99 @property cb { 66 @property cb {
100 set { 67 set {
101 /*@ 68 [[Set the gesture state change callback.
102 Use function to set callbacks to be notified about
103 change of state of gesture.
104 When a user registers a callback with this function
105 this means this gesture has to be tested.
106 69
107 When ALL callbacks for a gesture are set to NULL 70 When all callbacks for the gesture are set to $null,
108 it means user isn't interested in gesture-state 71 it means this gesture is disabled.
109 and it will not be tested. 72 ]]
110 @ingroup Elm_Gesture_Layer
111 */
112 } 73 }
113 values { 74 values {
114 idx: Elm_Gesture_Type; /*@ The gesture you would like to track its state. */ 75 idx: Elm_Gesture_Type; [[The gesture you want to track state of.]]
115 cb_type: Elm_Gesture_State; /*@ what event this callback tracks: START, MOVE, END, ABORT. */ 76 cb_type: Elm_Gesture_State; [[The event the callback tracks (START, MOVE, END, ABORT).]]
116 cb: Elm_Gesture_Event_Cb; /*@ callback function pointer. */ 77 cb: Elm_Gesture_Event_Cb; [[The callback itself.]]
117 data: void * @optional; /*@ user info to be sent to callback (usually, Smart Data) */ 78 data: void * @optional; [[Custom data to be passed.]]
118 } 79 }
119 } 80 }
120 attach { 81 attach {
121 /*@ 82 [[Attach a gesture layer widget to an Evas object (setting the
122 Attach a given gesture layer widget to an Evas object, thus setting 83 widget's target).
123 the widget's @b target.
124 84
125 A gesture layer target may be whichever Evas object one 85 A gesture layer's target may be any Evas object. This object
126 chooses. This will be object @a obj will listen all mouse and key 86 will be used to listen to mouse and key events.
127 events from, to report the gestures made upon it back. 87 ]]
128 88 return: bool; [[$true on success, $false otherwise.]]
129 @return $true, on success, $false otherwise.
130 @ingroup Elm_Gesture_Layer
131 */
132
133 return: bool;
134 params { 89 params {
135 @in target: Evas.Object *; /*@ Object to attach to @a obj (target) */ 90 @in target: Evas.Object *; [[The object to attach.]]
136 } 91 }
137 } 92 }
138 cb_del { 93 cb_del {
139 /*@ 94 [[Remove a gesture callback.]]
140 Use this function to remove a callback that has been added
141 to be notified about change of state of gesture.
142 @ingroup Elm_Gesture_Layer
143 */
144
145 params { 95 params {
146 @in idx: Elm_Gesture_Type; /*@ The gesture you would like to track its state. */ 96 @in idx: Elm_Gesture_Type; [[The gesture you want to track state of.]]
147 @in cb_type: Elm_Gesture_State; /*@ what event this callback tracks: START, MOVE, END, ABORT. */ 97 @in cb_type: Elm_Gesture_State; [[The event the callback tracks (START, MOVE, END, ABORT).]]
148 @in cb: Elm_Gesture_Event_Cb; /*@ callback function pointer. */ 98 @in cb: Elm_Gesture_Event_Cb; [[The callback itself.]]
149 @in data: void * @nullable; /*@ user info for the callback (usually, Smart Data) */ 99 @in data: void * @nullable; [[Custom callback data.]]
150 } 100 }
151 } 101 }
152 cb_add { 102 cb_add {
153 /*@ 103 [[Add a gesture state change callback.
154 Use function to add callbacks to be notified about
155 change of state of gesture.
156 When a user registers a callback with this function
157 this means this gesture has to be tested.
158
159 When ALL callbacks for a gesture are set to NULL
160 it means user isn't interested in gesture-state
161 and it will not be tested.
162 104
163 If a function was already set for this gesture/type/state, it will be 105 When all callbacks for the gesture are set to $null,
164 replaced by the new one. For ABI compat, callbacks added by 106 it means this gesture is disabled.
165 elm_gesture_layer_cb_add will be removed. It is recommended to
166 use only one of these functions for a gesture object.
167 @ingroup Elm_Gesture_Layer
168 */
169 107
108 If a function was already set for this gesture/type/state, it
109 will be replaced by the new one. For ABI compat, callbacks
110 added by @.cb_add will be removed. It is recommended to
111 use only one of these functions for a gesture object.
112 ]]
170 params { 113 params {
171 @in idx: Elm_Gesture_Type; /*@ The gesture you would like to track its state. */ 114 @in idx: Elm_Gesture_Type; [[The gesture you want to track state of.]]
172 @in cb_type: Elm_Gesture_State; /*@ what event this callback tracks: START, MOVE, END, ABORT. */ 115 @in cb_type: Elm_Gesture_State; [[The event the callback tracks (START, MOVE, END, ABORT).]]
173 @in cb: Elm_Gesture_Event_Cb; /*@ callback function pointer. */ 116 @in cb: Elm_Gesture_Event_Cb; [[The callback itself.]]
174 @in data: void * @optional; /*@ user info to be sent to callback (usually, Smart Data) */ 117 @in data: void * @optional; [[Custom data to be passed.]]
175 } 118 }
176 } 119 }
177 } 120 }