summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrien Nader <adrien@notk.org>2014-10-13 15:59:28 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:42:21 +0200
commitc8dd871c1d38d6dd196578c0d2560dc09b336cc5 (patch)
tree84e3c9f632a39870339ce8babc11c259b9db4ab8
parent5bbf974060a09e15237eb9521a345adad922ea61 (diff)
doc: add API docs in button, container, image, store, general.
This adds API docs for: - elm_button_admits_autorepeat_get - elm_container_content_swallow_list_get - content_get - content_set - content_unset - elm_image_resize_down_set - resize_down_get - resize_up_set - resize_up_get - scale_set - scale_get - fill_inside_set - fill_inside_get - sizing_eval Light documentation for enum Elm_Object_Select_Mode, enum Elm_Object_Multi_Select_Mode and Elm_Store_Item_Mapping_Type.
-rw-r--r--src/lib/elm_button.eo2
-rw-r--r--src/lib/elm_container.eo14
-rw-r--r--src/lib/elm_general.h12
-rw-r--r--src/lib/elm_image.eo88
-rw-r--r--src/lib/elm_store.h6
5 files changed, 98 insertions, 24 deletions
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_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_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_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