diff options
author | Adrien Nader <adrien@notk.org> | 2014-10-13 16:07:24 +0200 |
---|---|---|
committer | Cedric BAIL <cedric@osg.samsung.com> | 2014-10-20 18:42:21 +0200 |
commit | 6309e212fb928228483e4d12e3a088af8bc9ffa6 (patch) | |
tree | 1afcbde3e6e2b15ed291f4f858ab8c88c18ba126 /src/lib | |
parent | c8dd871c1d38d6dd196578c0d2560dc09b336cc5 (diff) |
doc: add API docs in elm_interface_scrollable.
This adds
- gravity_set
- gravity_get
- bounce_allow_set
- bounce_allow_get
- movement_block_set
- movement_block_get
- policy_get
- policy_set
- content_region_get
- content_region_set
- page_size_set
- page_size_get
- page_snap_allow_set
- page_snap_allow_get
- single_direction_get
- single_direction_set
- last_page_get
- current_page_get
- content_size_get
- scroll_up_cb
- hbar_drag_cb
- drag_start_cb
- scroll_left_cb
- vbar_press_cb
- hbar_press_cb
- hbar_unpress_cb
- drag_stop_cb
- page_change_cb
- animate_start_cb
- scroll_down_cb
- scroll_cb
- animate_stop_cb
- scroll_right_cb
- edge_left_cb
- vbar_drag_cb
- vbar_unpress_cb
- edge_bottom_cb
- edge_top_cb
- page_show
- region_bring_in
- page_bring_in
- content_region_show
- content_min_limit
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/elm_interface_scrollable.eo | 470 |
1 files changed, 369 insertions, 101 deletions
diff --git a/src/lib/elm_interface_scrollable.eo b/src/lib/elm_interface_scrollable.eo index 16d398146..320651cee 100644 --- a/src/lib/elm_interface_scrollable.eo +++ b/src/lib/elm_interface_scrollable.eo | |||
@@ -2,30 +2,67 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
2 | { | 2 | { |
3 | legacy_prefix: null; | 3 | legacy_prefix: null; |
4 | eo_prefix: elm_interface_scrollable; | 4 | eo_prefix: elm_interface_scrollable; |
5 | data: Elm_Scrollable_Smart_Interface_Data; | 5 | data: Elm_Scrollable_Smart_Interface_Data; |
6 | properties { | 6 | properties { |
7 | gravity { | 7 | gravity { |
8 | set { | 8 | set { |
9 | /*@ No description supplied by the EAPI. */ | 9 | /*@ Set scrolling gravity on the scrollable |
10 | |||
11 | The gravity defines how the scroller will adjust its view | ||
12 | when the size of the scroller contents increases. | ||
13 | |||
14 | The scroller will adjust the view to glue itself as follows. | ||
15 | |||
16 | x=0.0, for staying where it is relative to the left edge of the content | ||
17 | x=1.0, for staying where it is relative to the rigth edge of the content | ||
18 | y=0.0, for staying where it is relative to the top edge of the content | ||
19 | y=1.0, for staying where it is relative to the bottom edge of the content | ||
20 | |||
21 | Default values for x and y are 0.0 | ||
22 | |||
23 | @ingroup Widget | ||
24 | */ | ||
10 | } | 25 | } |
11 | get { | 26 | get { |
12 | /*@ No description supplied by the EAPI. */ | 27 | /*@ Get scrolling gravity on the scrollable |
28 | |||
29 | The gravity defines how the scroller will adjust its view | ||
30 | when the size of the scroller contents increases. | ||
31 | |||
32 | The scroller will adjust the view to glue itself as follows. | ||
33 | |||
34 | x=0.0, for staying where it is relative to the left edge of the content | ||
35 | x=1.0, for staying where it is relative to the rigth edge of the content | ||
36 | y=0.0, for staying where it is relative to the top edge of the content | ||
37 | y=1.0, for staying where it is relative to the bottom edge of the content | ||
38 | |||
39 | Default values for x and y are 0.0 | ||
40 | |||
41 | @ingroup Widget | ||
42 | */ | ||
13 | } | 43 | } |
14 | values { | 44 | values { |
15 | double x; | 45 | double x; /*@ Horizontal scrolling gravity */ |
16 | double y; | 46 | double y; /*@ Vertical scrolling gravity */ |
17 | } | 47 | } |
18 | } | 48 | } |
19 | bounce_allow { | 49 | bounce_allow { |
50 | /* @brief Bouncing behavior | ||
51 | * | ||
52 | * When scrolling, the scroller may "bounce" when reaching an edge of the | ||
53 | * content object. This is a visual way to indicate the end has been reached. | ||
54 | * This is enabled by default for both axis. This API will set if it is enabled | ||
55 | * for the given axis with the boolean parameters for each axis. | ||
56 | * | ||
57 | * @ingroup Widget | ||
58 | */ | ||
20 | set { | 59 | set { |
21 | /*@ No description supplied by the EAPI. */ | ||
22 | } | 60 | } |
23 | get { | 61 | get { |
24 | /*@ No description supplied by the EAPI. */ | ||
25 | } | 62 | } |
26 | values { | 63 | values { |
27 | bool horiz; | 64 | bool horiz; /*@ Horizontal bounce policy. */ |
28 | bool vert; | 65 | bool vert; /*@ Vertical bounce policy. */ |
29 | } | 66 | } |
30 | } | 67 | } |
31 | wheel_disabled { | 68 | wheel_disabled { |
@@ -40,14 +77,30 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
40 | } | 77 | } |
41 | } | 78 | } |
42 | movement_block { | 79 | movement_block { |
80 | /*@ | ||
81 | * @brief Blocking of scrolling (per axis) | ||
82 | * | ||
83 | * This function will block scrolling movement (by input of a user) in | ||
84 | * a given direction. One can disable movements in the X axis, the Y | ||
85 | * axis or both. The default value is #ELM_SCROLLER_MOVEMENT_NO_BLOCK, | ||
86 | * where movements are allowed in both directions. | ||
87 | * | ||
88 | * What makes this function different from | ||
89 | * freeze_push(), hold_push() and lock_x_set() (or lock_y_set()) | ||
90 | * is that it @b doesn't propagate its effects to any parent or child | ||
91 | * widget of @a obj. Only the target scrollable widget will be locked | ||
92 | * with regard to scrolling. | ||
93 | * | ||
94 | * @since 1.8 | ||
95 | * | ||
96 | * @ingroup Widget | ||
97 | */ | ||
43 | set { | 98 | set { |
44 | /*@ No description supplied by the EAPI. */ | ||
45 | } | 99 | } |
46 | get { | 100 | get { |
47 | /*@ No description supplied by the EAPI. */ | ||
48 | } | 101 | } |
49 | values { | 102 | values { |
50 | Elm_Scroller_Movement_Block block; | 103 | Elm_Scroller_Movement_Block block; /*@ Which axis (or axes) to block */ |
51 | } | 104 | } |
52 | } | 105 | } |
53 | momentum_animator_disabled { | 106 | momentum_animator_disabled { |
@@ -62,29 +115,48 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
62 | } | 115 | } |
63 | } | 116 | } |
64 | policy { | 117 | policy { |
118 | /*@ | ||
119 | * @brief Scrollbar visibility policy | ||
120 | * | ||
121 | * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is | ||
122 | * needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns it on all | ||
123 | * the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies | ||
124 | * respectively for the horizontal and vertical scrollbars. | ||
125 | * | ||
126 | * @ingroup Widget | ||
127 | */ | ||
65 | set { | 128 | set { |
66 | /*@ No description supplied by the EAPI. */ | ||
67 | } | 129 | } |
68 | get { | 130 | get { |
69 | /*@ No description supplied by the EAPI. */ | ||
70 | } | 131 | } |
71 | values { | 132 | values { |
72 | Elm_Scroller_Policy hbar; | 133 | Elm_Scroller_Policy hbar; /*@ Horizontal scrollbar policy */ |
73 | Elm_Scroller_Policy vbar; | 134 | Elm_Scroller_Policy vbar; /*@ Vertical scrollbar policy */ |
74 | } | 135 | } |
75 | } | 136 | } |
76 | content_region { | 137 | content_region { |
138 | /*@ | ||
139 | * @brief Currently visible content region | ||
140 | * | ||
141 | * This gets the current region in the content object that is visible through | ||
142 | * the scroller. The region co-ordinates are returned in the @p x, @p y, @p | ||
143 | * w, @p h values pointed to. | ||
144 | * | ||
145 | * @note All coordinates are relative to the content. | ||
146 | * | ||
147 | * @see elm_scroller_region_show() | ||
148 | * | ||
149 | * @ingroup Widget | ||
150 | */ | ||
77 | set { | 151 | set { |
78 | /*@ No description supplied by the EAPI. */ | ||
79 | } | 152 | } |
80 | get { | 153 | get { |
81 | /*@ No description supplied by the EAPI. */ | ||
82 | } | 154 | } |
83 | values { | 155 | values { |
84 | Evas_Coord x; | 156 | Evas_Coord x; /*@ X coordinate of the region */ |
85 | Evas_Coord y; | 157 | Evas_Coord y; /*@ Y coordinate of the region */ |
86 | Evas_Coord w; | 158 | Evas_Coord w; /*@ Width of the region */ |
87 | Evas_Coord h; | 159 | Evas_Coord h; /*@ Height of the region */ |
88 | } | 160 | } |
89 | } | 161 | } |
90 | repeat_events { | 162 | repeat_events { |
@@ -99,15 +171,29 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
99 | } | 171 | } |
100 | } | 172 | } |
101 | page_size { | 173 | page_size { |
174 | /*@ | ||
175 | * @brief Scroll page size relative to viewport size. | ||
176 | * | ||
177 | * The scroller is capable of limiting scrolling by the user to "pages". That | ||
178 | * is to jump by and only show a "whole page" at a time as if the continuous | ||
179 | * area of the scroller content is split into page sized pieces. This sets | ||
180 | * the size of a page relative to the viewport of the scroller. 1.0 is "1 | ||
181 | * viewport" is size (horizontally or vertically). 0.0 turns it off in that | ||
182 | * axis. This is mutually exclusive with page size | ||
183 | * (see elm_scroller_page_size_set() for more information). Likewise 0.5 | ||
184 | * is "half a viewport". Sane usable values are normally between 0.0 and 1.0 | ||
185 | * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for | ||
186 | * the other axis. | ||
187 | * | ||
188 | * @ingroup Widget | ||
189 | */ | ||
102 | set { | 190 | set { |
103 | /*@ No description supplied by the EAPI. */ | ||
104 | } | 191 | } |
105 | get { | 192 | get { |
106 | /*@ No description supplied by the EAPI. */ | ||
107 | } | 193 | } |
108 | values { | 194 | values { |
109 | Evas_Coord x; | 195 | Evas_Coord x; /*@ The horizontal page relative size */ |
110 | Evas_Coord y; | 196 | Evas_Coord y; /*@ The vertical page relative size */ |
111 | } | 197 | } |
112 | } | 198 | } |
113 | bounce_animator_disabled { | 199 | bounce_animator_disabled { |
@@ -134,15 +220,30 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
134 | } | 220 | } |
135 | } | 221 | } |
136 | page_snap_allow { | 222 | page_snap_allow { |
223 | /*@ | ||
224 | * @brief Page snapping behavior | ||
225 | * | ||
226 | * When scrolling, if a scroller is paged (see | ||
227 | * elm_scroller_page_size_set() and elm_scroller_page_relative_set()), | ||
228 | * the scroller may snap to pages when being scrolled, i.e., even if | ||
229 | * it had momentum to scroll further, it will stop at the next page | ||
230 | * boundaries. This is @b disabled, by default, for both axis. This | ||
231 | * function will set if it that is enabled or not, for each axis. | ||
232 | * | ||
233 | * @note If @a obj is not set to have pages, nothing will happen after | ||
234 | * this call. | ||
235 | * | ||
236 | * @since 1.8 | ||
237 | * | ||
238 | * @ingroup Widget | ||
239 | */ | ||
137 | set { | 240 | set { |
138 | /*@ Enable/disable page bouncing, for paged scrollers, on each axis. */ | ||
139 | } | 241 | } |
140 | get { | 242 | get { |
141 | /*@ Get wether page bouncing is enabled, for paged scrollers, on each axis. */ | ||
142 | } | 243 | } |
143 | values { | 244 | values { |
144 | bool horiz; | 245 | bool horiz; /*@ Allow snap horizontally */ |
145 | bool vert; | 246 | bool vert; /*@ Allow snap vertically */ |
146 | } | 247 | } |
147 | } | 248 | } |
148 | paging { | 249 | paging { |
@@ -160,14 +261,28 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
160 | } | 261 | } |
161 | } | 262 | } |
162 | single_direction { | 263 | single_direction { |
264 | /*@ | ||
265 | * @brief Single direction scroll configuration | ||
266 | * | ||
267 | * This makes it possible to restrict scrolling to a single direction, | ||
268 | * with a "soft" or "hard" behavior. | ||
269 | * | ||
270 | * The hard behavior restricts the scrolling to a single direction all | ||
271 | * of the time while the soft one will restrict depending on factors | ||
272 | * such as the movement angle. If the user scrolls roughly in one | ||
273 | * direction only, it will only move according to it while if the move | ||
274 | * was clearly wanted on both axes, it will happen on both of them. | ||
275 | * | ||
276 | * @since 1.8 | ||
277 | * | ||
278 | * @ingroup Widget | ||
279 | */ | ||
163 | set { | 280 | set { |
164 | /*@ No description supplied by the EAPI. */ | ||
165 | } | 281 | } |
166 | get { | 282 | get { |
167 | /*@ No description supplied by the EAPI. */ | ||
168 | } | 283 | } |
169 | values { | 284 | values { |
170 | Elm_Scroller_Single_Direction single_dir; | 285 | Elm_Scroller_Single_Direction single_dir; /*@ The single direction scroll policy */ |
171 | } | 286 | } |
172 | } | 287 | } |
173 | step_size { | 288 | step_size { |
@@ -184,26 +299,38 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
184 | } | 299 | } |
185 | scroll_up_cb { | 300 | scroll_up_cb { |
186 | set { | 301 | set { |
187 | /*@ No description supplied by the EAPI. */ | 302 | /*@ Set the callback to run when the content has been moved up. |
303 | |||
304 | @ingroup Widget | ||
305 | |||
306 | */ | ||
188 | } | 307 | } |
189 | values { | 308 | values { |
190 | Elm_Interface_Scrollable_Cb scroll_up_cb; | 309 | Elm_Interface_Scrollable_Cb scroll_up_cb; /*@ The callback */ |
191 | } | 310 | } |
192 | } | 311 | } |
193 | hbar_drag_cb { | 312 | hbar_drag_cb { |
194 | set { | 313 | set { |
195 | /*@ No description supplied by the EAPI. */ | 314 | /*@ Set the callback to run when the horizontal scrollbar is dragged. |
315 | |||
316 | @ingroup Widget | ||
317 | |||
318 | */ | ||
196 | } | 319 | } |
197 | values { | 320 | values { |
198 | Elm_Interface_Scrollable_Cb hbar_drag_cb; | 321 | Elm_Interface_Scrollable_Cb hbar_drag_cb; /*@ The callback */ |
199 | } | 322 | } |
200 | } | 323 | } |
201 | drag_start_cb { | 324 | drag_start_cb { |
202 | set { | 325 | set { |
203 | /*@ No description supplied by the EAPI. */ | 326 | /*@ Set the callback to run when dragging of the contents has started. |
327 | |||
328 | @ingroup Widget | ||
329 | |||
330 | */ | ||
204 | } | 331 | } |
205 | values { | 332 | values { |
206 | Elm_Interface_Scrollable_Cb drag_start_cb; | 333 | Elm_Interface_Scrollable_Cb drag_start_cb; /*@ The callback */ |
207 | } | 334 | } |
208 | } | 335 | } |
209 | freeze { | 336 | freeze { |
@@ -224,42 +351,63 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
224 | } | 351 | } |
225 | scroll_left_cb { | 352 | scroll_left_cb { |
226 | set { | 353 | set { |
227 | /*@ No description supplied by the EAPI. */ | 354 | /*@ Set the callback to run when the content has been moved to the left |
355 | |||
356 | @ingroup Widget | ||
357 | |||
358 | */ | ||
228 | } | 359 | } |
229 | values { | 360 | values { |
230 | Elm_Interface_Scrollable_Cb scroll_left_cb; | 361 | Elm_Interface_Scrollable_Cb scroll_left_cb; /*@ The callback */ |
231 | } | 362 | } |
232 | } | 363 | } |
233 | vbar_press_cb { | 364 | vbar_press_cb { |
234 | set { | 365 | set { |
235 | /*@ No description supplied by the EAPI. */ | 366 | /*@ Set the callback to run when the vertical scrollbar is pressed. |
367 | |||
368 | @ingroup Widget | ||
369 | |||
370 | */ | ||
236 | } | 371 | } |
237 | values { | 372 | values { |
238 | Elm_Interface_Scrollable_Cb vbar_press_cb; | 373 | Elm_Interface_Scrollable_Cb vbar_press_cb; /*@ The callback */ |
239 | } | 374 | } |
240 | } | 375 | } |
241 | hbar_press_cb { | 376 | hbar_press_cb { |
242 | set { | 377 | set { |
243 | /*@ No description supplied by the EAPI. */ | 378 | /*@ Set the callback to run when the horizontal scrollbar is pressed. |
379 | |||
380 | @ingroup Widget | ||
381 | |||
382 | */ | ||
244 | } | 383 | } |
245 | values { | 384 | values { |
246 | Elm_Interface_Scrollable_Cb hbar_press_cb; | 385 | Elm_Interface_Scrollable_Cb hbar_press_cb; /*@ The callback */ |
247 | } | 386 | } |
248 | } | 387 | } |
249 | hbar_unpress_cb { | 388 | hbar_unpress_cb { |
250 | set { | 389 | set { |
251 | /*@ No description supplied by the EAPI. */ | 390 | /*@ Set the callback to run when the horizontal scrollbar is unpressed. |
391 | |||
392 | @ingroup Widget | ||
393 | |||
394 | */ | ||
252 | } | 395 | } |
253 | values { | 396 | values { |
254 | Elm_Interface_Scrollable_Cb hbar_unpress_cb; | 397 | Elm_Interface_Scrollable_Cb hbar_unpress_cb; /*@ The callback */ |
255 | } | 398 | } |
256 | } | 399 | } |
257 | drag_stop_cb { | 400 | drag_stop_cb { |
258 | set { | 401 | set { |
259 | /*@ No description supplied by the EAPI. */ | 402 | /*@ Set the callback to run when dragging of the contents has stopped. |
403 | * | ||
404 | |||
405 | @ingroup Widget | ||
406 | |||
407 | */ | ||
260 | } | 408 | } |
261 | values { | 409 | values { |
262 | Elm_Interface_Scrollable_Cb drag_stop_cb; | 410 | Elm_Interface_Scrollable_Cb drag_stop_cb; /*@ The callback */ |
263 | } | 411 | } |
264 | } | 412 | } |
265 | extern_pan { | 413 | extern_pan { |
@@ -272,10 +420,14 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
272 | } | 420 | } |
273 | page_change_cb { | 421 | page_change_cb { |
274 | set { | 422 | set { |
275 | /*@ No description supplied by the EAPI. */ | 423 | /*@ Set the callback to run when the visible page changes. |
424 | |||
425 | @ingroup Widget | ||
426 | |||
427 | */ | ||
276 | } | 428 | } |
277 | values { | 429 | values { |
278 | Elm_Interface_Scrollable_Cb page_change_cb; | 430 | Elm_Interface_Scrollable_Cb page_change_cb; /*@ The callback */ |
279 | } | 431 | } |
280 | } | 432 | } |
281 | hold { | 433 | hold { |
@@ -288,18 +440,26 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
288 | } | 440 | } |
289 | animate_start_cb { | 441 | animate_start_cb { |
290 | set { | 442 | set { |
291 | /*@ No description supplied by the EAPI. */ | 443 | /*@ Set the callback to run when the scrolling animation has started. |
444 | |||
445 | @ingroup Widget | ||
446 | |||
447 | */ | ||
292 | } | 448 | } |
293 | values { | 449 | values { |
294 | Elm_Interface_Scrollable_Cb animate_start_cb; | 450 | Elm_Interface_Scrollable_Cb animate_start_cb; /*@ The callback */ |
295 | } | 451 | } |
296 | } | 452 | } |
297 | scroll_down_cb { | 453 | scroll_down_cb { |
298 | set { | 454 | set { |
299 | /*@ No description supplied by the EAPI. */ | 455 | /*@ Set the callback to run when the content has been moved down. |
456 | |||
457 | @ingroup Widget | ||
458 | |||
459 | */ | ||
300 | } | 460 | } |
301 | values { | 461 | values { |
302 | Elm_Interface_Scrollable_Cb scroll_down_cb; | 462 | Elm_Interface_Scrollable_Cb scroll_down_cb; /*@ The callback */ |
303 | } | 463 | } |
304 | } | 464 | } |
305 | page_relative { | 465 | page_relative { |
@@ -313,18 +473,26 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
313 | } | 473 | } |
314 | scroll_cb { | 474 | scroll_cb { |
315 | set { | 475 | set { |
316 | /*@ No description supplied by the EAPI. */ | 476 | /*@ Set the callback to run when the content has been moved. |
477 | |||
478 | @ingroup Widget | ||
479 | |||
480 | */ | ||
317 | } | 481 | } |
318 | values { | 482 | values { |
319 | Elm_Interface_Scrollable_Cb scroll_cb; | 483 | Elm_Interface_Scrollable_Cb scroll_cb; /*@ The callback */ |
320 | } | 484 | } |
321 | } | 485 | } |
322 | animate_stop_cb { | 486 | animate_stop_cb { |
323 | set { | 487 | set { |
324 | /*@ No description supplied by the EAPI. */ | 488 | /*@ Set the callback to run when the scrolling animation has stopped. |
489 | |||
490 | @ingroup Widget | ||
491 | |||
492 | */ | ||
325 | } | 493 | } |
326 | values { | 494 | values { |
327 | Elm_Interface_Scrollable_Cb animate_stop_cb; | 495 | Elm_Interface_Scrollable_Cb animate_stop_cb; /*@ The callback */ |
328 | } | 496 | } |
329 | } | 497 | } |
330 | mirrored { | 498 | mirrored { |
@@ -345,10 +513,14 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
345 | } | 513 | } |
346 | scroll_right_cb { | 514 | scroll_right_cb { |
347 | set { | 515 | set { |
348 | /*@ No description supplied by the EAPI. */ | 516 | /*@ Set the callback to run when the content has been moved to the right. |
517 | |||
518 | @ingroup Widget | ||
519 | |||
520 | */ | ||
349 | } | 521 | } |
350 | values { | 522 | values { |
351 | Elm_Interface_Scrollable_Cb scroll_right_cb; | 523 | Elm_Interface_Scrollable_Cb scroll_right_cb; /*@ The callback */ |
352 | } | 524 | } |
353 | } | 525 | } |
354 | content { | 526 | content { |
@@ -361,50 +533,74 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
361 | } | 533 | } |
362 | edge_left_cb { | 534 | edge_left_cb { |
363 | set { | 535 | set { |
364 | /*@ No description supplied by the EAPI. */ | 536 | /*@ Set the callback to run when the left edge of the content has been reached. |
537 | |||
538 | @ingroup Widget | ||
539 | |||
540 | */ | ||
365 | } | 541 | } |
366 | values { | 542 | values { |
367 | Elm_Interface_Scrollable_Cb edge_left_cb; | 543 | Elm_Interface_Scrollable_Cb edge_left_cb; /*@ The callback */ |
368 | } | 544 | } |
369 | } | 545 | } |
370 | vbar_drag_cb { | 546 | vbar_drag_cb { |
371 | set { | 547 | set { |
372 | /*@ No description supplied by the EAPI. */ | 548 | /*@ Set the callback to run when the horizontal scrollbar is dragged. |
549 | |||
550 | @ingroup Widget | ||
551 | |||
552 | */ | ||
373 | } | 553 | } |
374 | values { | 554 | values { |
375 | Elm_Interface_Scrollable_Cb vbar_drag_cb; | 555 | Elm_Interface_Scrollable_Cb vbar_drag_cb; /*@ The callback */ |
376 | } | 556 | } |
377 | } | 557 | } |
378 | vbar_unpress_cb { | 558 | vbar_unpress_cb { |
379 | set { | 559 | set { |
380 | /*@ No description supplied by the EAPI. */ | 560 | /*@ Set the callback to run when the horizontal scrollbar is unpressed. |
561 | |||
562 | @ingroup Widget | ||
563 | |||
564 | */ | ||
381 | } | 565 | } |
382 | values { | 566 | values { |
383 | Elm_Interface_Scrollable_Cb vbar_unpress_cb; | 567 | Elm_Interface_Scrollable_Cb vbar_unpress_cb; /*@ The callback */ |
384 | } | 568 | } |
385 | } | 569 | } |
386 | edge_bottom_cb { | 570 | edge_bottom_cb { |
387 | set { | 571 | set { |
388 | /*@ No description supplied by the EAPI. */ | 572 | /*@ Set the callback to run when the bottom edge of the content has been reached. |
573 | |||
574 | @ingroup Widget | ||
575 | |||
576 | */ | ||
389 | } | 577 | } |
390 | values { | 578 | values { |
391 | Elm_Interface_Scrollable_Cb edge_bottom_cb; | 579 | Elm_Interface_Scrollable_Cb edge_bottom_cb; /*@ The callback */ |
392 | } | 580 | } |
393 | } | 581 | } |
394 | edge_right_cb { | 582 | edge_right_cb { |
395 | set { | 583 | set { |
396 | /*@ No description supplied by the EAPI. */ | 584 | /*@ Set the callback to run when the right edge of the content has been reached. |
585 | |||
586 | @ingroup Widget | ||
587 | |||
588 | */ | ||
397 | } | 589 | } |
398 | values { | 590 | values { |
399 | Elm_Interface_Scrollable_Cb edge_right_cb; | 591 | Elm_Interface_Scrollable_Cb edge_right_cb; /*@ The callback */ |
400 | } | 592 | } |
401 | } | 593 | } |
402 | edge_top_cb { | 594 | edge_top_cb { |
403 | set { | 595 | set { |
404 | /*@ No description supplied by the EAPI. */ | 596 | /*@ Set the callback to run when the top edge of the content has been reached. |
597 | |||
598 | @ingroup Widget | ||
599 | |||
600 | */ | ||
405 | } | 601 | } |
406 | values { | 602 | values { |
407 | Elm_Interface_Scrollable_Cb edge_top_cb; | 603 | Elm_Interface_Scrollable_Cb edge_top_cb; /*@ The callback */ |
408 | } | 604 | } |
409 | } | 605 | } |
410 | objects { | 606 | objects { |
@@ -418,20 +614,42 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
418 | } | 614 | } |
419 | last_page { | 615 | last_page { |
420 | get { | 616 | get { |
421 | /*@ No description supplied by the EAPI. */ | 617 | /*@ Get scroll last page number. |
618 | |||
619 | The page number starts from 0. 0 is the first page. | ||
620 | This returns the last page number among the pages. | ||
621 | |||
622 | @see elm_scroller_current_page_get() | ||
623 | @see elm_scroller_page_show() | ||
624 | @see elm_scroller_page_bring_in() | ||
625 | |||
626 | @ingroup Widget | ||
627 | */ | ||
422 | } | 628 | } |
423 | values { | 629 | values { |
424 | int pagenumber_h; | 630 | int pagenumber_h; /*@ The horizontal page number */ |
425 | int pagenumber_v; | 631 | int pagenumber_v; /*@ The vertical page number */ |
426 | } | 632 | } |
427 | } | 633 | } |
428 | current_page { | 634 | current_page { |
429 | get { | 635 | get { |
430 | /*@ No description supplied by the EAPI. */ | 636 | /*@ Get scroll current page number. |
637 | |||
638 | The page number starts from 0. 0 is the first page. | ||
639 | Current page means the page which meets the top-left of the viewport. | ||
640 | If there are two or more pages in the viewport, it returns the number of the page | ||
641 | which meets the top-left of the viewport. | ||
642 | |||
643 | @see elm_scroller_last_page_get() | ||
644 | @see elm_scroller_page_show() | ||
645 | @see elm_scroller_page_bring_in() | ||
646 | |||
647 | @ingroup Widget | ||
648 | */ | ||
431 | } | 649 | } |
432 | values { | 650 | values { |
433 | int pagenumber_h; | 651 | int pagenumber_h; /*@ The horizontal page number */ |
434 | int pagenumber_v; | 652 | int pagenumber_v; /*@ The vertical page number */ |
435 | } | 653 | } |
436 | } | 654 | } |
437 | content_viewport_geometry { | 655 | content_viewport_geometry { |
@@ -447,11 +665,17 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
447 | } | 665 | } |
448 | content_size { | 666 | content_size { |
449 | get { | 667 | get { |
450 | /*@ No description supplied by the EAPI. */ | 668 | /*@ Get the size of the content object |
669 | |||
670 | This gets the size of the content object of the scroller. | ||
671 | |||
672 | @ingroup Scroller | ||
673 | */ | ||
451 | } | 674 | } |
452 | values { | 675 | values { |
453 | Evas_Coord w; | 676 | Evas_Coord w; /*@ Width of the content object. */ |
454 | Evas_Coord h; | 677 | Evas_Coord h; /*@ Height of the content object. */ |
678 | |||
455 | } | 679 | } |
456 | } | 680 | } |
457 | } | 681 | } |
@@ -472,42 +696,86 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart) | |||
472 | } | 696 | } |
473 | } | 697 | } |
474 | page_show { | 698 | page_show { |
475 | /*@ No description supplied by the EAPI. */ | 699 | /*@ Show a specific virtual region within the scroller content object by page number. |
700 | |||
701 | 0, 0 of the indicated page is located at the top-left of the viewport. | ||
702 | This will jump to the page directly without animation. | ||
703 | |||
704 | @see elm_scroller_page_bring_in() | ||
705 | |||
706 | @ingroup Widget | ||
707 | */ | ||
476 | params { | 708 | params { |
477 | @in int pagenumber_h; | 709 | @in int pagenumber_h; /*@ The horizontal page number */ |
478 | @in int pagenumber_v; | 710 | @in int pagenumber_v; /*@ The vertical page number */ |
479 | } | 711 | } |
480 | } | 712 | } |
481 | region_bring_in { | 713 | region_bring_in { |
482 | /*@ No description supplied by the EAPI. */ | 714 | /*@ Show a specific virtual region within the scroller content object. |
715 | |||
716 | This will ensure all (or part if it does not fit) of the designated | ||
717 | region in the virtual content object (0, 0 starting at the top-left of the | ||
718 | virtual content object) is shown within the scroller. Unlike | ||
719 | elm_scroller_region_show(), this allows the scroller to "smoothly slide" | ||
720 | to this location (if configuration in general calls for transitions). It | ||
721 | may not jump immediately to the new location and make take a while and | ||
722 | show other content along the way. | ||
723 | |||
724 | @see elm_scroller_region_show() | ||
725 | |||
726 | @ingroup Widget | ||
727 | */ | ||
483 | params { | 728 | params { |
484 | @in Evas_Coord x; | 729 | @in Evas_Coord x; /*@ X coordinate of the region */ |
485 | @in Evas_Coord y; | 730 | @in Evas_Coord y; /*@ Y coordinate of the region */ |
486 | @in Evas_Coord w; | 731 | @in Evas_Coord w; /*@ Width of the region */ |
487 | @in Evas_Coord h; | 732 | @in Evas_Coord h; /*@ Height of the region */ |
488 | } | 733 | } |
489 | } | 734 | } |
490 | page_bring_in { | 735 | page_bring_in { |
491 | /*@ No description supplied by the EAPI. */ | 736 | /*@ Show a specific virtual region within the scroller content object by page number. |
737 | |||
738 | 0, 0 of the indicated page is located at the top-left of the viewport. | ||
739 | This will slide to the page with animation. | ||
740 | |||
741 | @see elm_scroller_page_show() | ||
742 | |||
743 | @ingroup Scroller | ||
744 | */ | ||
492 | params { | 745 | params { |
493 | @in int pagenumber_h; | 746 | @in int pagenumber_h; /*@ The horizontal page number */ |
494 | @in int pagenumber_v; | 747 | @in int pagenumber_v; /*@ The vertical page number */ |
495 | } | 748 | } |
496 | } | 749 | } |
497 | content_region_show { | 750 | content_region_show { |
498 | /*@ No description supplied by the EAPI. */ | 751 | /*@ Show a specific virtual region within the scroller content object |
752 | |||
753 | This will ensure all (or part if it does not fit) of the designated | ||
754 | region in the virtual content object (0, 0 starting at the top-left of the | ||
755 | virtual content object) is shown within the scroller. | ||
756 | |||
757 | @ingroup Widget | ||
758 | */ | ||
499 | params { | 759 | params { |
500 | @in Evas_Coord x; | 760 | @in Evas_Coord x; /*@ X coordinate of the region */ |
501 | @in Evas_Coord y; | 761 | @in Evas_Coord y; /*@ Y coordinate of the region */ |
502 | @in Evas_Coord w; | 762 | @in Evas_Coord w; /*@ Width of the region */ |
503 | @in Evas_Coord h; | 763 | @in Evas_Coord h; /*@ Height of the region */ |
504 | } | 764 | } |
505 | } | 765 | } |
506 | content_min_limit { | 766 | content_min_limit { |
507 | /*@ No description supplied by the EAPI. */ | 767 | /*@ Prevent the scrollable from being smaller than the minimum size of the content. |
768 | |||
769 | By default the scroller will be as small as its design allows, | ||
770 | irrespective of its content. This will make the scroller minimum size the | ||
771 | right size horizontally and/or vertically to perfectly fit its content in | ||
772 | that direction. | ||
773 | |||
774 | @ingroup Widget | ||
775 | */ | ||
508 | params { | 776 | params { |
509 | @in bool w; | 777 | @in bool w; /*@ whether to limit the minimum horizontal size */ |
510 | @in bool h; | 778 | @in bool h; /*@ whether to limit the minimum vertical size */ |
511 | } | 779 | } |
512 | } | 780 | } |
513 | } | 781 | } |