summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorWoochan Lee <wc0917.lee@samsung.com>2017-01-12 16:36:19 -0800
committerCedric BAIL <cedric@osg.samsung.com>2017-01-12 16:36:23 -0800
commit14a98506d5def91fec032d202019d8e0e305624f (patch)
tree75eef18496b7cf8d63dc75cbb643877871452bdf /src
parent3f6e8871e240d8895850d7bd18db7091a5f4662f (diff)
elm_gesture_layer: update doc.
Summary: Add description about gesture APIs. Some of the developers told me that they really have no idea what is this for when first see the API doc... Reviewers: Hermet, raster, jpeg, cedric Reviewed By: cedric Subscribers: cedric, jpeg Differential Revision: https://phab.enlightenment.org/D4541 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src')
-rw-r--r--src/lib/elementary/elm_gesture_layer.eo18
-rw-r--r--src/lib/elementary/elm_gesture_layer_common.h28
2 files changed, 40 insertions, 6 deletions
diff --git a/src/lib/elementary/elm_gesture_layer.eo b/src/lib/elementary/elm_gesture_layer.eo
index 1a863a5297..147b6682c5 100644
--- a/src/lib/elementary/elm_gesture_layer.eo
+++ b/src/lib/elementary/elm_gesture_layer.eo
@@ -38,9 +38,14 @@ class Elm.Gesture_Layer (Elm.Widget)
38 eo_prefix: elm_obj_gesture_layer; 38 eo_prefix: elm_obj_gesture_layer;
39 methods { 39 methods {
40 @property zoom_step { 40 @property zoom_step {
41 [[Control step value for zoom action.]] 41 [[Control step value for zoom action.]]
42 set {} 42 set {
43 get {} 43 [[When recognizing the zoom gesture, it should be recognized as zooming larger
44 than step.
45 ]]
46 }
47 get {
48 }
44 values { 49 values {
45 step: double; [[The zoom step value.]] 50 step: double; [[The zoom step value.]]
46 } 51 }
@@ -85,14 +90,15 @@ class Elm.Gesture_Layer (Elm.Widget)
85 } 90 }
86 } 91 }
87 @property rotate_step { 92 @property rotate_step {
93 [[This function returns step-value for rotate action.]]
88 set { 94 set {
89 [[This function sets the step value for rotate action. 95 [[Set to 0 to cancel step setting.
90 96
91 Set to 0 to cancel step setting. 97 When recognizing the rotate gesture, the rotated size must be larger
98 than step.
92 ]] 99 ]]
93 } 100 }
94 get { 101 get {
95 [[This function returns step-value for rotate action.]]
96 } 102 }
97 values { 103 values {
98 step: double; [[New rotate step value.]] 104 step: double; [[New rotate step value.]]
diff --git a/src/lib/elementary/elm_gesture_layer_common.h b/src/lib/elementary/elm_gesture_layer_common.h
index 5a45635a40..cf9f23b3a0 100644
--- a/src/lib/elementary/elm_gesture_layer_common.h
+++ b/src/lib/elementary/elm_gesture_layer_common.h
@@ -107,6 +107,8 @@ typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);
107/** 107/**
108 * This function sets the gesture layer line min length of an object 108 * This function sets the gesture layer line min length of an object
109 * 109 *
110 * Sets the minimum line length at which the user's gesture will be recognized as a line.
111 *
110 * @param obj gesture-layer. 112 * @param obj gesture-layer.
111 * @param line_min_length the length. 113 * @param line_min_length the length.
112 * 114 *
@@ -127,6 +129,10 @@ EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
127/** 129/**
128 * This function sets the gesture layer zoom distance tolerance of an object 130 * This function sets the gesture layer zoom distance tolerance of an object
129 * 131 *
132 * If the distance between the two tab events becomes larger or smaller
133 * than @c zoom_distance_tolerance, it is recognized as the start of the
134 * zoom gesture.
135 *
130 * @param obj gesture-layer. 136 * @param obj gesture-layer.
131 * @param zoom_distance_tolerance zoom distance tolerance 137 * @param zoom_distance_tolerance zoom distance tolerance
132 * 138 *
@@ -147,6 +153,8 @@ EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object
147/** 153/**
148 * This function sets the gesture layer line distance tolerance of an object 154 * This function sets the gesture layer line distance tolerance of an object
149 * 155 *
156 * Sets the minimum @c line_distance_tolerance length for the gesture to be recognized as a line.
157 *
150 * @param obj gesture-layer. 158 * @param obj gesture-layer.
151 * @param line_distance_tolerance line distance tolerance 159 * @param line_distance_tolerance line distance tolerance
152 * 160 *
@@ -167,6 +175,8 @@ EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object
167/** 175/**
168 * This function sets the gesture layer line angular tolerance of an object 176 * This function sets the gesture layer line angular tolerance of an object
169 * 177 *
178 * Sets the minimum @c line_angular_tolerance angle for the gesture to be recognized as a line.
179 *
170 * @param obj gesture-layer. 180 * @param obj gesture-layer.
171 * @param line_angular_tolerance line angular tolerance 181 * @param line_angular_tolerance line angular tolerance
172 * 182 *
@@ -187,6 +197,8 @@ EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj)
187/** 197/**
188 * This function sets the gesture layer zoom wheel factor of an object 198 * This function sets the gesture layer zoom wheel factor of an object
189 * 199 *
200 * Sets the zoom size when a mouse wheel event occurs.
201 *
190 * @param obj gesture-layer. 202 * @param obj gesture-layer.
191 * @param zoom_wheel_factor zoom wheel factor 203 * @param zoom_wheel_factor zoom wheel factor
192 * 204 *
@@ -207,6 +219,9 @@ EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
207/** 219/**
208 * This function sets the gesture layer zoom finger factor of an object 220 * This function sets the gesture layer zoom finger factor of an object
209 * 221 *
222 * Sets the zoom size by multiplaying the zoom value by @c zoom_finger_factor
223 * when zooming.
224 *
210 * @param obj gesture-layer. 225 * @param obj gesture-layer.
211 * @param zoom_finger_factor zoom finger factor 226 * @param zoom_finger_factor zoom finger factor
212 * 227 *
@@ -227,6 +242,10 @@ EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
227/** 242/**
228 * This function sets the gesture layer rotate angular tolerance of an object 243 * This function sets the gesture layer rotate angular tolerance of an object
229 * 244 *
245 * Sets the minimum @c rotate_angular_tolerance angle for the gesture to be recognized as a rotate.
246 * Rotate should be rotated beyond the givin @c rotate_angular_tolerance to recognize
247 * the start of the rotate gestrue.
248 *
230 * @param obj gesture-layer. 249 * @param obj gesture-layer.
231 * @param rotate_angular_tolerance rotate angular tolerance 250 * @param rotate_angular_tolerance rotate angular tolerance
232 * 251 *
@@ -247,6 +266,8 @@ EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *ob
247/** 266/**
248 * This function sets the gesture layer flick time limit (in ms) of an object 267 * This function sets the gesture layer flick time limit (in ms) of an object
249 * 268 *
269 * Recognize as a flick when a gesture occurs over @c flick_time_limit_ms.
270 *
250 * @param obj gesture-layer. 271 * @param obj gesture-layer.
251 * @param flick_time_limit_ms flick time limit (in ms) 272 * @param flick_time_limit_ms flick time limit (in ms)
252 * 273 *
@@ -267,6 +288,8 @@ EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *o
267/** 288/**
268 * This function sets the gesture layer long tap start timeout of an object 289 * This function sets the gesture layer long tap start timeout of an object
269 * 290 *
291 * Recognize as a long tap when a tab occurs over @c long_tap_start_timeout.
292 *
270 * @param obj gesture-layer. 293 * @param obj gesture-layer.
271 * @param long_tap_start_timeout long tap start timeout 294 * @param long_tap_start_timeout long tap start timeout
272 * 295 *
@@ -287,6 +310,8 @@ EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj)
287/** 310/**
288 * This function sets the gesture layer continues enable of an object 311 * This function sets the gesture layer continues enable of an object
289 * 312 *
313 * An option that allows user to start a gesture even when user is in touch move state.
314 *
290 * @param obj gesture-layer. 315 * @param obj gesture-layer.
291 * @param continues_enable continues enable 316 * @param continues_enable continues enable
292 * 317 *
@@ -307,6 +332,9 @@ EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
307/** 332/**
308 * This function sets the gesture layer double tap timeout of an object 333 * This function sets the gesture layer double tap timeout of an object
309 * 334 *
335 * When the time diffrence between two tabs is less than the @c double_tap_timeout value,
336 * it is recognized as a double tab.
337 *
310 * @param obj gesture-layer. 338 * @param obj gesture-layer.
311 * @param double_tap_timeout double tap timeout 339 * @param double_tap_timeout double tap timeout
312 * 340 *