summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThiep Ha <thiepha@gmail.com>2017-10-24 15:13:07 +0900
committerThiep Ha <thiepha@gmail.com>2017-10-24 15:46:30 +0900
commit0258ac77b05de2c8fecf0ec22ccaaf6f814383c0 (patch)
treea32661a53b6f7299ee5b79f2e8c02efc3059f2ee
parent4642fe2f649a45ad0e242fc803b683e7436f4f29 (diff)
doc: add missing parameters and fix references for some elm widgets
-rw-r--r--src/lib/elementary/elm_button.h12
-rw-r--r--src/lib/elementary/elm_calendar.h4
-rw-r--r--src/lib/elementary/elm_check.h4
-rw-r--r--src/lib/elementary/elm_colorselector.h4
-rw-r--r--src/lib/elementary/elm_config.h3
-rw-r--r--src/lib/elementary/elm_conform.h4
-rw-r--r--src/lib/elementary/elm_entry.h6
-rw-r--r--src/lib/elementary/elm_entry_legacy.h2
-rw-r--r--src/lib/elementary/elm_layout.h14
9 files changed, 29 insertions, 24 deletions
diff --git a/src/lib/elementary/elm_button.h b/src/lib/elementary/elm_button.h
index f8396a730c..49053e54f1 100644
--- a/src/lib/elementary/elm_button.h
+++ b/src/lib/elementary/elm_button.h
@@ -15,11 +15,11 @@
15 * This is a push-button. Press it and run some function. It can contain 15 * This is a push-button. Press it and run some function. It can contain
16 * a simple label and icon object and it also has an autorepeat feature. 16 * a simple label and icon object and it also has an autorepeat feature.
17 * 17 *
18 * This widget inherits from the @ref Layout one, so that all the 18 * This widget inherits from the @ref Elm_Layout one, so that all the
19 * functions acting on it also work for button objects. 19 * functions acting on it also work for button objects.
20 * 20 *
21 * This widget emits the following signals, besides the ones sent from 21 * This widget emits the following signals, besides the ones sent from
22 * @ref Layout: 22 * @ref Elm_Layout :
23 * @li "clicked": the user clicked the button (press/release). 23 * @li "clicked": the user clicked the button (press/release).
24 * @li "repeated": the user pressed the button without releasing it. 24 * @li "repeated": the user pressed the button without releasing it.
25 * @li "pressed": button was pressed. 25 * @li "pressed": button was pressed.
@@ -34,11 +34,11 @@
34 * @li default: a normal button. 34 * @li default: a normal button.
35 * @li anchor: Like default, but the button fades away when the mouse is not 35 * @li anchor: Like default, but the button fades away when the mouse is not
36 * over it, leaving only the text or icon. 36 * over it, leaving only the text or icon.
37 * @li hoversel_vertical: Internally used by @ref Hoversel to give a 37 * @li hoversel_vertical: Internally used by @ref Elm_Hoversel to give a
38 * continuous look across its options. 38 * continuous look across its options.
39 * @li hoversel_vertical_entry: Another internal for @ref Hoversel. 39 * @li hoversel_vertical_entry: Another internal for @ref Elm_Hoversel.
40 * @li naviframe: Internally used by @ref Naviframe for its back button. 40 * @li naviframe: Internally used by @ref Elm_Naviframe for its back button.
41 * @li colorselector: Internally used by @ref Colorselector 41 * @li colorselector: Internally used by @ref Elm_Colorselector
42 * for its left and right buttons. 42 * for its left and right buttons.
43 * 43 *
44 * Default content parts of the button widget that you can use for are: 44 * Default content parts of the button widget that you can use for are:
diff --git a/src/lib/elementary/elm_calendar.h b/src/lib/elementary/elm_calendar.h
index f0fc828a7b..f67daf5ee2 100644
--- a/src/lib/elementary/elm_calendar.h
+++ b/src/lib/elementary/elm_calendar.h
@@ -17,11 +17,11 @@
17 * - setting the day names of the week (e.g. "Thu" or "Thursday") 17 * - setting the day names of the week (e.g. "Thu" or "Thursday")
18 * - setting the year and month format. 18 * - setting the year and month format.
19 * 19 *
20 * This widget inherits from the @ref Layout one, so that all the 20 * This widget inherits from the @ref Elm_Layout one, so that all the
21 * functions acting on it also work for calendar objects. 21 * functions acting on it also work for calendar objects.
22 * 22 *
23 * This widget emits the following signals, besides the ones sent from 23 * This widget emits the following signals, besides the ones sent from
24 * @ref Layout: 24 * @ref Elm_Layout :
25 * - @c "changed" - emitted when the date in the calendar is changed. 25 * - @c "changed" - emitted when the date in the calendar is changed.
26 * - @c "display,changed" - emitted when the current month displayed in the 26 * - @c "display,changed" - emitted when the current month displayed in the
27 * calendar is changed. 27 * calendar is changed.
diff --git a/src/lib/elementary/elm_check.h b/src/lib/elementary/elm_check.h
index 6004ca1de6..0cf6b821c7 100644
--- a/src/lib/elementary/elm_check.h
+++ b/src/lib/elementary/elm_check.h
@@ -23,11 +23,11 @@
23 * like the radio objects, you can set a pointer to a boolean directly 23 * like the radio objects, you can set a pointer to a boolean directly
24 * with elm_check_state_pointer_set() for it to modify. 24 * with elm_check_state_pointer_set() for it to modify.
25 * 25 *
26 * This widget inherits from the @ref Layout one, so that all the 26 * This widget inherits from the @ref Elm_Layout one, so that all the
27 * functions acting on it also work for check objects. 27 * functions acting on it also work for check objects.
28 * 28 *
29 * This widget emits the following signals, besides the ones sent from 29 * This widget emits the following signals, besides the ones sent from
30 * @ref Layout: 30 * @ref Elm_Layout :
31 * - @c "changed" - This is called whenever the user changes the state of 31 * - @c "changed" - This is called whenever the user changes the state of
32 * the check objects (@p event_info is always @c NULL). 32 * the check objects (@p event_info is always @c NULL).
33 * - @c "focused" - When the check has received focus. (since 1.8) 33 * - @c "focused" - When the check has received focus. (since 1.8)
diff --git a/src/lib/elementary/elm_colorselector.h b/src/lib/elementary/elm_colorselector.h
index ffce041334..bc13bc4cf2 100644
--- a/src/lib/elementary/elm_colorselector.h
+++ b/src/lib/elementary/elm_colorselector.h
@@ -15,11 +15,11 @@
15 * can be picked by user from the color set by clicking on individual 15 * can be picked by user from the color set by clicking on individual
16 * color item on the palette or by selecting it from selector. 16 * color item on the palette or by selecting it from selector.
17 * 17 *
18 * This widget inherits from the @ref Layout one, so that all the 18 * This widget inherits from the @ref Elm_Layout one, so that all the
19 * functions acting on it also work for check objects. 19 * functions acting on it also work for check objects.
20 * 20 *
21 * This widget emits the following signals, besides the ones sent from 21 * This widget emits the following signals, besides the ones sent from
22 * @ref Layout: 22 * @ref Elm_Layout :
23 * - @c "changed" - When the color value changes on selector 23 * - @c "changed" - When the color value changes on selector
24 * event_info is NULL. 24 * event_info is NULL.
25 * - @c "color,item,selected" - When user clicks on color item. The 25 * - @c "color,item,selected" - When user clicks on color item. The
diff --git a/src/lib/elementary/elm_config.h b/src/lib/elementary/elm_config.h
index 3a080fb4e1..272fdf6957 100644
--- a/src/lib/elementary/elm_config.h
+++ b/src/lib/elementary/elm_config.h
@@ -301,6 +301,9 @@ EAPI void elm_config_scroll_page_scroll_friction_set(double friction);
301 * Get enable status of context menu disabled. 301 * Get enable status of context menu disabled.
302 * 302 *
303 * @see elm_config_context_menu_disabled_set() 303 * @see elm_config_context_menu_disabled_set()
304 *
305 * @return @c EINA_TRUE if context menu is disabled, otherwise @c EINA_FALSE.
306 *
304 * @ingroup Elm_Entry 307 * @ingroup Elm_Entry
305 * @since 1.17 308 * @since 1.17
306 */ 309 */
diff --git a/src/lib/elementary/elm_conform.h b/src/lib/elementary/elm_conform.h
index d059e12eed..c1c822fca5 100644
--- a/src/lib/elementary/elm_conform.h
+++ b/src/lib/elementary/elm_conform.h
@@ -19,11 +19,11 @@
19 * space required for such stuff, and when they popup, as a keyboard 19 * space required for such stuff, and when they popup, as a keyboard
20 * shows when an entry is selected, conformant content won't change. 20 * shows when an entry is selected, conformant content won't change.
21 * 21 *
22 * This widget inherits from the @ref Layout one, so that all the 22 * This widget inherits from the @ref Elm_Layout one, so that all the
23 * functions acting on it also work for conformant objects. 23 * functions acting on it also work for conformant objects.
24 * 24 *
25 * This widget emits the following signals, besides the ones sent from 25 * This widget emits the following signals, besides the ones sent from
26 * @ref Layout: 26 * @ref Elm_Layout :
27 * @li "virtualkeypad,state,on": if virtualkeypad state is switched to "on". 27 * @li "virtualkeypad,state,on": if virtualkeypad state is switched to "on".
28 * (since 1.8) 28 * (since 1.8)
29 * @li "virtualkeypad,state,off": if virtualkeypad state is switched to "off". 29 * @li "virtualkeypad,state,off": if virtualkeypad state is switched to "off".
diff --git a/src/lib/elementary/elm_entry.h b/src/lib/elementary/elm_entry.h
index a24a1cb3c3..d4b8832d44 100644
--- a/src/lib/elementary/elm_entry.h
+++ b/src/lib/elementary/elm_entry.h
@@ -27,12 +27,12 @@
27 * elm_entry_markup_filter_append() and related functions, inline "items" and 27 * elm_entry_markup_filter_append() and related functions, inline "items" and
28 * formatted markup text. 28 * formatted markup text.
29 * 29 *
30 * This widget inherits from the @ref Layout one, so that all the 30 * This widget inherits from the @ref Elm_Layout one, so that all the
31 * functions acting on it also work for entry objects (since 1.8). 31 * functions acting on it also work for entry objects (since 1.8).
32 * 32 *
33 * This widget implements the @b @ref elm-scrollable-interface 33 * This widget implements the @b @ref elm-scrollable-interface
34 * interface, so that all (non-deprecated) functions for the base 34 * interface, so that all (non-deprecated) functions for the base
35 * @ref Scroller widget also work for entries (since 1.8). 35 * @ref Elm_Scroller widget also work for entries (since 1.8).
36 * 36 *
37 * Some calls on the entry's API are marked as @b deprecated, as they 37 * Some calls on the entry's API are marked as @b deprecated, as they
38 * just wrap the scrollable widgets counterpart functions. Use the 38 * just wrap the scrollable widgets counterpart functions. Use the
@@ -231,7 +231,7 @@
231 * @section entry-signals Emitted signals 231 * @section entry-signals Emitted signals
232 * 232 *
233 * This widget emits the following signals, besides the ones sent from 233 * This widget emits the following signals, besides the ones sent from
234 * @ref Layout: 234 * @ref Elm_Layout :
235 * @li "aborted": The escape key was pressed on a single line entry. (since 1.7) 235 * @li "aborted": The escape key was pressed on a single line entry. (since 1.7)
236 * @li "activated": The enter key was pressed on a single line entry. 236 * @li "activated": The enter key was pressed on a single line entry.
237 * @li "anchor,clicked": An anchor has been clicked. The event_info 237 * @li "anchor,clicked": An anchor has been clicked. The event_info
diff --git a/src/lib/elementary/elm_entry_legacy.h b/src/lib/elementary/elm_entry_legacy.h
index 2a305440e5..ef10268c3f 100644
--- a/src/lib/elementary/elm_entry_legacy.h
+++ b/src/lib/elementary/elm_entry_legacy.h
@@ -53,6 +53,7 @@ EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
53 * 53 *
54 * @ingroup Elm_Entry 54 * @ingroup Elm_Entry
55 * 55 *
56 * @param[in] obj The entry object
56 * @param[in] file The path to the file to load and save 57 * @param[in] file The path to the file to load and save
57 * @param[in] format The file format 58 * @param[in] format The file format
58 */ 59 */
@@ -67,6 +68,7 @@ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, E
67 * 68 *
68 * @ingroup Elm_Entry 69 * @ingroup Elm_Entry
69 * 70 *
71 * @param[in] obj The entry object
70 * @param[out] file The path to the file to load and save 72 * @param[out] file The path to the file to load and save
71 * @param[out] format The file format 73 * @param[out] format The file format
72 */ 74 */
diff --git a/src/lib/elementary/elm_layout.h b/src/lib/elementary/elm_layout.h
index a867b5bd2f..a59fd7c650 100644
--- a/src/lib/elementary/elm_layout.h
+++ b/src/lib/elementary/elm_layout.h
@@ -21,7 +21,7 @@
21 * the Edje documentation and the EDC reference to get more 21 * the Edje documentation and the EDC reference to get more
22 * information about what can be done with Edje. 22 * information about what can be done with Edje.
23 * 23 *
24 * Just like @ref List, @ref Box, and other container widgets, any 24 * Just like @ref Elm_List, @ref Elm_Box, and other container widgets, any
25 * object added to the Layout will become its child, meaning that it 25 * object added to the Layout will become its child, meaning that it
26 * will be deleted if the Layout is deleted, moved if the Layout is 26 * will be deleted if the Layout is deleted, moved if the Layout is
27 * moved, and so on. 27 * moved, and so on.
@@ -68,7 +68,7 @@
68 * 68 *
69 * @section secBox Box (@c BOX part) 69 * @section secBox Box (@c BOX part)
70 * 70 *
71 * An Edje @c BOX part is very similar to the Elementary @ref Box 71 * An Edje @c BOX part is very similar to the Elementary @ref Elm_Box
72 * widget. It allows one to add objects to the box and have them 72 * widget. It allows one to add objects to the box and have them
73 * distributed along its area, accordingly to the specified @c layout 73 * distributed along its area, accordingly to the specified @c layout
74 * property (now by @c layout we mean the chosen layouting design of 74 * property (now by @c layout we mean the chosen layouting design of
@@ -76,14 +76,14 @@
76 * 76 *
77 * A similar effect for having a box with its position, size and other 77 * A similar effect for having a box with its position, size and other
78 * things controlled by the layout theme would be to create an 78 * things controlled by the layout theme would be to create an
79 * Elementary @ref Box widget and add it as content in a @c SWALLOW part. 79 * Elementary @ref Elm_Box widget and add it as content in a @c SWALLOW part.
80 * 80 *
81 * The main difference to that, by using the layout box instead, is 81 * The main difference to that, by using the layout box instead, is
82 * that its behavior, like layouting format, padding, align, etc., 82 * that its behavior, like layouting format, padding, align, etc.,
83 * will <b>all be controlled by the theme</b>. This means, for 83 * will <b>all be controlled by the theme</b>. This means, for
84 * example, that a signal could be sent to the layout's theme (with 84 * example, that a signal could be sent to the layout's theme (with
85 * elm_layout_signal_emit()) and the signal be handled by changing the 85 * elm_layout_signal_emit()) and the signal be handled by changing the
86 * box's padding, or alignment, or both. Using the Elementary @ref Box 86 * box's padding, or alignment, or both. Using the Elementary @ref Elm_Box
87 * widget is not necessarily harder or easier, it just depends on the 87 * widget is not necessarily harder or easier, it just depends on the
88 * circumstances and requirements. 88 * circumstances and requirements.
89 * 89 *
@@ -99,14 +99,14 @@
99 * @section secTable Table (@c TABLE part) 99 * @section secTable Table (@c TABLE part)
100 * 100 *
101 * Just like the @ref secBox, the layout table is very similar to the 101 * Just like the @ref secBox, the layout table is very similar to the
102 * Elementary @ref Table widget. It allows one to add objects to the 102 * Elementary @ref Elm_Table widget. It allows one to add objects to the
103 * table by specifying the row and column where the object should be 103 * table by specifying the row and column where the object should be
104 * added, and any column or row span, if necessary. 104 * added, and any column or row span, if necessary.
105 * 105 *
106 * Again, we could have this design by adding a @ref table widget to a 106 * Again, we could have this design by adding a @ref Elm_Table widget to a
107 * @c SWALLOW part, using elm_layout_content_set(). The same 107 * @c SWALLOW part, using elm_layout_content_set(). The same
108 * difference happens here when choosing to use the layout table (a 108 * difference happens here when choosing to use the layout table (a
109 * @c TABLE part) instead of the @ref table in a @c SWALLOW part. It's 109 * @c TABLE part) instead of the @ref Elm_Table in a @c SWALLOW part. It's
110 * just a matter of convenience. 110 * just a matter of convenience.
111 * 111 *
112 * The layout table can be used through the @c elm_layout_table_* set of 112 * The layout table can be used through the @c elm_layout_table_* set of