summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:43:07 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:43:07 +0200
commitb6fbc2b8f7d1147ce77f7f807eaffb1e54ca8fcb (patch)
tree1afcbde3e6e2b15ed291f4f858ab8c88c18ba126
parent49179a03878256b1f09ea0622d404de73d792b1c (diff)
parent6309e212fb928228483e4d12e3a088af8bc9ffa6 (diff)
Merge branch 'devs/captainigloo/doc'
Improve overall documentation of Elementary. Work done on behalf of Samsung by Openwide.
-rw-r--r--src/lib/elc_fileselector_legacy.h2
-rw-r--r--src/lib/elc_naviframe_common.h1
-rw-r--r--src/lib/elm_actionslider.eo2
-rw-r--r--src/lib/elm_app_client.eo4
-rw-r--r--src/lib/elm_button.eo2
-rw-r--r--src/lib/elm_config.h16
-rw-r--r--src/lib/elm_container.eo14
-rw-r--r--src/lib/elm_general.h12
-rw-r--r--src/lib/elm_gesture_layer_common.h2
-rw-r--r--src/lib/elm_image.eo88
-rw-r--r--src/lib/elm_interface_scrollable.eo470
-rw-r--r--src/lib/elm_map_common.h4
-rw-r--r--src/lib/elm_prefs_data.h6
-rw-r--r--src/lib/elm_store.h6
-rw-r--r--src/lib/elm_toolbar_common.h6
-rw-r--r--src/lib/elm_transit.h6
-rw-r--r--src/lib/elm_win.eo2
17 files changed, 494 insertions, 149 deletions
diff --git a/src/lib/elc_fileselector_legacy.h b/src/lib/elc_fileselector_legacy.h
index 2c7fcd6a5..0aa5b7949 100644
--- a/src/lib/elc_fileselector_legacy.h
+++ b/src/lib/elc_fileselector_legacy.h
@@ -408,6 +408,6 @@ EAPI Elm_Fileselector_Sort elm_fileselector_sort_method_get(const Evas_Object *o
408 * @since 1.9 408 * @since 1.9
409 * @ingroup Fileselector 409 * @ingroup Fileselector
410 */ 410 */
411EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort method); 411EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort sort);
412 412
413#include "elm_fileselector.eo.legacy.h" 413#include "elm_fileselector.eo.legacy.h"
diff --git a/src/lib/elc_naviframe_common.h b/src/lib/elc_naviframe_common.h
index 757bdb551..39d3a79e2 100644
--- a/src/lib/elc_naviframe_common.h
+++ b/src/lib/elc_naviframe_common.h
@@ -109,6 +109,7 @@ EAPI Eina_Bool elm_naviframe_item_title_enabled_get(const Elm_Object_Item
109 * 109 *
110 * @param it The item to set the callback on 110 * @param it The item to set the callback on
111 * @param func the callback function. 111 * @param func the callback function.
112 * @param data The data to be passed to this @p func call.
112 * 113 *
113 * @warning Don't set "clicked" callback to the prev button additionally if the 114 * @warning Don't set "clicked" callback to the prev button additionally if the
114 * function does an exact same logic with this @c func. When hardware back key 115 * function does an exact same logic with this @c func. When hardware back key
diff --git a/src/lib/elm_actionslider.eo b/src/lib/elm_actionslider.eo
index 27d74ea2e..84f42d76e 100644
--- a/src/lib/elm_actionslider.eo
+++ b/src/lib/elm_actionslider.eo
@@ -25,7 +25,7 @@ class Elm_Actionslider (Elm_Layout)
25 set { 25 set {
26 /*@ 26 /*@
27 Set actionslider magnet position. To make multiple positions magnets @c or 27 Set actionslider magnet position. To make multiple positions magnets @c or
28 them together(e.g.: #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT) 28 them together (e.g. #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
29 29
30 @ingroup Actionslider */ 30 @ingroup Actionslider */
31 } 31 }
diff --git a/src/lib/elm_app_client.eo b/src/lib/elm_app_client.eo
index c2b4bdd1e..65661581e 100644
--- a/src/lib/elm_app_client.eo
+++ b/src/lib/elm_app_client.eo
@@ -8,7 +8,7 @@ class Elm_App_Client (Eo.Base)
8 /*@ Return a iterator with all views of application. */ 8 /*@ Return a iterator with all views of application. */
9 } 9 }
10 values { 10 values {
11 iterator *ret; /*@ the iterator with all views, must be freed after use */ 11 iterator *ret; /*@ The iterator with all views, must be freed after use */
12 } 12 }
13 } 13 }
14 package { 14 package {
@@ -35,7 +35,7 @@ class Elm_App_Client (Eo.Base)
35 /*@ Terminate application. */ 35 /*@ Terminate application. */
36 } 36 }
37 view_open { 37 view_open {
38 /*@ Open a application view. */ 38 /*@ Open an application view. */
39 params { 39 params {
40 @in Eina_Value *args; /*@ an array of */ 40 @in Eina_Value *args; /*@ an array of */
41 @in Elm_App_Client_Open_View_Cb view_open_cb; /*@ callback to be called when view open */ 41 @in Elm_App_Client_Open_View_Cb view_open_cb; /*@ callback to be called when view open */
diff --git a/src/lib/elm_button.eo b/src/lib/elm_button.eo
index d0651f405..5d3027f8e 100644
--- a/src/lib/elm_button.eo
+++ b/src/lib/elm_button.eo
@@ -88,7 +88,7 @@ class Elm_Button (Elm_Layout, Evas.Clickable_Interface,
88 } 88 }
89 admits_autorepeat { 89 admits_autorepeat {
90 get { 90 get {
91 /*@ No description supplied by the EAPI. */ 91 /*@ Get whether the button supports autorepeat. */
92 legacy: null; 92 legacy: null;
93 } 93 }
94 values { 94 values {
diff --git a/src/lib/elm_config.h b/src/lib/elm_config.h
index aa8a7cb4b..58d23df56 100644
--- a/src/lib/elm_config.h
+++ b/src/lib/elm_config.h
@@ -430,7 +430,7 @@ EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
430 * same with thumbscroll friction, if the velocity is same with standard 430 * same with thumbscroll friction, if the velocity is same with standard
431 * velocity. 431 * velocity.
432 * 432 *
433 * @param friction the thumb scroll friction standard 433 * @param standard the thumb scroll friction standard
434 * 434 *
435 * @see elm_config_thumbscroll_friction_standard_get() 435 * @see elm_config_thumbscroll_friction_standard_get()
436 * @ingroup Scrolling 436 * @ingroup Scrolling
@@ -524,7 +524,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void
524/** 524/**
525 * Set the time limit for accelerating velocity. 525 * Set the time limit for accelerating velocity.
526 * 526 *
527 * @param threshold the thumb scroll acceleration time limit 527 * @param time_limit the thumb scroll acceleration time limit
528 * 528 *
529 * @see elm_config_thumbscroll_acceleration_time_limit_get() 529 * @see elm_config_thumbscroll_acceleration_time_limit_get()
530 * @ingroup Scrolling 530 * @ingroup Scrolling
@@ -543,7 +543,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
543/** 543/**
544 * Set the weight for the acceleration. 544 * Set the weight for the acceleration.
545 * 545 *
546 * @param threshold the thumb scroll acceleration weight 546 * @param weight the thumb scroll acceleration weight
547 * 547 *
548 * @see elm_config_thumbscroll_acceleration_weight_get() 548 * @see elm_config_thumbscroll_acceleration_weight_get()
549 * @ingroup Scrolling 549 * @ingroup Scrolling
@@ -960,7 +960,7 @@ EAPI Eina_Bool elm_config_access_get(void);
960/** 960/**
961 * Set access mode 961 * Set access mode
962 * 962 *
963 * @param is_accesss If @c EINA_TRUE, enables access mode 963 * @param is_access If @c EINA_TRUE, enables access mode
964 * 964 *
965 * @note Elementary objects may have information (e.g. label on the elm_button) 965 * @note Elementary objects may have information (e.g. label on the elm_button)
966 * to be read. This information is read by access module when an object 966 * to be read. This information is read by access module when an object
@@ -1377,13 +1377,13 @@ EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void);
1377/** 1377/**
1378 * Set the disable status of the item select on focus feature. 1378 * Set the disable status of the item select on focus feature.
1379 * 1379 *
1380 * @param disable Disable item select on focus if @c EINA_TRUE, enable otherwise 1380 * @param disabled Disable item select on focus if @c EINA_TRUE, enable otherwise
1381 * 1381 *
1382 * @see elm_config_item_select_on_focus_disabled_get 1382 * @see elm_config_item_select_on_focus_disabled_get
1383 * @since 1.10 1383 * @since 1.10
1384 * @ingroup Focus 1384 * @ingroup Focus
1385 */ 1385 */
1386EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool enabled); 1386EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
1387 1387
1388/** 1388/**
1389 * Get status of first item focus on first focusin feature. 1389 * Get status of first item focus on first focusin feature.
@@ -1399,7 +1399,7 @@ EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void);
1399/** 1399/**
1400 * Set the first item focus on first focusin feature. 1400 * Set the first item focus on first focusin feature.
1401 * 1401 *
1402 * @param enable first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise 1402 * @param enabled first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise
1403 * 1403 *
1404 * @see elm_config_first_item_focus_on_first_focusin_get 1404 * @see elm_config_first_item_focus_on_first_focusin_get
1405 * @since 1.11 1405 * @since 1.11
@@ -1483,7 +1483,7 @@ EAPI double elm_config_glayer_double_tap_timeout_get(void);
1483/** 1483/**
1484 * Set the duration for occurring double tap event of gesture layer. 1484 * Set the duration for occurring double tap event of gesture layer.
1485 * 1485 *
1486 * @param long_tap_timeout Timeout for double tap event of gesture layer. 1486 * @param double_tap_timeout Timeout for double tap event of gesture layer.
1487 * @ingroup Elm_Gesture_Layer 1487 * @ingroup Elm_Gesture_Layer
1488 * @since 1.8 1488 * @since 1.8
1489 */ 1489 */
diff --git a/src/lib/elm_container.eo b/src/lib/elm_container.eo
index b306f7ed2..899068c59 100644
--- a/src/lib/elm_container.eo
+++ b/src/lib/elm_container.eo
@@ -6,7 +6,7 @@ class Elm_Container (Elm_Widget)
6 properties { 6 properties {
7 content_swallow_list { 7 content_swallow_list {
8 get { 8 get {
9 /*@ No description supplied by the EAPI. */ 9 /*@ Get the list of swallow parts in the object. */
10 } 10 }
11 values { 11 values {
12 list *ret; /*@ list */ 12 list *ret; /*@ list */
@@ -15,22 +15,22 @@ class Elm_Container (Elm_Widget)
15 } 15 }
16 methods { 16 methods {
17 content_set { 17 content_set {
18 /*@ No description supplied by the EAPI. */ 18 /*@ Swallow the given object into the given part of the container. */
19 params { 19 params {
20 @in const(char)* name; 20 @in const(char)* name; /*@ the part in which to swallow the object */
21 @in Evas_Object *content; 21 @in Evas_Object *content; /*@ the object to swallow */
22 } 22 }
23 return: bool; 23 return: bool;
24 } 24 }
25 content_get { 25 content_get {
26 /*@ No description supplied by the EAPI. */ 26 /*@ Get the object swallowed in the given part of the container. */
27 params { 27 params {
28 @in const(char)* name; 28 @in const(char)* name; /*@ the part in which the object is swallowed */
29 } 29 }
30 return: Evas_Object *; 30 return: Evas_Object *;
31 } 31 }
32 content_unset { 32 content_unset {
33 /*@ No description supplied by the EAPI. */ 33 /*@ Unswallow the object in the given part of the container and return it. */
34 params { 34 params {
35 @in const(char)* name; 35 @in const(char)* name;
36 } 36 }
diff --git a/src/lib/elm_general.h b/src/lib/elm_general.h
index 88d9ff16f..a800f242a 100644
--- a/src/lib/elm_general.h
+++ b/src/lib/elm_general.h
@@ -134,20 +134,28 @@ typedef enum
134 ELM_POLICY_THROTTLE_NEVER /**< never throttle when windows are all hidden, regardless of config settings */ 134 ELM_POLICY_THROTTLE_NEVER /**< never throttle when windows are all hidden, regardless of config settings */
135} Elm_Policy_Throttle; 135} Elm_Policy_Throttle;
136 136
137/**
138 * Possible values for the #ELM_OBJECT_SELECT_MODE policy.
139 * @since 1.7
140 */
137typedef enum 141typedef enum
138{ 142{
139 ELM_OBJECT_SELECT_MODE_DEFAULT = 0, /**< default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus. */ 143 ELM_OBJECT_SELECT_MODE_DEFAULT = 0, /**< default select mode. Once an item is selected, it would stay highlighted and not going to call selected callback again even it was clicked. Items can get focus. */
140 ELM_OBJECT_SELECT_MODE_ALWAYS, /**< always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus. */ 144 ELM_OBJECT_SELECT_MODE_ALWAYS, /**< always select mode. Item selected callbacks will be called every time for click events, even after the item was already selected. Items can get focus. */
141 ELM_OBJECT_SELECT_MODE_NONE, /**< no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus. */ 145 ELM_OBJECT_SELECT_MODE_NONE, /**< no select mode. Items will never be highlighted and selected but the size will be adjusted by the finger size configuration. Items can't get focus. */
142 ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY, /**< no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus. */ 146 ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY, /**< no select mode with no finger size rule. Items will never be highlighted and selected and ignore the finger size. So the item size can be reduced below than the finger size configuration. Items can't get focus. */
143 ELM_OBJECT_SELECT_MODE_MAX 147 ELM_OBJECT_SELECT_MODE_MAX /**< canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX is forbidden. */
144} Elm_Object_Select_Mode; 148} Elm_Object_Select_Mode;
145 149
150/**
151 * Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy.
152 * @since 1.8
153 */
146typedef enum 154typedef enum
147{ 155{
148 ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT = 0, /**< default multiple select mode */ 156 ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT = 0, /**< default multiple select mode */
149 ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL, /**< disallow mutiple selection when clicked without control key pressed */ 157 ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL, /**< disallow mutiple selection when clicked without control key pressed */
150 ELM_OBJECT_MULTI_SELECT_MODE_MAX 158 ELM_OBJECT_MULTI_SELECT_MODE_MAX /**< canary value: any value greater or equal to ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden. */
151} Elm_Object_Multi_Select_Mode; 159} Elm_Object_Multi_Select_Mode;
152 160
153typedef Eina_Bool (*Elm_Event_Cb)(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */ 161typedef Eina_Bool (*Elm_Event_Cb)(void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
diff --git a/src/lib/elm_gesture_layer_common.h b/src/lib/elm_gesture_layer_common.h
index 398ce1862..60f52605c 100644
--- a/src/lib/elm_gesture_layer_common.h
+++ b/src/lib/elm_gesture_layer_common.h
@@ -434,7 +434,7 @@ EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
434 * Set to ZERO if you want GLayer to use system finger size value (default) 434 * Set to ZERO if you want GLayer to use system finger size value (default)
435 * 435 *
436 * @param obj gesture-layer. 436 * @param obj gesture-layer.
437 * @param fsize Finger size 437 * @param sz Finger size
438 * 438 *
439 * @since 1.8 439 * @since 1.8
440 * @ingroup Elm_Gesture_Layer 440 * @ingroup Elm_Gesture_Layer
diff --git a/src/lib/elm_image.eo b/src/lib/elm_image.eo
index 0f14c1940..dc77b55af 100644
--- a/src/lib/elm_image.eo
+++ b/src/lib/elm_image.eo
@@ -30,15 +30,25 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
30 } 30 }
31 resize_down { 31 resize_down {
32 set { 32 set {
33 /*@ No description supplied by the EAPI. */ 33 /*@
34 Set whether the object's image can be resized to a size smaller than the original one.
35
36 @ingroup Image
37 @since 1.7
38 */
34 legacy: null; 39 legacy: null;
35 } 40 }
36 get { 41 get {
37 /*@ No description supplied by the EAPI. */ 42 /*@
43 Get whether the object's image can be resized to a size smaller than the original one.
44
45 @ingroup Image
46 @since 1.7
47 */
38 legacy: null; 48 legacy: null;
39 } 49 }
40 values { 50 values {
41 bool resize_down; 51 bool resize_down; /*@ whether resizing down is allowed */
42 } 52 }
43 } 53 }
44 animated_play { 54 animated_play {
@@ -87,15 +97,25 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
87 } 97 }
88 resize_up { 98 resize_up {
89 set { 99 set {
90 /*@ No description supplied by the EAPI. */ 100 /*@
101 Set whether the object's image can be resized to a size larget than the original one.
102
103 @ingroup Image
104 @since 1.7
105 */
91 legacy: null; 106 legacy: null;
92 } 107 }
93 get { 108 get {
94 /*@ No description supplied by the EAPI. */ 109 /*@
110 Get whether the object's image can be resized to a size larget than the original one.
111
112 @ingroup Image
113 @since 1.7
114 */
95 legacy: null; 115 legacy: null;
96 } 116 }
97 values { 117 values {
98 bool resize_up; 118 bool resize_up; /*@ whether resizing up is allowed */
99 } 119 }
100 } 120 }
101 smooth { 121 smooth {
@@ -198,28 +218,62 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
198 } 218 }
199 scale { 219 scale {
200 set { 220 set {
201 /*@ No description supplied by the EAPI. */ 221 /*@
222 Set the scale of the object's image.
223
224 @ingroup Image
225 @since 1.7
226 */
202 legacy: null; 227 legacy: null;
203 } 228 }
204 get { 229 get {
205 /*@ No description supplied by the EAPI. */ 230 /*@
231 Get the scale of the object's image.
232
233 @ingroup Image
234 @since 1.7
235 */
206 legacy: null; 236 legacy: null;
207 } 237 }
208 values { 238 values {
209 double scale; 239 double scale; /*@ Object's image scale. */
210 } 240 }
211 } 241 }
212 fill_inside { 242 fill_inside {
213 set { 243 set {
214 /*@ No description supplied by the EAPI. */ 244 /*@
245 Set the resize method for the object's internal image when maintaining a given aspect ratio.
246
247 If @p fill_inside is true, image does not overflow the widget and
248 blank spaces are added to fill the space that is still free. If it
249 is false, the image overflows the image will fill all space and
250 overflow in its larger dimension.
251
252 You can think of it as "fill: inside" or "fill: outside" and not as
253 "fill the inside".
254
255 @see elm_image_fill_inside_get()
256 @see elm_image_fill_outside_get()
257 @see elm_image_fill_outside_set()
258 @ingroup Image
259 @since 1.7
260 */
215 legacy: null; 261 legacy: null;
216 } 262 }
217 get { 263 get {
218 /*@ No description supplied by the EAPI. */ 264 /*@
265 Set the resize method for the object's internal image when maintaining a given aspect ratio.
266
267 @see elm_image_fill_inside_set()
268 @see elm_image_fill_outside_get()
269 @see elm_image_fill_outside_set()
270 @ingroup Image
271 @since 1.7
272 */
219 legacy: null; 273 legacy: null;
220 } 274 }
221 values { 275 values {
222 bool fill_inside; 276 bool fill_inside; /*@ Resize method for the object's internal image. */
223 } 277 }
224 } 278 }
225 aspect_fixed { 279 aspect_fixed {
@@ -293,6 +347,8 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
293 @note This option will have no effect if 347 @note This option will have no effect if
294 elm_image_aspect_fixed_set() is set to @c EINA_FALSE. 348 elm_image_aspect_fixed_set() is set to @c EINA_FALSE.
295 349
350 @see elm_image_fill_inside_get()
351 @see elm_image_fill_inside_set()
296 @see elm_image_fill_outside_get() 352 @see elm_image_fill_outside_get()
297 @see elm_image_aspect_fixed_set() 353 @see elm_image_aspect_fixed_set()
298 354
@@ -304,6 +360,8 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
304 360
305 @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise. 361 @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
306 362
363 @see elm_image_fill_inside_get()
364 @see elm_image_fill_inside_set()
307 @see elm_image_fill_outside_set() 365 @see elm_image_fill_outside_set()
308 366
309 @ingroup Image */ 367 @ingroup Image */
@@ -466,7 +524,11 @@ class Elm_Image (Elm_Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
466 } 524 }
467 methods { 525 methods {
468 sizing_eval { 526 sizing_eval {
469 /*@ No description supplied by the EAPI. */ 527 /*@
528 Re-evaluate the object's final geometry.
529
530 @ingroup Image
531 @since 1.7 */
470 legacy: null; 532 legacy: null;
471 } 533 }
472 } 534 }
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 }
diff --git a/src/lib/elm_map_common.h b/src/lib/elm_map_common.h
index 74cec96da..9d30a7155 100644
--- a/src/lib/elm_map_common.h
+++ b/src/lib/elm_map_common.h
@@ -509,10 +509,10 @@ EAPI void elm_map_overlays_show(Eina_List *overlays);
509EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data); 509EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data);
510 510
511/** 511/**
512 * Set the get callback function to call when the overlay is deleted. 512 * Set the del callback function to call when the overlay is deleted.
513 * 513 *
514 * @param overlay The overlay to own the del callback function. 514 * @param overlay The overlay to own the del callback function.
515 * @param get_cb The callback function. 515 * @param del_cb The callback function.
516 * @param data The user callback data. 516 * @param data The user callback data.
517 * 517 *
518 * If the overlay is deleted, the callback wll be called. 518 * If the overlay is deleted, the callback wll be called.
diff --git a/src/lib/elm_prefs_data.h b/src/lib/elm_prefs_data.h
index 603cbcb00..e2890c6f7 100644
--- a/src/lib/elm_prefs_data.h
+++ b/src/lib/elm_prefs_data.h
@@ -181,7 +181,7 @@ EAPI void elm_prefs_data_unref(Elm_Prefs_Data *prefs_data);
181 * Set (or delete) one value of a given prefs data handle. 181 * Set (or delete) one value of a given prefs data handle.
182 * 182 *
183 * @param prefs_data A valid prefs data handle 183 * @param prefs_data A valid prefs data handle
184 * @param name The (unique) name (key) of the given value 184 * @param path The (unique) name (key) of the given value
185 * @param type The item type to which the value is to be associated 185 * @param type The item type to which the value is to be associated
186 * @param value The value, itself. It must be a valid @c Eina_Value 186 * @param value The value, itself. It must be a valid @c Eina_Value
187 * handle, bound to a given type and value or @c NULL. On 187 * handle, bound to a given type and value or @c NULL. On
@@ -204,7 +204,7 @@ EAPI Eina_Bool elm_prefs_data_value_set(Elm_Prefs_Data *prefs_data,
204 * Retrieve one value of a given prefs data handle (by key). 204 * Retrieve one value of a given prefs data handle (by key).
205 * 205 *
206 * @param prefs_data A valid prefs data handle 206 * @param prefs_data A valid prefs data handle
207 * @param name The (unique) name (key) of the given value 207 * @param path The (unique) name (key) of the given value
208 * @param type The item type associated with the value 208 * @param type The item type associated with the value
209 * @param value A valid @c Eina_Value handle, where to store the 209 * @param value A valid @c Eina_Value handle, where to store the
210 * value, itself. 210 * value, itself.
@@ -258,7 +258,7 @@ EAPI Eina_Bool elm_prefs_data_event_callback_add(Elm_Prefs_Data *prefs_dat
258 * @since 1.8 258 * @since 1.8
259 */ 259 */
260EAPI Eina_Bool elm_prefs_data_event_callback_del(Elm_Prefs_Data *prefs_data, 260EAPI Eina_Bool elm_prefs_data_event_callback_del(Elm_Prefs_Data *prefs_data,
261 Elm_Prefs_Data_Event_Type t, 261 Elm_Prefs_Data_Event_Type type,
262 Elm_Prefs_Data_Event_Cb cb, 262 Elm_Prefs_Data_Event_Cb cb,
263 const void *cb_data); 263 const void *cb_data);
264 264
diff --git a/src/lib/elm_store.h b/src/lib/elm_store.h
index 3db9ece2f..27053287a 100644
--- a/src/lib/elm_store.h
+++ b/src/lib/elm_store.h
@@ -70,6 +70,10 @@ typedef void (*Elm_Store_Item_Fetch_Cb)(void *da
70typedef void (*Elm_Store_Item_Unfetch_Cb)(void *data, Elm_Store_Item *sti); /**< Function to cal lto un-fetch (free) an item */ 70typedef void (*Elm_Store_Item_Unfetch_Cb)(void *data, Elm_Store_Item *sti); /**< Function to cal lto un-fetch (free) an item */
71typedef void *(*Elm_Store_Item_Mapping_Cb)(void *data, Elm_Store_Item *sti, const char *part); /**< Custom mapping function to call */ 71typedef void *(*Elm_Store_Item_Mapping_Cb)(void *data, Elm_Store_Item *sti, const char *part); /**< Custom mapping function to call */
72 72
73/**
74 * Possible mappings types.
75 * @since 1.7
76 */
73typedef enum 77typedef enum
74{ 78{
75 ELM_STORE_ITEM_MAPPING_NONE = 0, 79 ELM_STORE_ITEM_MAPPING_NONE = 0,
@@ -78,7 +82,7 @@ typedef enum
78 ELM_STORE_ITEM_MAPPING_ICON, /**< char * -> icon path */ 82 ELM_STORE_ITEM_MAPPING_ICON, /**< char * -> icon path */
79 ELM_STORE_ITEM_MAPPING_PHOTO, /**< char * -> photo path */ 83 ELM_STORE_ITEM_MAPPING_PHOTO, /**< char * -> photo path */
80 ELM_STORE_ITEM_MAPPING_CUSTOM, /**< item->custom(it->data, it, part) -> void * (-> any) */ 84 ELM_STORE_ITEM_MAPPING_CUSTOM, /**< item->custom(it->data, it, part) -> void * (-> any) */
81 ELM_STORE_ITEM_MAPPING_LAST 85 ELM_STORE_ITEM_MAPPING_LAST, /** canary value: any value greater or equal to ELM_STORE_ITEM_MAPPING_LAST is forbidden. */
82} Elm_Store_Item_Mapping_Type; 86} Elm_Store_Item_Mapping_Type;
83 87
84struct _Elm_Store_Item_Mapping_Icon 88struct _Elm_Store_Item_Mapping_Icon
diff --git a/src/lib/elm_toolbar_common.h b/src/lib/elm_toolbar_common.h
index 032f6f469..09d1eabd5 100644
--- a/src/lib/elm_toolbar_common.h
+++ b/src/lib/elm_toolbar_common.h
@@ -420,23 +420,25 @@ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *i
420 * Show a specific item, when the toolbar can be scrolled. 420 * Show a specific item, when the toolbar can be scrolled.
421 * 421 *
422 * @param it the toolbar item 422 * @param it the toolbar item
423 * @param scrollto the position the item should appear at
423 * 424 *
424 * see elm_toolbar_item_bring_in() 425 * see elm_toolbar_item_bring_in()
425 * 426 *
426 * @since 1.8 427 * @since 1.8
427 * @ingroup Toolbar 428 * @ingroup Toolbar
428 */ 429 */
429EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type); 430EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);
430 431
431/** 432/**
432 * Show a specific item with scroll animation, when the toolbar can be scrolled. 433 * Show a specific item with scroll animation, when the toolbar can be scrolled.
433 * 434 *
434 * @param it the toolbar item 435 * @param it the toolbar item
436 * @param scrollto the position the item should appear at
435 * 437 *
436 * see elm_toolbar_item_show() 438 * see elm_toolbar_item_show()
437 * 439 *
438 * @since 1.8 440 * @since 1.8
439 * @ingroup Toolbar 441 * @ingroup Toolbar
440 */ 442 */
441EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type); 443EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);
442 444
diff --git a/src/lib/elm_transit.h b/src/lib/elm_transit.h
index b490bff7a..32ffe5982 100644
--- a/src/lib/elm_transit.h
+++ b/src/lib/elm_transit.h
@@ -633,7 +633,7 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
633/** 633/**
634 * Set the smooth effect for a transit. 634 * Set the smooth effect for a transit.
635 * 635 *
636 * @param obj The transit object 636 * @param transit The transit object
637 * @param enabled enable or disable smooth map rendering 637 * @param enabled enable or disable smooth map rendering
638 * 638 *
639 * This sets smoothing for transit map rendering. If the object added in a 639 * This sets smoothing for transit map rendering. If the object added in a
@@ -646,14 +646,14 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
646 * 646 *
647 * @ingroup Transit 647 * @ingroup Transit
648 */ 648 */
649EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool smooth); 649EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled);
650 650
651/** 651/**
652 * Get the smooth scaling for transit map rendering 652 * Get the smooth scaling for transit map rendering
653 * 653 *
654 * This gets smooth scaling for transit map rendering. 654 * This gets smooth scaling for transit map rendering.
655 * 655 *
656 * @param obj The transit object 656 * @param transit The transit object
657 * @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise. 657 * @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise.
658 * 658 *
659 * @see elm_transit_smooth_set() 659 * @see elm_transit_smooth_set()
diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index dc51063e2..ff71cd16c 100644
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -134,7 +134,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
134 } 134 }
135 values { 135 values {
136 int *rotations @const_set; /*@ The array of rotation value. */ 136 int *rotations @const_set; /*@ The array of rotation value. */
137 uint count; /*@ The number of array of rotations */ 137 uint count; /*@ The size of the @param rotations array. */
138 } 138 }
139 } 139 }
140 quickpanel_zone { 140 quickpanel_zone {