From 829978594788326cd0d4bdf41a50e40d623a2cd5 Mon Sep 17 00:00:00 2001 From: Boris Faure Date: Mon, 12 Apr 2010 08:12:02 +0000 Subject: [PATCH] elm: add lots of doc! Thanks to Mike (zmike/discomfitor) SVN revision: 47944 --- src/lib/elc_fileselector.c | 11 +- src/lib/elm_box.c | 2 + src/lib/elm_bubble.c | 43 +++-- src/lib/elm_button.c | 1 - src/lib/elm_clock.c | 10 +- src/lib/elm_entry.c | 343 +++++++++++++++++++++++++++++++++++++++ src/lib/elm_flip.c | 47 +++++- src/lib/elm_hover.c | 60 +++++++ src/lib/elm_index.c | 55 +++---- src/lib/elm_layout.c | 2 +- src/lib/elm_list.c | 271 +++++++++++++++++++++++++++++++ src/lib/elm_map.c | 165 ++++++++++++------- src/lib/elm_mapbuf.c | 58 ++++++- src/lib/elm_menu.c | 90 ++++++++++- src/lib/elm_panel.c | 48 ++++++ src/lib/elm_photocam.c | 6 + src/lib/elm_separator.c | 32 ++++ src/lib/elm_slideshow.c | 40 ++++- src/lib/elm_theme.c | 46 ++++++ src/lib/elm_toggle.c | 97 +++++++++++ src/lib/elm_toolbar.c | 184 ++++++++++++++++++++- src/lib/elm_widget.c | 394 +++++++++++++++++++++++++++++++++++++++++++++ src/lib/elm_win.c | 329 +++++++++++++++++++++++++++++++++++++ 23 files changed, 2204 insertions(+), 130 deletions(-) diff --git a/src/lib/elc_fileselector.c b/src/lib/elc_fileselector.c index a35326f..f440ec0 100644 --- a/src/lib/elc_fileselector.c +++ b/src/lib/elc_fileselector.c @@ -501,11 +501,10 @@ elm_fileselector_add(Evas_Object *parent) /** * This enables/disables the file name entry box where the user can - * type in the name of a file to be selected. + * type in a name for the file to be saved as. * * @param obj The fileselector object - * @param is_save If true, creates the entry object in the fileselector. - * If false, deletes the entry object in the fileselector. + * @param is_save If true, the fileselector is a save dialog * * @ingroup Fileselector */ @@ -535,12 +534,10 @@ elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) } /** - * This gets the state of the file name entry box where the user can - * type in the name of a file to be selected. + * This returns whether the fileselector is a "save" type fileselector * * @param obj The fileselector object - * @return If true, the entry object exists in the fileselector. - * If false, it does not exist. + * @return If true, the fileselector is a save type. * * @ingroup Fileselector */ diff --git a/src/lib/elm_box.c b/src/lib/elm_box.c index e0d76db..2eab987 100644 --- a/src/lib/elm_box.c +++ b/src/lib/elm_box.c @@ -15,6 +15,8 @@ * will set the packing weight. The weights of all items being packed are added * up and if items are to be sized up to fit, those with the higher weights get * proportionally more space. + * + * NOTE: Objects should not be added to box objects using _add() calls. */ typedef struct _Widget_Data Widget_Data; diff --git a/src/lib/elm_bubble.c b/src/lib/elm_bubble.c index c4386a5..b14225c 100644 --- a/src/lib/elm_bubble.c +++ b/src/lib/elm_bubble.c @@ -118,10 +118,10 @@ elm_bubble_add(Evas_Object *parent) /** * Set the label of the bubble * - * @param obj The given evas pointer + * @param obj The bubble object * @param label The string to set in the label * - * This function sets the title of the bubble that is showed on top of + * This function sets the title of the bubble that is shown on top of * the bubble. * * @ingroup Bubble @@ -137,6 +137,17 @@ elm_bubble_label_set(Evas_Object *obj, const char *label) _sizing_eval(obj); } +/** + * Get the label of the bubble + * + * @param obj The bubble object + * @return The string of set in the label + * + * This function gets the title of the bubble that is shown on top of + * the bubble. + * + * @ingroup Bubble + */ EAPI const char* elm_bubble_label_get(const Evas_Object *obj) { @@ -149,11 +160,11 @@ elm_bubble_label_get(const Evas_Object *obj) /** * Set the info of the bubble * - * @param obj The given evas pointer + * @param obj The bubble object * @param info The given info about the bubble * - * This function sets the text showed on the top right of bubble In - * the Anchorblock example of the Elementary tests application it + * This function sets the text shown on the top right of bubble. + * In the Anchorblock example of the Elementary tests application it * shows time. * * @ingroup Bubble @@ -173,7 +184,7 @@ elm_bubble_info_set(Evas_Object *obj, const char *info) /** * Get the info of the bubble * - * @param obj The given evas pointer + * @param obj The bubble object * * @return The "info" string of the bubble * @@ -195,10 +206,10 @@ elm_bubble_info_get(const Evas_Object *obj) /** * Set the text to be showed in the bubble * - * @param obj The given evas pointer + * @param obj The bubble object * @param content The given info about the bubble * - * This function sets the text showed on the top right of bubble. In + * This function sets the text shown on the top right of bubble. In * the Anchorblock example of the Elementary tests application it * shows time. * @@ -227,10 +238,10 @@ elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) /** * Set the icon of the bubble * - * @param obj The given evas pointer + * @param obj The bubble object * @param icon The given icon for the bubble * - * This function sets the icon showed on the top left of bubble. + * This function sets the icon shown on the top left of bubble. * * @ingroup Bubble */ @@ -253,6 +264,16 @@ elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) _sizing_eval(obj); } +/** + * Get the icon of the bubble + * + * @param obj The bubble object + * @return The icon for the bubble + * + * This function gets the icon shown on the top left of bubble. + * + * @ingroup Bubble + */ EAPI Evas_Object * elm_bubble_icon_get(const Evas_Object *obj) { @@ -265,7 +286,7 @@ elm_bubble_icon_get(const Evas_Object *obj) /** * Set the corner of the bubble * - * @param obj The given evas pointer. + * @param obj The bubble object. * @param corner The given corner for the bubble. * * This function sets the corner of the bubble. diff --git a/src/lib/elm_button.c b/src/lib/elm_button.c index 9aab14f..a044dde 100644 --- a/src/lib/elm_button.c +++ b/src/lib/elm_button.c @@ -409,4 +409,3 @@ elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) wd->ar_interval = t; if (wd->repeating && wd->timer) ecore_timer_interval_set(wd->timer, t); } - diff --git a/src/lib/elm_clock.c b/src/lib/elm_clock.c index 26a78df..01711bc 100644 --- a/src/lib/elm_clock.c +++ b/src/lib/elm_clock.c @@ -5,7 +5,7 @@ * @defgroup Clock Clock * * It's a widget to show clock with animation. The update of time is - * showed in an animation like a flip of a sheet. + * shown in an animation like the flip of a sheet. * */ @@ -502,7 +502,7 @@ elm_clock_edit_get(const Evas_Object *obj) } /** - * Set if the clock show hours in military or am/pm mode + * Set if the clock shows hours in military or am/pm mode * * @param obj The clock object * @param am_pm Bool option for the hours mode @@ -526,7 +526,7 @@ elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) } /** - * Get if the clock show hours in military or am/pm mode + * Get if the clock shows hours in military or am/pm mode * * @param obj The clock object * @return Bool option for the hours mode @@ -549,7 +549,7 @@ elm_clock_show_am_pm_get(const Evas_Object *obj) } /** - * Set if the clock show hour with the seconds + * Set if the clock shows hour with the seconds * * @param obj The clock object * @param seconds Bool option for the show seconds @@ -571,7 +571,7 @@ elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) } /** - * Get if the clock show hour with the seconds + * Get if the clock shows hour with the seconds * * @param obj The clock object * @return Bool option for the show seconds diff --git a/src/lib/elm_entry.c b/src/lib/elm_entry.c index 08b754b..52c3ac4 100644 --- a/src/lib/elm_entry.c +++ b/src/lib/elm_entry.c @@ -1,6 +1,35 @@ #include #include "elm_priv.h" +/** + * @defgroup Entry Entry + * + * An entry is a convenience widget which shows + * a box that the user can enter text into. Unlike a + * @ref Scrolled_Entry widget, entries DO NOT scroll with user + * input. Entry widgets are capable of expanding past the + * boundaries of the window, thus resizing the window to its + * own length. + * + * Signals that you can add callbacks for are: + * "changed" - The text within the entry was changed + * "activated" - The entry has received focus and the cursor + * "press" - The entry has been clicked + * "longpressed" - The entry has been clicked for a couple seconds + * "clicked" - The entry has been clicked + * "clicked,double" - The entry has been double clicked + * "focused" - The entry has received focus + * "unfocused" - The entry has lost focus + * "selection,paste" - A paste action has occurred + * "selection,copy" - A copy action has occurred + * "selection,cut" - A cut action has occurred + * "selection,start" - A selection has begun + * "selection,changed" - The selection has changed + * "selection,cleared" - The selection has been cleared + * "cursor,changed" - The cursor has changed + * "anchor,clicked" - The anchor has been clicked + */ + typedef struct _Mod_Api Mod_Api; typedef struct _Widget_Data Widget_Data; @@ -1127,6 +1156,15 @@ _event_selection_clear(void *data, int type __UNUSED__, void *event) } #endif + +/** + * This adds an entry to @p parent object. + * + * @param parent The parent object + * @return The new object or NULL if it cannot be created + * + * @ingroup Entry + */ EAPI Evas_Object * elm_entry_add(Evas_Object *parent) { @@ -1228,6 +1266,17 @@ elm_entry_add(Evas_Object *parent) return obj; } + +/** + * This sets the entry object not to line wrap. All input will + * be on a single line, and the entry box will extend with user input. + * + * @param obj The entry object + * @param single_line If true, the text in the entry + * will be on a single line. + * + * @ingroup Entry + */ EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) { @@ -1246,6 +1295,16 @@ elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) _sizing_eval(obj); } +/** + * This returns true if the entry has been set to single line mode. + * See also elm_entry_single_line_set(). + * + * @param obj The entry object + * @return single_line If true, the text in the entry is set to display + * on a single line. + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) { @@ -1255,6 +1314,15 @@ elm_entry_single_line_get(const Evas_Object *obj) return wd->single_line; } +/** + * This sets the entry object to password mode. All text entered + * and/or displayed within the widget will be replaced with asterisks (*). + * + * @param obj The entry object + * @param password If true, password mode is enabled. + * + * @ingroup Entry + */ EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) { @@ -1274,6 +1342,17 @@ elm_entry_password_set(Evas_Object *obj, Eina_Bool password) _sizing_eval(obj); } + +/** + * This returns whether password mode is enabled. + * See also elm_entry_password_set(). + * + * @param obj The entry object + * @return If true, the entry is set to display all characters + * as asterisks (*). + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) { @@ -1283,6 +1362,14 @@ elm_entry_password_get(const Evas_Object *obj) return wd->password; } +/** + * This sets the text displayed within the entry to @p entry. + * + * @param obj The entry object + * @param entry The text to be displayed + * + * @ingroup Entry + */ EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) { @@ -1297,6 +1384,15 @@ elm_entry_entry_set(Evas_Object *obj, const char *entry) _sizing_eval(obj); } +/** + * This returns the text currently shown in object @p entry. + * See also elm_entry_entry_set(). + * + * @param obj The entry object + * @return The currently displayed text or NULL on failure + * + * @ingroup Entry + */ EAPI const char * elm_entry_entry_get(const Evas_Object *obj) { @@ -1315,6 +1411,14 @@ elm_entry_entry_get(const Evas_Object *obj) return wd->text; } +/** + * This returns all selected text within the entry. + * + * @param obj The entry object + * @return The selected text within the entry or NULL on failure + * + * @ingroup Entry + */ EAPI const char * elm_entry_selection_get(const Evas_Object *obj) { @@ -1324,6 +1428,15 @@ elm_entry_selection_get(const Evas_Object *obj) return edje_object_part_text_selection_get(wd->ent, "elm.text"); } +/** + * This inserts text in @p entry at the beginning of the entry + * object. + * + * @param obj The entry object + * @param entry The text to insert + * + * @ingroup Entry + */ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) { @@ -1335,6 +1448,19 @@ elm_entry_entry_insert(Evas_Object *obj, const char *entry) _sizing_eval(obj); } +/** + * This enables word line wrapping in the entry object. It is the opposite + * of elm_entry_single_line_set(). Additionally, setting this disables + * character line wrapping. + * See also elm_entry_line_char_wrap_set(). + * + * @param obj The entry object + * @param wrap If true, the entry will be wrapped once it reaches the end + * of the object. Wrapping will occur at the end of the word before the end of the + * object. + * + * @ingroup Entry + */ EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Eina_Bool wrap) { @@ -1353,6 +1479,18 @@ elm_entry_line_wrap_set(Evas_Object *obj, Eina_Bool wrap) _sizing_eval(obj); } +/** + * This enables character line wrapping in the entry object. It is the opposite + * of elm_entry_single_line_set(). Additionally, setting this disables + * word line wrapping. + * See also elm_entry_line_wrap_set(). + * + * @param obj The entry object + * @param wrap If true, the entry will be wrapped once it reaches the end + * of the object. Wrapping will occur immediately upon reaching the end of the object. + * + * @ingroup Entry + */ EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) { @@ -1371,6 +1509,15 @@ elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) _sizing_eval(obj); } +/** + * This sets the editable attribute of the entry. + * + * @param obj The entry object + * @param editable If true, the entry will be editable by the user. + * If false, it will be set to the disabled state. + * + * @ingroup Entry + */ EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) { @@ -1387,6 +1534,16 @@ elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) _sizing_eval(obj); } +/** + * This gets the editable attribute of the entry. + * See also elm_entry_editable_set(). + * + * @param obj The entry object + * @return If true, the entry is editable by the user. + * If false, it is not editable by the user + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) { @@ -1396,6 +1553,13 @@ elm_entry_editable_get(const Evas_Object *obj) return wd->editable; } +/** + * This drops any existing text selection within the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_select_none(Evas_Object *obj) { @@ -1412,6 +1576,13 @@ elm_entry_select_none(Evas_Object *obj) edje_object_part_text_select_none(wd->ent, "elm.text"); } +/** + * This selects all text within the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_select_all(Evas_Object *obj) { @@ -1428,6 +1599,14 @@ elm_entry_select_all(Evas_Object *obj) edje_object_part_text_select_all(wd->ent, "elm.text"); } +/** + * This moves the cursor one place to the right within the entry. + * + * @param obj The entry object + * @return EINA_TRUE upon success, EINA_FALSE upon failure + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) { @@ -1437,6 +1616,14 @@ elm_entry_cursor_next(Evas_Object *obj) return edje_object_part_text_cursor_next(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor one place to the left within the entry. + * + * @param obj The entry object + * @return EINA_TRUE upon success, EINA_FALSE upon failure + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) { @@ -1446,6 +1633,14 @@ elm_entry_cursor_prev(Evas_Object *obj) return edje_object_part_text_cursor_prev(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor one line up within the entry. + * + * @param obj The entry object + * @return EINA_TRUE upon success, EINA_FALSE upon failure + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) { @@ -1455,6 +1650,14 @@ elm_entry_cursor_up(Evas_Object *obj) return edje_object_part_text_cursor_up(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor one line down within the entry. + * + * @param obj The entry object + * @return EINA_TRUE upon success, EINA_FALSE upon failure + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) { @@ -1464,6 +1667,13 @@ elm_entry_cursor_down(Evas_Object *obj) return edje_object_part_text_cursor_down(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor to the beginning of the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) { @@ -1473,6 +1683,13 @@ elm_entry_cursor_begin_set(Evas_Object *obj) edje_object_part_text_cursor_begin_set(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor to the end of the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_end_set(Evas_Object *obj) { @@ -1482,6 +1699,13 @@ elm_entry_cursor_end_set(Evas_Object *obj) edje_object_part_text_cursor_end_set(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor to the beginning of the current line. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) { @@ -1491,6 +1715,13 @@ elm_entry_cursor_line_begin_set(Evas_Object *obj) edje_object_part_text_cursor_line_begin_set(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This moves the cursor to the end of the current line. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) { @@ -1500,6 +1731,14 @@ elm_entry_cursor_line_end_set(Evas_Object *obj) edje_object_part_text_cursor_line_end_set(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This begins a selection within the entry as though + * the user were holding down the mouse button to make a selection. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) { @@ -1509,6 +1748,14 @@ elm_entry_cursor_selection_begin(Evas_Object *obj) edje_object_part_text_select_begin(wd->ent, "elm.text"); } +/** + * This ends a selection within the entry as though + * the user had just released the mouse button while making a selection. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) { @@ -1518,6 +1765,14 @@ elm_entry_cursor_selection_end(Evas_Object *obj) edje_object_part_text_select_extend(wd->ent, "elm.text"); } +/** + * TODO: fill this in + * + * @param obj The entry object + * @return TODO: fill this in + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) { @@ -1527,6 +1782,14 @@ elm_entry_cursor_is_format_get(const Evas_Object *obj) return edje_object_part_text_cursor_is_format_get(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This returns whether the cursor is visible. + * + * @param obj The entry object + * @return If true, the cursor is visible. + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) { @@ -1536,6 +1799,14 @@ elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) return edje_object_part_text_cursor_is_visible_format_get(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * TODO: fill this in + * + * @param obj The entry object + * @return TODO: fill this in + * + * @ingroup Entry + */ EAPI const char * elm_entry_cursor_content_get(const Evas_Object *obj) { @@ -1545,6 +1816,13 @@ elm_entry_cursor_content_get(const Evas_Object *obj) return edje_object_part_text_cursor_content_get(wd->ent, "elm.text", EDJE_CURSOR_MAIN); } +/** + * This executes a "cut" action on the selected text in the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_selection_cut(Evas_Object *obj) { @@ -1554,6 +1832,13 @@ elm_entry_selection_cut(Evas_Object *obj) _cut(obj, NULL, NULL); } +/** + * This executes a "copy" action on the selected text in the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_selection_copy(Evas_Object *obj) { @@ -1563,6 +1848,13 @@ elm_entry_selection_copy(Evas_Object *obj) _copy(obj, NULL, NULL); } +/** + * This executes a "paste" action in the entry. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_selection_paste(Evas_Object *obj) { @@ -1572,6 +1864,13 @@ elm_entry_selection_paste(Evas_Object *obj) _paste(obj, NULL, NULL); } +/** + * This clears and frees the items in a entry's contextual (right click) menu. + * + * @param obj The entry object + * + * @ingroup Entry + */ EAPI void elm_entry_context_menu_clear(Evas_Object *obj) { @@ -1588,6 +1887,18 @@ elm_entry_context_menu_clear(Evas_Object *obj) } } +/** + * This adds an item to the entry's contextual menu. + * + * @param obj The entry object + * @param label The item's text label + * @param icon_file The item's icon file + * @param icon_type The item's icon type + * @param func The callback to execute when the item is clicked + * @param data The data to associate with the item for related functions + * + * @ingroup Entry + */ EAPI void elm_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) { @@ -1606,6 +1917,14 @@ elm_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char it->data = (void *)data; } +/** + * This disables the entry's contextual (right click) menu. + * + * @param obj The entry object + * @param disabled If true, the menu is disabled + * + * @ingroup Entry + */ EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) { @@ -1616,6 +1935,14 @@ elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) wd->context_menu = !disabled; } +/** + * This returns whether the entry's contextual (right click) menu is disabled. + * + * @param obj The entry object + * @return If true, the menu is disabled + * + * @ingroup Entry + */ EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) { @@ -1625,6 +1952,14 @@ elm_entry_context_menu_disabled_get(const Evas_Object *obj) return !wd->context_menu; } +/** + * This converts a markup (HTML-like) string into UTF-8. + * + * @param s The string (in markup) to be converted + * @return The converted string (in UTF-8) + * + * @ingroup Entry + */ EAPI char * elm_entry_markup_to_utf8(const char *s) { @@ -1633,6 +1968,14 @@ elm_entry_markup_to_utf8(const char *s) return ss; } +/** + * This converts a UTF-8 string into markup (HTML-like). + * + * @param s The string (in UTF-8) to be converted + * @return The converted string (in markup) + * + * @ingroup Entry + */ EAPI char * elm_entry_utf8_to_markup(const char *s) { diff --git a/src/lib/elm_flip.c b/src/lib/elm_flip.c index 1bbaebd..4a591ba 100644 --- a/src/lib/elm_flip.c +++ b/src/lib/elm_flip.c @@ -4,8 +4,18 @@ /** * @defgroup Flip Flip * - * This holds 2 content objects, ont on the front and one on the back and - * allows you to flip from front to back and vice-versa given various effects + * This holds 2 content objects: one on the front and one on the back. It + * allows you to flip from front to back and vice-versa using various effects. + * + * Supported flip types: + * ELM_FLIP_ROTATE_Y_CENTER_AXIS + * ELM_FLIP_ROTATE_X_CENTER_AXIS + * ELM_FLIP_ROTATE_XZ_CENTER_AXIS + * ELM_FLIP_ROTATE_YZ_CENTER_AXIS + * + * Signals that you can add callbacks for are: + * + * "animate,done" - when a flip animation is finished */ typedef struct _Widget_Data Widget_Data; @@ -316,7 +326,7 @@ elm_flip_add(Evas_Object *parent) * Set the flip front content * * @param obj The flip object - * @param content The content will be filled in this flip object + * @param content The content to be used in this flip object * * @ingroup Flip */ @@ -355,7 +365,7 @@ elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) * Set the flip back content * * @param obj The flip object - * @param content The content will be filled in this flip object + * @param content The content to be used in this flip object * * @ingroup Flip */ @@ -391,10 +401,10 @@ elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) } /** - * Get flip visibility state + * Get flip front visibility state * * @param obj The flip object - * @return If front is showing or not currently + * @return If front front is showing or not currently * * @ingroup Flip */ @@ -407,6 +417,18 @@ elm_flip_front_get(const Evas_Object *obj) return wd->state; } +/** + * Set flip perspective + * + * @param obj The flip object + * @param foc The coordinate to set the focus on + * @param x The X coordinate + * @param y The Y coordinate + * + * NOTE: This function currently does nothing. + * + * @ingroup Flip + */ EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc __UNUSED__, Evas_Coord x __UNUSED__, Evas_Coord y __UNUSED__) { @@ -415,6 +437,19 @@ elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc __UNUSED__, Evas_Coord if (!wd) return; } +/** + * Runs the flip animation + * + * @param obj The flip object + * @param mode The mode type. Currently accepted modes are: + * + * ELM_FLIP_ROTATE_Y_CENTER_AXIS + * ELM_FLIP_ROTATE_X_CENTER_AXIS + * ELM_FLIP_ROTATE_XZ_CENTER_AXIS + * ELM_FLIP_ROTATE_YZ_CENTER_AXIS + * + * @ingroup Flip + */ EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) { diff --git a/src/lib/elm_hover.c b/src/lib/elm_hover.c index 616f9a0..248de3c 100644 --- a/src/lib/elm_hover.c +++ b/src/lib/elm_hover.c @@ -1,6 +1,16 @@ #include #include "elm_priv.h" +/** + * @defgroup Hover Hover + * + * A Hover object will over over the @p Parent object at the @p Target + * location. Anything in the background will be given a darker coloring + * to indicate that the hover object is on top. + * + * NOTE: The hover object will take up the entire space of @p Target object. + */ + typedef struct _Widget_Data Widget_Data; typedef struct _Subinfo Subinfo; @@ -242,6 +252,14 @@ _parent_del(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *e _sizing_eval(data); } +/** + * Adds a hover object to @p parent + * + * @param parent The parent object + * @return The hover object or NULL if one could not be created + * + * @ingroup Hover + */ EAPI Evas_Object * elm_hover_add(Evas_Object *parent) { @@ -294,6 +312,15 @@ elm_hover_add(Evas_Object *parent) return obj; } +/** + * Sets the target object for the hover. + * + * @param obj The hover object + * @param target The object to center the hover onto. The hover + * will take up the entire space that the target object fills. + * + * @ingroup Hover + */ EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) { @@ -313,6 +340,15 @@ elm_hover_target_set(Evas_Object *obj, Evas_Object *target) } } + +/** + * Sets the parent object for the hover. + * + * @param obj The hover object + * @param parent The object to locate the hover over. + * + * @ingroup Hover + */ EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) { @@ -350,6 +386,21 @@ elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) _sizing_eval(obj); } + +/** + * Sets the content of the hover object and the direction in which + * it will pop out. + * + * @param obj The hover object + * @param swallow The direction that the object will display in. Multiple + * objects can have the same swallow location. Objects placed in the same + * swallow will be placed starting at the middle of the hover and ending + * farther from the middle. + * Accepted values are "left" "right" "top" "bottom" "middle" + * @param content The content to place at @p swallow + * + * @ingroup Hover + */ EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) { @@ -381,6 +432,15 @@ elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *conten } } +/** + * Returns the best swallow location for content in the hover. + * + * @param obj The hover object + * @return The edje location to place content into the hover. + * See also elm_hover_content_set() + * + * @ingroup Hover + */ EAPI const char * elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) { diff --git a/src/lib/elm_index.c b/src/lib/elm_index.c index 6d0d478..feaed55 100644 --- a/src/lib/elm_index.c +++ b/src/lib/elm_index.c @@ -4,13 +4,8 @@ /** * @defgroup Index Index * - * XXX - * - * Signals that you can add callbacks for are: - * - * xxx - XXX. - * - * xxx - XXX. + * An index object is a type of list that categorizes items in it + * by letter. */ typedef struct _Widget_Data Widget_Data; @@ -572,7 +567,7 @@ elm_index_active_set(Evas_Object *obj, Eina_Bool active) } /** - * @brief To be documented. + * Sets the level of the item. * * @param obj The index object. * @param level To be documented. @@ -590,7 +585,7 @@ elm_index_item_level_set(Evas_Object *obj, int level) } /** - * @brief To be documented. + * Gets the level of the item. * * @param obj The index object * @@ -606,7 +601,7 @@ elm_index_item_level_get(const Evas_Object *obj) } /** - * @brief To be documented. + * Returns the selected item. * * @param obj The index object. * @param level to be documented. @@ -627,11 +622,11 @@ elm_index_item_selected_get(const Evas_Object *obj, int level) } /** - * @brief To be documented. + * Appends a new item. * * @param obj The index object. - * @param letter to be documented. - * @param item to be documented. + * @param letter Letter under which the item should be indexed + * @param item The item to put in the index * * @ingroup Index */ @@ -649,11 +644,11 @@ elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) } /** - * @brief To be documented. + * Prepends a new item. * * @param obj The index object. - * @param letter to be documented. - * @param item to be documented. + * @param letter Letter under which the item should be indexed + * @param item The item to put in the index * * @ingroup Index */ @@ -672,12 +667,12 @@ elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) } /** - * @brief To be documented. + * Append an item after @p relative in letter @p letter. * * @param obj The index object - * @param letter to be documented. - * @param item to be documented. - * @param relative to be documented. + * @param letter Letter under which the item should be indexed + * @param item The item to put in the index + * @param relative The item to put @p item after * * @ingroup Index */ @@ -706,12 +701,12 @@ elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void } /** - * @brief To be documented. + * Prepend an item before @p relative in letter @p letter. * - * @param obj The index object. - * @param letter to be documented. - * @param item to be documented. - * @param relative to be documented. + * @param obj The index object + * @param letter Letter under which the item should be indexed + * @param item The item to put in the index + * @param relative The item to put @p item before * * @ingroup Index */ @@ -740,10 +735,10 @@ elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void } /** - * @brief To be documented. + * Remove an item from the index. * * @param obj The index object - * @param item To be documented. + * @param item The item to remove from the index * * @ingroup Index */ @@ -761,7 +756,7 @@ elm_index_item_del(Evas_Object *obj, const void *item) } /** - * @brief To be documented. + * Clears an index of its items. * * @param obj The index object. * @@ -785,10 +780,10 @@ elm_index_item_clear(Evas_Object *obj) } /** - * @brief To be documented. + * Go to item at @p level * * @param obj The index object - * @param level To be documented. + * @param level The index level * * @ingroup Index */ diff --git a/src/lib/elm_layout.c b/src/lib/elm_layout.c index e2e596c..a3ed0b5 100644 --- a/src/lib/elm_layout.c +++ b/src/lib/elm_layout.c @@ -277,7 +277,7 @@ elm_layout_edje_get(const Evas_Object *obj) /** * Get the edje layout * - * Manually fors a sizing re-evaluation when contents changed state so that + * Manually forms a sizing re-evaluation when contents changed state so that * minimum size might have changed and needs re-evaluation. Also note that * a standard signal of "size,eval" "elm" emitted by the edje object will * cause this to happen too diff --git a/src/lib/elm_list.c b/src/lib/elm_list.c index 1cfa895..5ce41c9 100644 --- a/src/lib/elm_list.c +++ b/src/lib/elm_list.c @@ -1,6 +1,13 @@ #include #include "elm_priv.h" +/** + * @defgroup List List + * + * A list is a very simple type of list widget. For more robust + * lists, @ref Genlist should probably be used. + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -690,6 +697,14 @@ _freeze_off(void *data __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__ elm_widget_scroll_hold_pop(wd->scr); } +/** + * Adds a list object. + * + * @param parent The parent object + * @return The created object or NULL upon failure + * + * @ingroup List + */ EAPI Evas_Object * elm_list_add(Evas_Object *parent) { @@ -734,6 +749,20 @@ elm_list_add(Evas_Object *parent) return obj; } +/** + * Appends an item to the list object. + * + * @param obj The list object + * @param label The label of the list item + * @param icon The icon object to use for the left side of the item + * @param end The icon object to use for the right side of the item + * @param func The function to call when the item is clicked + * @param data The data to associate with the item for related callbacks + * + * @return The created item or NULL upon failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) { @@ -747,6 +776,20 @@ elm_list_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Eva return it; } +/** + * Prepends an item to the list object. + * + * @param obj The list object + * @param label The label of the list item + * @param icon The icon object to use for the left side of the item + * @param end The icon object to use for the right side of the item + * @param func The function to call when the item is clicked + * @param data The data to associate with the item for related callbacks + * + * @return The created item or NULL upon failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_prepend(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) { @@ -760,6 +803,21 @@ elm_list_item_prepend(Evas_Object *obj, const char *label, Evas_Object *icon, Ev return it; } +/** + * Inserts an item into the list object before @p before. + * + * @param obj The list object + * @param before The list item to insert before + * @param label The label of the list item + * @param icon The icon object to use for the left side of the item + * @param end The icon object to use for the right side of the item + * @param func The function to call when the item is clicked + * @param data The data to associate with the item for related callbacks + * + * @return The created item or NULL upon failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_insert_before(Evas_Object *obj, Elm_List_Item *before, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) { @@ -779,6 +837,21 @@ elm_list_item_insert_before(Evas_Object *obj, Elm_List_Item *before, const char return it; } +/** + * Inserts an item into the list object after @p after. + * + * @param obj The list object + * @param after The list item to insert after + * @param label The label of the list item + * @param icon The icon object to use for the left side of the item + * @param end The icon object to use for the right side of the item + * @param func The function to call when the item is clicked + * @param data The data to associate with the item for related callbacks + * + * @return The created item or NULL upon failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_insert_after(Evas_Object *obj, Elm_List_Item *after, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) { @@ -798,6 +871,13 @@ elm_list_item_insert_after(Evas_Object *obj, Elm_List_Item *after, const char *l return it; } +/** + * Clears a list of all items. + * + * @param obj The list object + * + * @ingroup List + */ EAPI void elm_list_clear(Evas_Object *obj) { @@ -838,6 +918,13 @@ elm_list_clear(Evas_Object *obj) _sizing_eval(obj); } +/** + * Starts the list. Call before running show() on the list object. + * + * @param obj The list object + * + * @ingroup List + */ EAPI void elm_list_go(Evas_Object *obj) { @@ -847,6 +934,14 @@ elm_list_go(Evas_Object *obj) _fix_items(obj); } +/** + * Enables/disables the state of multi-select on the list object. + * + * @param obj The list object + * @param multi If true, multi-select is enabled + * + * @ingroup List + */ EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) { @@ -856,6 +951,14 @@ elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) wd->multi = multi; } +/** + * Gets the state of multi-select on the list object. + * + * @param obj The list object + * @return If true, multi-select is enabled + * + * @ingroup List + */ EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) { @@ -865,6 +968,14 @@ elm_list_multi_select_get(const Evas_Object *obj) return wd->multi; } +/** + * Enables/disables horizontal mode of the list + * + * @param obj The list object + * @param mode If true, horizontale mode is enabled + * + * @ingroup List + */ EAPI void elm_list_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) { @@ -882,6 +993,14 @@ elm_list_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) } } +/** + * Gets the state of horizontal mode of the list + * + * @param obj The list object + * @return If true, horizontale mode is enabled + * + * @ingroup List + */ EAPI Elm_List_Mode elm_list_horizontal_mode_get(const Evas_Object *obj) { @@ -891,6 +1010,15 @@ elm_list_horizontal_mode_get(const Evas_Object *obj) return wd->mode; } +/** + * Enables/disables the state of always_select, meaning that + * an item will always be selected. + * + * @param obj The list object + * @param always_select If true, always_select is enabled + * + * @ingroup List + */ EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) { @@ -900,6 +1028,15 @@ elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) wd->always_select = always_select; } +/** + * Gets the state of always_select. + * See also elm_list_always_select_mode_set() + * + * @param obj The list object + * @return If true, always_select is enabled + * + * @ingroup List + */ EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) { @@ -909,6 +1046,14 @@ elm_list_always_select_mode_get(const Evas_Object *obj) return wd->always_select; } +/** + * Returns a list of all the list items. + * + * @param obj The list object + * @return An Eina_List* of the list items, or NULL on failure + * + * @ingroup List + */ EAPI const Eina_List * elm_list_items_get(const Evas_Object *obj) { @@ -918,6 +1063,14 @@ elm_list_items_get(const Evas_Object *obj) return wd->items; } +/** + * Returns the currently selected list item. + * + * @param obj The list object + * @return The selected list item, or NULL on failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_selected_item_get(const Evas_Object *obj) { @@ -928,6 +1081,14 @@ elm_list_selected_item_get(const Evas_Object *obj) return NULL; } +/** + * Returns a list of the currently selected list items. + * + * @param obj The list object + * @return An Eina_List* of the selected list items, or NULL on failure + * + * @ingroup List + */ EAPI const Eina_List * elm_list_selected_items_get(const Evas_Object *obj) { @@ -937,6 +1098,14 @@ elm_list_selected_items_get(const Evas_Object *obj) return wd->selected; } +/** + * Sets the selected state of @p it. + * + * @param it The list item + * @param selected Enables/disables the selected state + * + * @ingroup List + */ EAPI void elm_list_item_selected_set(Elm_List_Item *it, Eina_Bool selected) { @@ -964,6 +1133,14 @@ elm_list_item_selected_set(Elm_List_Item *it, Eina_Bool selected) _elm_list_unwalk(wd); } +/** + * Gets the selected state of @p it. + * + * @param it The list item + * @return If true, the item is selected + * + * @ingroup List + */ EAPI Eina_Bool elm_list_item_selected_get(Elm_List_Item *it) { @@ -971,6 +1148,13 @@ elm_list_item_selected_get(Elm_List_Item *it) return it->selected; } +/** + * Brings @p it to the center of the list view. + * + * @param it The list item + * + * @ingroup List + */ EAPI void elm_list_item_show(Elm_List_Item *it) { @@ -987,6 +1171,13 @@ elm_list_item_show(Elm_List_Item *it) elm_scroller_region_show(wd->scr, x, y, w, h); } +/** + * Deletes item @p it from the list. + * + * @param it The list item to delete + * + * @ingroup List + */ EAPI void elm_list_item_del(Elm_List_Item *it) { @@ -1029,6 +1220,14 @@ elm_list_item_del_cb_set(Elm_List_Item *it, Evas_Smart_Cb func) it->del_cb = func; } +/** + * Returns the data associated with the item. + * + * @param it The list item + * @return The data associated with @p it + * + * @ingroup List + */ EAPI void * elm_list_item_data_get(const Elm_List_Item *it) { @@ -1036,6 +1235,14 @@ elm_list_item_data_get(const Elm_List_Item *it) return (void *)it->data; } +/** + * Returns the left side icon associated with the item. + * + * @param it The list item + * @return The left side icon associated with @p it + * + * @ingroup List + */ EAPI Evas_Object * elm_list_item_icon_get(const Elm_List_Item *it) { @@ -1044,6 +1251,14 @@ elm_list_item_icon_get(const Elm_List_Item *it) return it->icon; } +/** + * Sets the left side icon associated with the item. + * + * @param it The list item + * @param icon The left side icon object to associate with @p it + * + * @ingroup List + */ EAPI void elm_list_item_icon_set(Elm_List_Item *it, Evas_Object *icon) { @@ -1062,6 +1277,14 @@ elm_list_item_icon_set(Elm_List_Item *it, Evas_Object *icon) edje_object_part_swallow(it->base, "elm.swallow.icon", icon); } +/** + * Gets the right side icon associated with the item. + * + * @param it The list item + * @return The right side icon object associated with @p it + * + * @ingroup List + */ EAPI Evas_Object * elm_list_item_end_get(const Elm_List_Item *it) { @@ -1070,6 +1293,14 @@ elm_list_item_end_get(const Elm_List_Item *it) return it->end; } +/** + * Gets the right side icon associated with the item. + * + * @param it The list item + * @param icon The right side icon object to associate with @p it + * + * @ingroup List + */ EAPI void elm_list_item_end_set(Elm_List_Item *it, Evas_Object *end) { @@ -1088,6 +1319,14 @@ elm_list_item_end_set(Elm_List_Item *it, Evas_Object *end) edje_object_part_swallow(it->base, "elm.swallow.end", end); } +/** + * Gets the base object of the item. + * + * @param it The list item + * @return The base object associated with @p it + * + * @ingroup List + */ EAPI Evas_Object * elm_list_item_base_get(const Elm_List_Item *it) { @@ -1095,6 +1334,14 @@ elm_list_item_base_get(const Elm_List_Item *it) return it->base; } +/** + * Gets the label of the item. + * + * @param it The list item + * @return The label of @p it + * + * @ingroup List + */ EAPI const char * elm_list_item_label_get(const Elm_List_Item *it) { @@ -1102,6 +1349,14 @@ elm_list_item_label_get(const Elm_List_Item *it) return it->label; } +/** + * Sets the label of the item. + * + * @param it The list item + * @param text The label of @p it + * + * @ingroup List + */ EAPI void elm_list_item_label_set(Elm_List_Item *it, const char *text) { @@ -1111,6 +1366,14 @@ elm_list_item_label_set(Elm_List_Item *it, const char *text) edje_object_part_text_set(it->base, "elm.text", it->label); } +/** + * Gets the item before @p it in the list. + * + * @param it The list item + * @return The item before @p it, or NULL on failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_prev(const Elm_List_Item *it) { @@ -1119,6 +1382,14 @@ elm_list_item_prev(const Elm_List_Item *it) else return NULL; } +/** + * Gets the item after @p it in the list. + * + * @param it The list item + * @return The item after @p it, or NULL on failure + * + * @ingroup List + */ EAPI Elm_List_Item * elm_list_item_next(const Elm_List_Item *it) { diff --git a/src/lib/elm_map.c b/src/lib/elm_map.c index 61f5807..b6e54bc 100644 --- a/src/lib/elm_map.c +++ b/src/lib/elm_map.c @@ -2012,6 +2012,15 @@ elm_map_zoom_mode_get(const Evas_Object *obj) return wd->mode; } +/** + * Centers the map at @p lon @p lat using an animation to scroll. + * + * @param obj The map object + * @param lon Longitude to center at + * @param lon Latitude to center at + * + * @ingroup Map + */ EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) { @@ -2045,7 +2054,7 @@ elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) /** * Move the map to the current coordinates. * - * This move the map to the current coordinates. The map will be centred on these coordinates. + * This move the map to the current coordinates. The map will be centered on these coordinates. * * @param obj The map object * @param lat The latitude. @@ -2085,7 +2094,7 @@ elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) /** * Move the map to the current coordinates. * - * This move the map to the current coordinates. The map will be centred on these coordinates. + * This move the map to the current coordinates. The map will be centered on these coordinates. * * @param obj The map object * @param lat The latitude. @@ -2118,6 +2127,8 @@ elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) * * @param obj The map object * @param paused The pause state to set + * + * @ingroup Map */ EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) @@ -2148,6 +2159,8 @@ elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) * * @param obj The map object * @param paused The pause state to set + * + * @ingroup Map */ EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) @@ -2166,6 +2179,8 @@ elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) * * @param obj The map object * @return The current paused state + * + * @ingroup Map */ EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) @@ -2183,6 +2198,8 @@ elm_map_paused_get(const Evas_Object *obj) * * @param obj The map object * @return The current paused state + * + * @ingroup Map */ EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) @@ -2194,8 +2211,6 @@ elm_map_paused_markers_get(const Evas_Object *obj) } /** - * Convert a pixel coordinate into a geographic coordinate. - * * Convert a pixel coordinate (x,y) into a geographic coordinate (longitude, latitude). * * @param obj The map object @@ -2204,6 +2219,8 @@ elm_map_paused_markers_get(const Evas_Object *obj) * @param size the size in pixels of the map. The map is a square and generally his size is : pow(2.0, zoom)*256. * @param lon the longitude correspond to x * @param lat the latitude correspond to y + * + * @ingroup Map */ EAPI void elm_map_utils_convert_coord_into_geo(int x, int y, int size, double *lon, double *lat) @@ -2220,8 +2237,6 @@ elm_map_utils_convert_coord_into_geo(int x, int y, int size, double *lon, double } /** - * Convert a geographic coordinate into a pixel coordinate. - * * Convert a geographic coordinate (longitude, latitude) into a pixel coordinate (x, y). * * @param obj The map object @@ -2230,6 +2245,8 @@ elm_map_utils_convert_coord_into_geo(int x, int y, int size, double *lon, double * @param size the size in pixels of the map. The map is a square and generally his size is : pow(2.0, zoom)*256. * @param x the coordinate correspond to the longitude * @param y the coordinate correspond to the latitude + * + * @ingroup Map */ EAPI void elm_map_utils_convert_geo_into_coord(double lon, double lat, int size, int *x, int *y) @@ -2245,13 +2262,15 @@ elm_map_utils_convert_geo_into_coord(double lon, double lat, int size, int *x, i /** * Add a marker on the map * - * Add a marker on the map - * * @param obj The map object * @param lon the longitude * @param lat the latitude * @param clas the class to use * @param data the data passed to the callbacks + * + * @return The marker object + * + * @ingroup Map */ EAPI Elm_Map_Marker * elm_map_marker_add(Evas_Object *obj, double lon, double lat, Elm_Map_Marker_Class *clas, Elm_Map_Group_Class *clas_group, void *data) @@ -2430,9 +2449,9 @@ elm_map_marker_add(Evas_Object *obj, double lon, double lat, Elm_Map_Marker_Clas /** * Remove a marker from the map * - * Remove a marker from the map - * * @param marker The marker to remove + * + * @ingroup Map */ EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) @@ -2495,11 +2514,11 @@ elm_map_marker_remove(Elm_Map_Marker *marker) } /** - * Bring in the marker to the center - * * Move the map to the coordinate of the marker. * * @param marker The marker where the map will be center. + * + * @ingroup Map */ EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) @@ -2510,11 +2529,11 @@ elm_map_marker_bring_in(Elm_Map_Marker *marker) /** - * Show the marker to the center - * * Move the map to the coordinate of the marker. * * @param marker The marker where the map will be center. + * + * @ingroup Map */ EAPI void elm_map_marker_show(Elm_Map_Marker *marker) @@ -2523,12 +2542,16 @@ elm_map_marker_show(Elm_Map_Marker *marker) elm_map_geo_region_show(marker->wd->obj, marker->longitude, marker->latitude); } -/* - * Move and zoom the map to display a list of marker. +/** + * Move and zoom the map to display a list of markers. * - * The map will be center on the center point of the markers in the list. Then the map will be zoom in order to fit the markers, the maximum zoom which allows to display all the markers is used. + * The map will be centered on the center point of the markers in the list. Then + * the map will be zoomed in order to fit the markers using the maximum zoom which + * allows display of all the markers. * * @param markers The list of markers (list of Elm_Map_Marker *) + * + * @ingroup Map */ EAPI void elm_map_markers_list_show(Eina_List *markers) @@ -2579,13 +2602,17 @@ elm_map_markers_list_show(Eina_List *markers) elm_map_zoom_set(wd->obj, zoom); } -/* +/** * Set the maximum numbers of markers display in a group. * - * A group can have a long list of markers, consequently the creation of the content of the bubble can be very slow. In order to avoid this, a maximum number of items is displayed in a bubble. By default this number is 30. + * A group can have a long list of markers, consequently the creation of the content + * of the bubble can be very slow. In order to avoid this, a maximum number of items + * is displayed in a bubble. By default this number is 30. * * @param obj The map object. * @param max The maximum numbers of items displayed in a bubble. + * + * @ingroup Map */ EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) @@ -2596,11 +2623,13 @@ elm_map_max_marker_per_group_set(Evas_Object *obj, int max) wd->markers_max_num = max; } -/* +/** * Return the evas object getting from the ElmMapMarkerGetFunc callback * * @param marker The marker. * @return Return the evas object if it exists, else NULL. + * + * @ingroup Map */ EAPI Evas_Object * elm_map_marker_object_get(Elm_Map_Marker *marker) @@ -2609,10 +2638,12 @@ elm_map_marker_object_get(Elm_Map_Marker *marker) return marker->content; } -/* +/** * Update the marker * * @param marker The marker. + * + * @ingroup Map */ EAPI void elm_map_marker_update(Elm_Map_Marker *marker) @@ -2629,11 +2660,12 @@ elm_map_marker_update(Elm_Map_Marker *marker) } } -/* - * +/** * Close all opened bubbles * * @param obj The map object + * + * @ingroup Map */ EAPI void elm_map_bubbles_close(Evas_Object *obj) @@ -2648,8 +2680,7 @@ elm_map_bubbles_close(Evas_Object *obj) } -/* - * +/** * Create a group class. * * Each marker must be associated to a group class. Marker with the same group are grouped if they are close. @@ -2657,6 +2688,8 @@ elm_map_bubbles_close(Evas_Object *obj) * * @param obj The map object * @return Returns the new group class + * + * @ingroup Map */ EAPI Elm_Map_Group_Class * elm_map_group_class_new(Evas_Object *obj) @@ -2670,12 +2703,13 @@ elm_map_group_class_new(Evas_Object *obj) return clas; } -/* - * +/** * Set the style of a group class (radio, radio2 or empty) * * @param clas the group class * @param style the new style + * + * @ingroup Map */ EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) @@ -2684,14 +2718,15 @@ elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) eina_stringshare_replace(&clas->style, style); } -/* - * +/** * Set the icon callback of a group class. * * A custom icon can be displayed in a marker. The function @ref icon_get must return this icon. * * @param clas the group class * @param icon_get the callback to create the icon + * + * @ingroup Map */ EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) @@ -2700,12 +2735,13 @@ elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFun clas->func.icon_get = icon_get; } -/* - * +/** * Set the data associated to the group class (radio, radio2 or empty) * * @param clas the group class * @param data the new user data + * + * @ingroup Map */ EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) @@ -2714,14 +2750,15 @@ elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) clas->data = data; } -/* - * +/** * Set the zoom from where the markers are displayed. * * Markers will not be displayed for a zoom less than @ref zoom * * @param clas the group class * @param zoom the zoom + * + * @ingroup Map */ EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) @@ -2730,11 +2767,13 @@ elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) clas->zoom_displayed = zoom; } -/* +/** * Set the zoom from where the markers are no more grouped. * * @param clas the group class * @param zoom the zoom + * + * @ingroup Map */ EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) @@ -2743,12 +2782,14 @@ elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) clas->zoom_grouped = zoom; } -/* +/** * Set if the markers associated to the group class @clas are hidden or not. * If @ref hide is true the markers will be hidden. * * @param clas the group class * @param hide if true the markers will be hidden, else they will be displayed. + * + * @ingroup Map */ EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) @@ -2768,8 +2809,7 @@ elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_B } -/* - * +/** * Create a marker class. * * Each marker must be associated to a class. @@ -2777,6 +2817,8 @@ elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_B * * @param obj The map object * @return Returns the new class + * + * @ingroup Map */ EAPI Elm_Map_Marker_Class * elm_map_marker_class_new(Evas_Object *obj) @@ -2789,12 +2831,13 @@ elm_map_marker_class_new(Evas_Object *obj) return clas; } -/* - * +/** * Set the style of a class (radio, radio2 or empty) * * @param clas the group class * @param style the new style + * + * @ingroup Map */ EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) @@ -2803,14 +2846,15 @@ elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) eina_stringshare_replace(&clas->style, style); } -/* - * +/** * Set the icon callback of a class. * * A custom icon can be displayed in a marker. The function @ref icon_get must return this icon. * * @param clas the group class * @param icon_get the callback to create the icon + * + * @ingroup Map */ EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) @@ -2819,7 +2863,7 @@ elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGet clas->func.icon_get = icon_get; } -/* +/** * * Set the callback of the content of the bubble. * @@ -2828,6 +2872,8 @@ elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGet * * @param clas the group class * @param get the callback to create the content + * + * @ingroup Map */ EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) @@ -2836,8 +2882,7 @@ elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc clas->func.get = get; } -/* - * +/** * Set the callback of the content of delete the object created by the callback "get". * * If this callback is defined the user will have to delete (or not) the object inside. @@ -2845,6 +2890,8 @@ elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc * * @param clas the group class * @param del the callback to delete the content + * + * @ingroup Map */ EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) @@ -2853,8 +2900,7 @@ elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc clas->func.del = del; } -/* - * +/** * Set the source of the map. * * Elm_Map retrieves the image which composed the map from a web service. This web service can @@ -2863,6 +2909,8 @@ elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc * * @param clas the group class * @param source the new source + * + * @ingroup Map */ EAPI void elm_map_source_set(Evas_Object *obj, Elm_Map_Sources source) @@ -2889,12 +2937,13 @@ elm_map_source_set(Evas_Object *obj, Elm_Map_Sources source) elm_map_zoom_set(obj, zoom); } -/* - * +/** * Get the current source * * @param obj the map object * @return Returns the maximum zoom of the source + * + * @ingroup Map */ EAPI Elm_Map_Sources elm_map_source_get(const Evas_Object *obj) @@ -2905,8 +2954,7 @@ elm_map_source_get(const Evas_Object *obj) return wd->source; } -/* - * +/** * Set the API of a custom source. * * A custom web service can be associated to the source ELM_MAP_SOURCE_CUSTOM_(1..7). @@ -2916,6 +2964,8 @@ elm_map_source_get(const Evas_Object *obj) * @param zoom_min the minimum zoom of the source, must be >= 0 * @param zoom_max the maximum zoom of the source, must be <= ZOOM_MAX * @param url_cb the callback used to create the url from where a tile (png or jpeg file) is downloaded. + * + * @ingroup Map */ EAPI void elm_map_source_custom_api_set(Elm_Map_Sources source, const char *name, int zoom_min, int zoom_max, ElmMapSourceURLFunc url_cb) @@ -2927,12 +2977,13 @@ elm_map_source_custom_api_set(Elm_Map_Sources source, const char *name, int zoom map_sources_tab[source].url_cb = url_cb; } -/* - * +/** * Get the maximum zoom of the source. * * @param source the source * @return Returns the maximum zoom of the source + * + * @ingroup Map */ EAPI int elm_map_source_zoom_max_get(Elm_Map_Sources source) @@ -2940,12 +2991,13 @@ elm_map_source_zoom_max_get(Elm_Map_Sources source) return map_sources_tab[source].zoom_max; } -/* - * +/** * Get the minimum zoom of the source. * * @param source the source * @return Returns the minimum zoom of the source + * + * @ingroup Map */ EAPI int elm_map_source_zoom_min_get(Elm_Map_Sources source) @@ -2953,12 +3005,13 @@ elm_map_source_zoom_min_get(Elm_Map_Sources source) return map_sources_tab[source].zoom_min; } -/* - * +/** * Get the name of a source. * * @param source the source * @return Returns the name of the source + * + * @ingroup Map */ EAPI const char * elm_map_source_name_get(Elm_Map_Sources source) diff --git a/src/lib/elm_mapbuf.c b/src/lib/elm_mapbuf.c index 6e3bb38..023c4ae 100644 --- a/src/lib/elm_mapbuf.c +++ b/src/lib/elm_mapbuf.c @@ -205,6 +205,14 @@ elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) _configure(obj); } +/** + * Set the mapbuf enabled state + * + * @param obj The mapbuf object + * @param enabled The value to set the enabled state to + * + * @ingroup Mapbuf + */ EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) { @@ -215,7 +223,15 @@ elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) wd->enabled = enabled; _configure(obj); } - + +/** + * Get the mapbuf enabled state + * + * @param obj The mapbuf object + * @return The value that the enabled state is set to + * + * @ingroup Mapbuf + */ EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) { @@ -224,7 +240,15 @@ elm_mapbuf_enabled_get(const Evas_Object *obj) if (!wd) return EINA_FALSE; return wd->enabled; } - + +/** + * Sets the mapbuf smooth state + * + * @param obj The mapbuf object + * @param smooth The value of the smooth state of @p obj + * + * @ingroup Mapbuf + */ EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) { @@ -235,7 +259,15 @@ elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) wd->smooth = smooth; _configure(obj); } - + +/** + * Gets the mapbuf smooth state + * + * @param obj The mapbuf object + * @return The value of the smooth state of @p obj + * + * @ingroup Mapbuf + */ EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) { @@ -244,7 +276,15 @@ elm_mapbuf_smooth_get(const Evas_Object *obj) if (!wd) return EINA_FALSE; return wd->smooth; } - + +/** + * Enables/disables the mapbuf alpha channel + * + * @param obj The mapbuf object + * @param alpha The state of the alpha channel + * + * @ingroup Mapbuf + */ EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) { @@ -255,7 +295,15 @@ elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) wd->alpha = alpha; _configure(obj); } - + +/** + * Gets the state of the mapbuf alpha channel + * + * @param obj The mapbuf object + * @return The state of the alpha channel + * + * @ingroup Mapbuf + */ EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) { diff --git a/src/lib/elm_menu.c b/src/lib/elm_menu.c index 5c1d3fe..f220a7e 100644 --- a/src/lib/elm_menu.c +++ b/src/lib/elm_menu.c @@ -7,8 +7,9 @@ /** * @defgroup Menu Menu * - * A menu is a list of items display on top of the window. Each item can have a sub-menu. It can be used to - * display a menu on right click, in a toolbar ... + * A menu is a list of items displayed above the window. Each item can + * have a sub-menu. The menu object can be used to display a menu on right + * click, in a toolbar, anywhere. * */ @@ -441,7 +442,7 @@ elm_menu_add(Evas_Object *parent) return obj; } -/* +/** * Set the parent * * @param obj The menu object. @@ -475,7 +476,7 @@ elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) _sizing_eval(obj); } -/* +/** * Move the menu to a new position * * @param obj The menu object. @@ -495,7 +496,7 @@ elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) _sizing_eval(obj); } -/* +/** * Get the Evas_Object of an Elm_Menu_Item * * @param it The menu item object. @@ -508,7 +509,7 @@ elm_menu_object_get(const Elm_Menu_Item *it) return it->o; } -/* +/** * Add an item at the end * * @param obj The menu object. @@ -555,6 +556,14 @@ elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *icon, co return subitem; } +/** + * Set the label of a menu item + * + * @param it The menu item object. + * @param label The label to set for @p item + * + * @ingroup Menu + */ EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) { @@ -570,6 +579,14 @@ elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) _sizing_eval(item->menu); } +/** + * Get the label of a menu item + * + * @param it The menu item object. + * @return The label of @p item + * + * @ingroup Menu + */ EAPI const char * elm_menu_item_label_get(Elm_Menu_Item *item) { @@ -577,6 +594,14 @@ elm_menu_item_label_get(Elm_Menu_Item *item) return item->label; } +/** + * Set the icon of a menu item + * + * @param it The menu item object. + * @param icon The icon object to set for @p item + * + * @ingroup Menu + */ EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, Evas_Object *icon) { @@ -597,6 +622,15 @@ elm_menu_item_icon_set(Elm_Menu_Item *item, Evas_Object *icon) item->icon = icon; } + +/** + * Set the disabled state of @p item. + * + * @param it The menu item object. + * @param disabled The enabled/disabled state of the item + * + * @ingroup Menu + */ EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) { @@ -612,6 +646,17 @@ elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) edje_object_message_signal_process(item->o); } + +/** + * Add a separator item to menu @p obj under @p parent. + * + * @param obj The menu object + * @param parent The item to add the separator under + * + * @return The created item or NULL on failure + * + * @ingroup Menu + */ EAPI Elm_Menu_Item * elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) { @@ -639,6 +684,15 @@ elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) return subitem; } + +/** + * Deletes an item from the menu. + * + * @param item The item to delete + * + * @ingroup Menu + */ + EAPI void elm_menu_item_del(Elm_Menu_Item *item) { @@ -680,6 +734,14 @@ elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) it->del_cb = func; } +/** + * Returns the data associated with menu item @p it. + * + * @param it The item + * @return The data associated with @p it + * + * @ingroup Menu + */ EAPI void * elm_menu_item_data_get(const Elm_Menu_Item *it) { @@ -687,6 +749,14 @@ elm_menu_item_data_get(const Elm_Menu_Item *it) return (void *)it->data; } +/** + * Sets the data to be associated with menu item @p it. + * + * @param item The item + * @param data The data to be associated with @p item + * + * @ingroup Menu + */ EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) { @@ -694,6 +764,14 @@ elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) item->data = data; } +/** + * Returns a list of @p item's subitems. + * + * @param it The item + * @return An Eina_List* of @p item's subitems + * + * @ingroup Menu + */ EAPI const Eina_List * elm_menu_item_subitems_get(Elm_Menu_Item *item) { diff --git a/src/lib/elm_panel.c b/src/lib/elm_panel.c index 778f85c..79cf4a8 100644 --- a/src/lib/elm_panel.c +++ b/src/lib/elm_panel.c @@ -1,6 +1,22 @@ #include #include "elm_priv.h" +/** + * @defgroup Panel Panel + * + * A panel is a type of animated container that contains subobjects. It + * can be expanded or contracted. + * + * Orientations are as follows: + * ELM_PANEL_ORIENT_TOP + * ELM_PANEL_ORIENT_BOTTOM + * ELM_PANEL_ORIENT_LEFT + * ELM_PANEL_ORIENT_RIGHT + * NOTE: Only LEFT orientation is implemented. + * + * THIS WIDGET IS UNDER CONSTRUCTION! + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data { @@ -105,6 +121,15 @@ _toggle_panel(void *data, Evas_Object *obj __UNUSED__, const char *emission __UN } } +/** + * Adds a panel object + * + * @param parent The parent object + * + * @return The panel object, or NULL on failure + * + * @ingroup Panel + */ EAPI Evas_Object * elm_panel_add(Evas_Object *parent) { @@ -150,6 +175,20 @@ elm_panel_add(Evas_Object *parent) return obj; } +/** + * Sets the orientation of the panel + * + * @param parent The parent object + * @param orient The panel orientation. Can be one of the following: + * ELM_PANEL_ORIENT_TOP + * ELM_PANEL_ORIENT_BOTTOM + * ELM_PANEL_ORIENT_LEFT + * ELM_PANEL_ORIENT_RIGHT + * + * NOTE: Currently all orientations but LEFT are unimplemented. + * + * @ingroup Panel + */ EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) { @@ -172,6 +211,15 @@ elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) _sizing_eval(obj); } + +/** + * Set the content of the panel. + * + * @param obj The panel object + * @param content The panel content + * + * @ingroup Panel + */ EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) { diff --git a/src/lib/elm_photocam.c b/src/lib/elm_photocam.c index ac89843..b5f1588 100644 --- a/src/lib/elm_photocam.c +++ b/src/lib/elm_photocam.c @@ -1566,6 +1566,8 @@ elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h * * @param obj The photocam object * @param paused The pause state to set + * + * @ingroup Photocam */ EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) @@ -1594,6 +1596,8 @@ elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) * * @param obj The photocam object * @return The current paused state + * + * @ingroup Photocam */ EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) @@ -1613,6 +1617,8 @@ elm_photocam_paused_get(const Evas_Object *obj) * * @param obj The photocam object * @return The internal image object handle, or NULL if none exists + * + * @ingroup Photocam */ EAPI Evas_Object * elm_photocam_internal_image_get(const Evas_Object *obj) diff --git a/src/lib/elm_separator.c b/src/lib/elm_separator.c index 9c81ad3..f9f927d 100644 --- a/src/lib/elm_separator.c +++ b/src/lib/elm_separator.c @@ -1,6 +1,13 @@ #include #include "elm_priv.h" +/** + * @defgroup Separator Separator + * + * A separator is a widget that adds a very thin object to separate other objects. + * A separator can be vertical or horizontal. + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -47,6 +54,15 @@ _sizing_eval(Evas_Object *obj) evas_object_size_hint_align_set(obj, maxw, maxh); } +/** + * Add a separator object to @p parent + * + * @param parent The parent object + * + * @return The separator object, or NULL upon failure + * + * @ingroup Separator + */ EAPI Evas_Object * elm_separator_add(Evas_Object *parent) { @@ -73,6 +89,14 @@ elm_separator_add(Evas_Object *parent) return obj; } +/** + * Set the horizontal mode of a separator object + * + * @param obj The separator object + * @param horizontal If true, the separator is horizontal + * + * @ingroup Separator + */ EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) { @@ -85,6 +109,14 @@ elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) _theme_hook(obj); } +/** + * Get the horizontal mode of a separator object + * + * @param obj The separator object + * @return If true, the separator is horizontal + * + * @ingroup Separator + */ EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) { diff --git a/src/lib/elm_slideshow.c b/src/lib/elm_slideshow.c index 4ba6ccc..0e18d59 100644 --- a/src/lib/elm_slideshow.c +++ b/src/lib/elm_slideshow.c @@ -12,7 +12,11 @@ * consequently new animations can be added without having to update the * applications. * - * The slideshow use 2 callbacks to create and delete the objects displayed. When an item is displayed the function itc->func.get() is called. This function should create the object, for example the object can be an evas_object_image or a photocam. When a object is no more displayed the function itc->func.del() is called, the user can delete or hide the object here. If itc->func.del is NULL the slideshow delete the object with evas_object_del(). + * The slideshow use 2 callbacks to create and delete the objects displayed. When an item + * is displayed the function itc->func.get() is called. This function should create the object, + * for example the object can be an evas_object_image or a photocam. When a object is no more + * displayed the function itc->func.del() is called, the user can delete or hide the object here. + * If itc->func.del is NULL the slideshow delete the object with evas_object_del(). */ typedef struct _Widget_Data Widget_Data; @@ -252,6 +256,8 @@ elm_slideshow_add(Evas_Object *parent) * @aram itc Callbacks used to create/delete the object. If itc->del.del is NULL, the object will be destroyed with evas_object_del() * @param data Data used by the user to identified the item * @return Returns The slideshow item + * + * @ingroup Slideshow */ EAPI Elm_Slideshow_Item* elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) @@ -279,6 +285,8 @@ elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, co * * @param obj The slideshow object * @param item The item + * + * @ingroup Slideshow */ EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) @@ -300,6 +308,8 @@ elm_slideshow_show(Elm_Slideshow_Item *item) * Go to the next item * * @param obj The slideshow object + * + * @ingroup Slideshow */ EAPI void elm_slideshow_next(Evas_Object *obj) @@ -343,6 +353,8 @@ elm_slideshow_next(Evas_Object *obj) * Go to the previous item * * @param obj The slideshow object + * + * @ingroup Slideshow */ EAPI void elm_slideshow_previous(Evas_Object *obj) @@ -387,6 +399,8 @@ elm_slideshow_previous(Evas_Object *obj) * * @param obj The slideshow object * @return Returns the list of transitions (list of char*) + * + * @ingroup Slideshow */ const Eina_List * elm_slideshow_transitions_get(const Evas_Object *obj) @@ -402,6 +416,8 @@ elm_slideshow_transitions_get(const Evas_Object *obj) * * @param obj The slideshow object * @param transition the new transition + * + * @ingroup Slideshow */ EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) @@ -417,6 +433,8 @@ elm_slideshow_transition_set(Evas_Object *obj, const char *transition) * * @param obj The slideshow object * @return the transition set + * + * @ingroup Slideshow */ EAPI const char * elm_slideshow_transition_get(const Evas_Object *obj) @@ -433,6 +451,8 @@ elm_slideshow_transition_get(const Evas_Object *obj) * * @param obj The slideshow object * @param timeout The new timeout + * + * @ingroup Slideshow */ EAPI void elm_slideshow_timeout_set(Evas_Object *obj ,int timeout) @@ -452,6 +472,8 @@ elm_slideshow_timeout_set(Evas_Object *obj ,int timeout) * * @param obj The slideshow object * @return Returns the timeout + * + * @ingroup Slideshow */ EAPI int elm_slideshow_timeout_get(const Evas_Object *obj) @@ -467,6 +489,8 @@ elm_slideshow_timeout_get(const Evas_Object *obj) * * @param obj The slideshow object * @param loop if EINA_TRUE, the first item will follow the last and vice versa + * + * @ingroup Slideshow */ EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) @@ -482,6 +506,8 @@ elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) * * @param obj The slideshow object * @returns Returns the loop flag + * + * @ingroup Slideshow */ EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) @@ -496,6 +522,8 @@ elm_slideshow_loop_get(const Evas_Object *obj) * Delete all the items * * @param obj The slideshow object + * + * @ingroup Slideshow */ EAPI void elm_slideshow_clear(Evas_Object *obj) @@ -525,6 +553,8 @@ elm_slideshow_clear(Evas_Object *obj) * Delete the item * * @param item The slideshow item + * + * @ingroup Slideshow */ EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) @@ -558,6 +588,8 @@ elm_slideshow_item_del(Elm_Slideshow_Item *item) * Returns the list of items * @param obj The slideshow object * @return Returns the list of items (list of Elm_Slideshow_Item). + * + * @ingroup Slideshow */ EAPI const Eina_List * elm_slideshow_items_get(const Evas_Object *obj) @@ -574,6 +606,8 @@ elm_slideshow_items_get(const Evas_Object *obj) * * @param obj The slideshow object * @return Returns the current item displayed + * + * @ingroup Slideshow */ EAPI Elm_Slideshow_Item * elm_slideshow_item_current_get(const Evas_Object *obj) @@ -589,6 +623,8 @@ elm_slideshow_item_current_get(const Evas_Object *obj) * * @param item The slideshow item * @return Returns the evas object associated to this item + * + * @ingroup Slideshow */ EAPI Evas_Object * elm_slideshow_item_object_get(Elm_Slideshow_Item * item) @@ -602,6 +638,8 @@ elm_slideshow_item_object_get(Elm_Slideshow_Item * item) * * @param item The slideshow item * @return Returns the data associated to this item + * + * @ingroup Slideshow */ EAPI void * elm_slideshow_item_data_get(Elm_Slideshow_Item * item) diff --git a/src/lib/elm_theme.c b/src/lib/elm_theme.c index 84eaa4e..5d35e55 100644 --- a/src/lib/elm_theme.c +++ b/src/lib/elm_theme.c @@ -1,6 +1,12 @@ #include #include "elm_priv.h" +/** + * @defgroup Theme + * + * Functions to modify the theme in the currently running app. + */ + static Eina_List *overlay = NULL; static Eina_List *themes = NULL; static Eina_List *extension = NULL; @@ -78,6 +84,13 @@ _elm_theme_group_file_find(const char *group) return NULL; } +/** + * Prepends a theme overlay to the list of overlays + * + * @param item The name of the theme overlay + * + * @ingroup Theme + */ EAPI void elm_theme_overlay_add(const char *item) { @@ -87,6 +100,13 @@ elm_theme_overlay_add(const char *item) elm_theme_flush(); } +/** + * Delete a theme overlay from the list of overlays + * + * @param item The name of the theme overlay + * + * @ingroup Theme + */ EAPI void elm_theme_overlay_del(const char *item) { @@ -105,6 +125,13 @@ elm_theme_overlay_del(const char *item) elm_theme_flush(); } +/** + * Prepends a theme extension to the list of extensions. + * + * @param item The name of the theme extension + * + * @ingroup Theme + */ EAPI void elm_theme_extension_add(const char *item) { @@ -114,6 +141,13 @@ elm_theme_extension_add(const char *item) elm_theme_flush(); } +/** + * Deletes a theme extension from the list of extensions. + * + * @param item The name of the theme extension + * + * @ingroup Theme + */ EAPI void elm_theme_extension_del(const char *item) { @@ -132,6 +166,11 @@ elm_theme_extension_del(const char *item) elm_theme_flush(); } +/** + * Flush the current theme. + * + * @ingroup Theme + */ EAPI void elm_theme_flush(void) { @@ -140,6 +179,13 @@ elm_theme_flush(void) _elm_win_rescale(); } +/** + * Set the theme in the current app to theme @p theme + * + * @param theme The name of the theme to use + * + * @ingroup Theme + */ EAPI void elm_theme_all_set(const char *theme) { diff --git a/src/lib/elm_toggle.c b/src/lib/elm_toggle.c index cc19b3d..d91dfd4 100644 --- a/src/lib/elm_toggle.c +++ b/src/lib/elm_toggle.c @@ -1,6 +1,19 @@ #include #include "elm_priv.h" +/** + * @defgroup Toggle + * + * A toggle is a slider which can be used to toggle between + * two values. It has two states: on and off. + * + * Signals that you can add callbacks for are: + * + * changed - Whenever the toggle value has been changed. Is not called + * until the toggle is released by the cursor (assuming it has been triggered + * by the cursor in the first place). + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -136,6 +149,15 @@ _signal_toggle_on(void *data, Evas_Object *obj __UNUSED__, const char *emission evas_object_smart_callback_call(data, SIG_CHANGED, NULL); } +/** + * Add a toggle to @p parent. + * + * @param parent The parent object + * + * @return The toggle object + * + * @ingroup Toggle + */ EAPI Evas_Object * elm_toggle_add(Evas_Object *parent) { @@ -176,6 +198,14 @@ elm_toggle_add(Evas_Object *parent) return obj; } +/** + * Sets the label to be displayed with the toggle. + * + * @param obj The toggle object + * @param label The label to be displayed + * + * @ingroup Toggle + */ EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) { @@ -192,6 +222,14 @@ elm_toggle_label_set(Evas_Object *obj, const char *label) _sizing_eval(obj); } +/** + * Gets the label of the toggle + * + * @param obj The toggle object + * @return The label of the toggle + * + * @ingroup Toggle + */ EAPI const char * elm_toggle_label_get(const Evas_Object *obj) { @@ -201,6 +239,14 @@ elm_toggle_label_get(const Evas_Object *obj) return wd->label; } +/** + * Sets the icon to be displayed with the toggle. + * + * @param obj The toggle object + * @param icon The icon object to be displayed + * + * @ingroup Toggle + */ EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) { @@ -219,6 +265,14 @@ elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) _sizing_eval(obj); } +/** + * Gets the icon of the toggle + * + * @param obj The toggle object + * @return The icon object + * + * @ingroup Toggle + */ EAPI Evas_Object * elm_toggle_icon_get(const Evas_Object *obj) { @@ -228,6 +282,15 @@ elm_toggle_icon_get(const Evas_Object *obj) return wd->icon; } +/** + * Sets the labels to be associated with the on and off states of the toggle. + * + * @param obj The toggle object + * @param onlabel The label displayed when the toggle is in the "on" state + * @param offlabel The label displayed when the toggle is in the "off" state + * + * @ingroup Toggle + */ EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) { @@ -241,6 +304,16 @@ elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char * _sizing_eval(obj); } + +/** + * Gets the labels associated with the on and off states of the toggle. + * + * @param obj The toggle object + * @param onlabel A char** to place the onlabel of @p obj into + * @param offlabel A char** to place the offlabel of @p obj into + * + * @ingroup Toggle + */ EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) { @@ -253,6 +326,14 @@ elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const if (offlabel) *offlabel = wd->offtext; } +/** + * Sets the state of the toggle to @p state. + * + * @param obj The toggle object + * @param state The state of @p obj + * + * @ingroup Toggle + */ EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) { @@ -270,6 +351,14 @@ elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) } } +/** + * Gets the state of the toggle to @p state. + * + * @param obj The toggle object + * @return The state of @p obj + * + * @ingroup Toggle + */ EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) { @@ -279,6 +368,14 @@ elm_toggle_state_get(const Evas_Object *obj) return wd->state; } +/** + * Sets the state pointer of the toggle to @p statep. + * + * @param obj The toggle object + * @param statep The state pointer of @p obj + * + * @ingroup Toggle + */ EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) { diff --git a/src/lib/elm_toolbar.c b/src/lib/elm_toolbar.c index 91f7cfd..4711d23 100644 --- a/src/lib/elm_toolbar.c +++ b/src/lib/elm_toolbar.c @@ -4,6 +4,13 @@ #include #include "elm_priv.h" +/** + * @defgroup Toolbar Toolbar + * + * A toolbar is a widget that displays a list of buttons inside + * a box. It is scrollable, and only one item can be selected at a time. + */ + typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -284,6 +291,15 @@ _layout(Evas_Object *o, Evas_Object_Box_Data *priv, void *data) _els_box_layout(o, priv, 1, wd->homogeneous); } +/** + * Add a toolbar object to @p parent. + * + * @param parent The parent object + * + * @return The created object, or NULL on failure + * + * @ingroup Toolbar + */ EAPI Evas_Object * elm_toolbar_add(Evas_Object *parent) { @@ -329,6 +345,14 @@ elm_toolbar_add(Evas_Object *parent) return obj; } +/** + * Set the icon size (in pixels) for the toolbar. + * + * @param obj The toolbar object + * @param icon_size The icon size in pixels + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) { @@ -341,6 +365,14 @@ elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) _theme_hook(obj); } +/** + * Get the icon size (in pixels) for the toolbar. + * + * @param obj The toolbar object + * @return The icon size in pixels + * + * @ingroup Toolbar + */ EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) { @@ -350,6 +382,19 @@ elm_toolbar_icon_size_get(const Evas_Object *obj) return wd->icon_size; } +/** + * Add an item to the toolbar. + * + * @param obj The toolbar object + * @param icon The icon object of the item + * @param label The label of the item + * @param func The function to call when the item is clicked + * @param data The data to associate with the item + * + * @return The toolbar item, or NULL upon failure + * + * @ingroup Toolbar + */ EAPI Elm_Toolbar_Item * elm_toolbar_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data) { @@ -398,6 +443,14 @@ elm_toolbar_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Eva return it; } +/** + * Get the icon associated with @p item. + * + * @param item The toolbar item + * @return The icon object + * + * @ingroup Toolbar + */ EAPI Evas_Object * elm_toolbar_item_icon_get(Elm_Toolbar_Item *item) { @@ -405,6 +458,14 @@ elm_toolbar_item_icon_get(Elm_Toolbar_Item *item) return item->icon; } +/** + * Get the label associated with @p item. + * + * @param item The toolbar item + * @return The label + * + * @ingroup Toolbar + */ EAPI const char * elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) { @@ -412,6 +473,14 @@ elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) return item->label; } +/** + * Get the selected state of @p item. + * + * @param item The toolbar item + * @return If true, the item is selected + * + * @ingroup Toolbar + */ EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) { @@ -419,6 +488,14 @@ elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) return item->selected; } +/** + * Set the label associated with @p item. + * + * @param item The toolbar item + * @param label The label of @p item + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) { @@ -436,6 +513,14 @@ elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) evas_object_size_hint_min_set(item->base, mw, mh); } + +/** + * Delete a toolbar item. + * + * @param it The toolbar item + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *it) { @@ -466,6 +551,13 @@ elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *it, Evas_Smart_Cb func) it->del_cb = func; } +/** + * Select the toolbar item @p item. + * + * @param item The toolbar item + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_select(Elm_Toolbar_Item *item) { @@ -473,6 +565,14 @@ elm_toolbar_item_select(Elm_Toolbar_Item *item) _item_select(item); } +/** + * Get the disabled state of @p item. + * + * @param item The toolbar item + * @return If true, the item is disabled + * + * @ingroup Toolbar + */ EAPI Eina_Bool elm_toolbar_item_disabled_get(Elm_Toolbar_Item *item) { @@ -480,6 +580,14 @@ elm_toolbar_item_disabled_get(Elm_Toolbar_Item *item) return item->disabled; } +/** + * Set the disabled state of @p item. + * + * @param item The toolbar item + * @param disabled If true, the item is disabled + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) { @@ -487,6 +595,14 @@ elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) _item_disable(item, disabled); } +/** + * Get the separator state of @p item. + * + * @param item The toolbar item + * @param separator If true, the item is a separator + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) { @@ -496,6 +612,14 @@ elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) _theme_hook(item->obj); } +/** + * Set the separator state of @p item. + * + * @param item The toolbar item + * @return If true, the item is a separator + * + * @ingroup Toolbar + */ EAPI Eina_Bool elm_toolbar_item_separator_get(Elm_Toolbar_Item *item) { @@ -503,6 +627,14 @@ elm_toolbar_item_separator_get(Elm_Toolbar_Item *item) return item->separator; } +/** + * Set the scrollable state of toolbar @p obj. + * + * @param obj The toolbar object + * @param scrollable If true, the toolbar will be scrollable + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_scrollable_set(Evas_Object *obj, Eina_Bool scrollable) { @@ -514,6 +646,14 @@ elm_toolbar_scrollable_set(Evas_Object *obj, Eina_Bool scrollable) _sizing_eval(obj); } +/** + * Set the homogenous mode of toolbar @p obj. + * + * @param obj The toolbar object + * @param homogenous If true, the toolbar items will be uniform in size + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) { @@ -525,6 +665,14 @@ elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) evas_object_smart_calculate(wd->bx); } +/** + * Set the parent object of the toolbar menu + * + * @param obj The toolbar object + * @param parent The parent of the menu object + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) { @@ -542,6 +690,13 @@ elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) } } +/** + * Unselect all of the items in the toolbar. + * + * @param obj The toolbar object + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_unselect_all(Evas_Object *obj) { @@ -563,10 +718,12 @@ elm_toolbar_item_unselect_all(Evas_Object *obj) } /** - * Set if the alignment of the items. + * Set the alignment of the items. * * @param obj The toolbar object * @param align The new alignment. (left) 0.0 ... 1.0 (right) + * + * @ingroup Toolbar */ EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) @@ -580,6 +737,14 @@ elm_toolbar_align_set(Evas_Object *obj, double align) wd->align = align; } +/** + * Get the alignment of the items. + * + * @param obj The toolbar object + * @return The alignment. (left) 0.0 ... 1.0 (right) + * + * @ingroup Toolbar + */ EAPI double elm_toolbar_align_get(const Evas_Object *obj) { @@ -590,6 +755,14 @@ elm_toolbar_align_get(const Evas_Object *obj) return wd->align; } +/** + * Set whether the toolbar item opens a menu. + * + * @param item The toolbar item + * @param menu If true, @p item will open a menu when selected + * + * @ingroup Toolbar + */ EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) { @@ -614,6 +787,15 @@ elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) } } + +/** + * Get whether the toolbar item opens a menu. + * + * @param item The toolbar item + * @return If true, @p item opens a menu when selected + * + * @ingroup Toolbar + */ EAPI Evas_Object * elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) { diff --git a/src/lib/elm_widget.c b/src/lib/elm_widget.c index e142e59..98d73c3 100644 --- a/src/lib/elm_widget.c +++ b/src/lib/elm_widget.c @@ -1,6 +1,15 @@ #include #include "elm_priv.h" +/** + * @defgroup Widget Widget + * + * A widget is the base object type for Elementary objects. These functions + * are used by all the other widgets, and they allow for modification of + * widget types. + * + */ + static const char SMART_NAME[] = "elm_widget"; #define API_ENTRY \ @@ -92,6 +101,16 @@ _sub_obj_mouse_down(void *data __UNUSED__, Evas *e __UNUSED__, Evas_Object *obj, } /* externally accessible functions */ + +/** + * Add a widget + * + * @param evas The parent evas + * + * @return The widget object + * + * @ingroup Widget + */ EAPI Evas_Object * elm_widget_add(Evas *evas) { @@ -99,6 +118,14 @@ elm_widget_add(Evas *evas) return evas_object_smart_add(evas, _e_smart); } +/** + * Set the delete hook for a widget + * + * @param obj The widget object + * @param func The function to call upon deletion + * + * @ingroup Widget + */ EAPI void elm_widget_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -106,6 +133,14 @@ elm_widget_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->del_func = func; } +/** + * Set the pre-delete hook for a widget + * + * @param obj The widget object + * @param func The function to call prior to deletion + * + * @ingroup Widget + */ EAPI void elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -113,6 +148,14 @@ elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->del_pre_func = func; } +/** + * Set the focus change hook for a widget + * + * @param obj The widget object + * @param func The function to call upon changing focus + * + * @ingroup Widget + */ EAPI void elm_widget_focus_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -120,6 +163,14 @@ elm_widget_focus_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->focus_func = func; } +/** + * Set the activate hook for a widget + * + * @param obj The widget object + * @param func The function to call upon activation + * + * @ingroup Widget + */ EAPI void elm_widget_activate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -127,6 +178,14 @@ elm_widget_activate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->activate_func = func; } +/** + * Set the disable hook for a widget + * + * @param obj The widget object + * @param func The function to call upon being disabled + * + * @ingroup Widget + */ EAPI void elm_widget_disable_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -134,6 +193,14 @@ elm_widget_disable_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->disable_func = func; } +/** + * Set the theme hook for a widget + * + * @param obj The widget object + * @param func The function to call upon theme change + * + * @ingroup Widget + */ EAPI void elm_widget_theme_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -141,6 +208,14 @@ elm_widget_theme_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->theme_func = func; } +/** + * Set the change hook for a widget + * + * @param obj The widget object + * @param func The function to call upon widget change + * + * @ingroup Widget + */ EAPI void elm_widget_changed_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) { @@ -148,6 +223,13 @@ elm_widget_changed_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj)) sd->changed_func = func; } +/** + * Re-apply the theme to @p obj + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_theme(Evas_Object *obj) { @@ -162,6 +244,15 @@ elm_widget_theme(Evas_Object *obj) if (sd->theme_func) sd->theme_func(obj); } +/** + * Set the hook for a widget gaining focus + * + * @param obj The widget object + * @param func The function to call upon gaining focus + * @param data The data to associate with this function + * + * @ingroup Widget + */ EAPI void elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data) { @@ -170,6 +261,15 @@ elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Ob sd->on_focus_data = data; } +/** + * Set the hook for a widget changing + * + * @param obj The widget object + * @param func The function to call upon the widget changing + * @param data The data to associate with this function + * + * @ingroup Widget + */ EAPI void elm_widget_on_change_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data) { @@ -178,6 +278,15 @@ elm_widget_on_change_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_O sd->on_change_data = data; } +/** + * Set the hook for a widget region showing + * + * @param obj The widget object + * @param func The function to call upon the widget region showing + * @param data The data to associate with this function + * + * @ingroup Widget + */ EAPI void elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data) { @@ -186,6 +295,14 @@ elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func) (void *data, E sd->on_show_region_data = data; } +/** + * Set the data for a widget + * + * @param obj The widget object + * @param data The data to associate with this widget + * + * @ingroup Widget + */ EAPI void elm_widget_data_set(Evas_Object *obj, void *data) { @@ -193,6 +310,14 @@ elm_widget_data_set(Evas_Object *obj, void *data) sd->data = data; } +/** + * Get the data for a widget + * + * @param obj The widget object + * @return The data to associate with this widget + * + * @ingroup Widget + */ EAPI void * elm_widget_data_get(const Evas_Object *obj) { @@ -200,6 +325,14 @@ elm_widget_data_get(const Evas_Object *obj) return sd->data; } +/** + * Add a sub-object to the widget + * + * @param obj The widget object + * @param sobj The sub-object + * + * @ingroup Widget + */ EAPI void elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj) { @@ -228,6 +361,14 @@ elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj) if (scale != pscale) elm_widget_theme(sobj); } +/** + * Delete a sub-object + * + * @param obj The widget object + * @param sobj The sub-object to delete + * + * @ingroup Widget + */ EAPI void elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj) { @@ -263,6 +404,14 @@ elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj) evas_object_smart_callback_call(obj, "sub-object-del", sobj); } +/** + * Set the resize object + * + * @param obj The widget object + * @param sobj The subobject to set the resize as + * + * @ingroup Widget + */ EAPI void elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj) { @@ -300,6 +449,14 @@ elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj) } } +/** + * Set a hover object for @p obj. + * + * @param obj The widget object + * @param sobj The hover object + * + * @ingroup Widget + */ EAPI void elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj) { @@ -317,6 +474,14 @@ elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj) } } +/** + * Sets the ability of a widget to gain focus. + * + * @param obj The widget object + * @param can_focus The ability of the widget to focus + * + * @ingroup Widget + */ EAPI void elm_widget_can_focus_set(Evas_Object *obj, int can_focus) { @@ -324,6 +489,14 @@ elm_widget_can_focus_set(Evas_Object *obj, int can_focus) sd->can_focus = can_focus; } +/** + * Gets the ability of a widget to gain focus. + * + * @param obj The widget object + * @return The ability of the widget to focus + * + * @ingroup Widget + */ EAPI int elm_widget_can_focus_get(const Evas_Object *obj) { @@ -333,6 +506,14 @@ elm_widget_can_focus_get(const Evas_Object *obj) return 0; } +/** + * Gets the focus state of a widget. + * + * @param obj The widget object + * @return The focus state of the widget + * + * @ingroup Widget + */ EAPI int elm_widget_focus_get(const Evas_Object *obj) { @@ -340,6 +521,14 @@ elm_widget_focus_get(const Evas_Object *obj) return sd->focused; } +/** + * Gets the focused object within a widget. + * + * @param obj The widget object + * @return The focused object within @p obj + * + * @ingroup Widget + */ EAPI Evas_Object * elm_widget_focused_object_get(const Evas_Object *obj) { @@ -356,6 +545,14 @@ elm_widget_focused_object_get(const Evas_Object *obj) return (Evas_Object *)obj; } +/** + * Gets the top object within a widget. + * + * @param obj The widget object + * @return The top object within @p obj + * + * @ingroup Widget + */ EAPI Evas_Object * elm_widget_top_get(const Evas_Object *obj) { @@ -381,12 +578,28 @@ elm_widget_top_get(const Evas_Object *obj) #endif } +/** + * Returns whether the widget exists. + * + * @param obj The widget object + * @return The state of the widget's existence + * + * @ingroup Widget + */ EAPI Eina_Bool elm_widget_is(const Evas_Object *obj) { return _elm_widget_is(obj); } +/** + * Returns the parent widget object of an object. + * + * @param obj The evas object + * @return The widget object that @p obj belongs to + * + * @ingroup Widget + */ EAPI Evas_Object * elm_widget_parent_widget_get(const Evas_Object *obj) { @@ -418,6 +631,15 @@ elm_widget_parent_widget_get(const Evas_Object *obj) return parent; } +/** + * Returns whether the widget exists. + * + * @param obj The widget object + * @param forward Jumps the focus forward + * @return The success of the jump + * + * @ingroup Widget + */ EAPI int elm_widget_focus_jump(Evas_Object *obj, int forward) { @@ -574,6 +796,14 @@ elm_widget_focus_jump(Evas_Object *obj, int forward) return 0; } +/** + * Sets the focus + * + * @param obj The widget object + * @param first TODO: fill this in + * + * @ingroup Widget + */ EAPI void elm_widget_focus_set(Evas_Object *obj, int first) { @@ -637,6 +867,14 @@ elm_widget_focus_set(Evas_Object *obj, int first) } } +/** + * Returns the parent object of the widget. + * + * @param obj The widget object + * @return The parent Evas_Object* + * + * @ingroup Widget + */ EAPI Evas_Object * elm_widget_parent_get(const Evas_Object *obj) { @@ -644,6 +882,13 @@ elm_widget_parent_get(const Evas_Object *obj) return sd->parent_obj; } +/** + * Clears the focus from an object. + * + * @param obj The object + * + * @ingroup Widget + */ EAPI void elm_widget_focused_object_clear(Evas_Object *obj) { @@ -682,6 +927,13 @@ _elm_widget_parent_focus(Evas_Object *obj) if (sd->focus_func) sd->focus_func(obj); } +/** + * Sets a widget to steal focus from its parent. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_focus_steal(Evas_Object *obj) { @@ -727,6 +979,13 @@ elm_widget_focus_steal(Evas_Object *obj) return; } +/** + * Activates a widget. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_activate(Evas_Object *obj) { @@ -735,6 +994,13 @@ elm_widget_activate(Evas_Object *obj) if (sd->activate_func) sd->activate_func(obj); } +/** + * Call the on_change function of a widget. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_change(Evas_Object *obj) { @@ -743,6 +1009,14 @@ elm_widget_change(Evas_Object *obj) if (sd->on_change_func) sd->on_change_func(sd->on_change_data, obj); } +/** + * Sets the disabled state of the widget. + * + * @param obj The widget object + * @param disabled The disabled state to set + * + * @ingroup Widget + */ EAPI void elm_widget_disabled_set(Evas_Object *obj, int disabled) { @@ -766,6 +1040,14 @@ elm_widget_disabled_set(Evas_Object *obj, int disabled) if (sd->disable_func) sd->disable_func(obj); } +/** + * Gets the disabled state of the widget. + * + * @param obj The widget object + * @return The disabled state + * + * @ingroup Widget + */ EAPI int elm_widget_disabled_get(const Evas_Object *obj) { @@ -773,6 +1055,17 @@ elm_widget_disabled_get(const Evas_Object *obj) return sd->disabled; } +/** + * Sets the region of the widget to show. + * + * @param obj The widget object + * @param x The x coordinate + * @param x The y coordinate + * @param x The width to show + * @param x The height to show + * + * @ingroup Widget + */ EAPI void elm_widget_show_region_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) { @@ -786,6 +1079,17 @@ elm_widget_show_region_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Co sd->on_show_region_func(sd->on_show_region_data, obj); } +/** + * Gets the region of the widget that's shown into int pointers. + * + * @param obj The widget object + * @param x The x coordinate + * @param x The y coordinate + * @param x The width to show + * @param x The height to show + * + * @ingroup Widget + */ EAPI void elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) { @@ -796,6 +1100,13 @@ elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, if (h) *h = sd->rh; } +/** + * Simulate a scroll-hold-on event in the object. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_scroll_hold_push(Evas_Object *obj) { @@ -807,6 +1118,13 @@ elm_widget_scroll_hold_push(Evas_Object *obj) // FIXME: on delete/reparent hold pop } +/** + * Simulate a scroll-hold-off event in the object. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_scroll_hold_pop(Evas_Object *obj) { @@ -818,6 +1136,13 @@ elm_widget_scroll_hold_pop(Evas_Object *obj) if (sd->parent_obj) elm_widget_scroll_hold_pop(sd->parent_obj); } +/** + * Returns the scroll-hold state of the object + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI int elm_widget_scroll_hold_get(const Evas_Object *obj) { @@ -825,6 +1150,13 @@ elm_widget_scroll_hold_get(const Evas_Object *obj) return sd->scroll_hold; } +/** + * Simulate a scroll-freeze-on event in the object. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_scroll_freeze_push(Evas_Object *obj) { @@ -836,6 +1168,13 @@ elm_widget_scroll_freeze_push(Evas_Object *obj) // FIXME: on delete/reparent freeze pop } +/** + * Simulate a scroll-freeze-off event in the object. + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI void elm_widget_scroll_freeze_pop(Evas_Object *obj) { @@ -847,6 +1186,13 @@ elm_widget_scroll_freeze_pop(Evas_Object *obj) if (sd->parent_obj) elm_widget_scroll_freeze_pop(sd->parent_obj); } +/** + * Returns the scroll-freeze state of the object + * + * @param obj The widget object + * + * @ingroup Widget + */ EAPI int elm_widget_scroll_freeze_get(const Evas_Object *obj) { @@ -854,6 +1200,14 @@ elm_widget_scroll_freeze_get(const Evas_Object *obj) return sd->scroll_freeze; } +/** + * Sets the scaling of the widget. + * + * @param obj The widget object + * @param scale The scale to set (between 0 and 1.0) + * + * @ingroup Widget + */ EAPI void elm_widget_scale_set(Evas_Object *obj, double scale) { @@ -866,6 +1220,14 @@ elm_widget_scale_set(Evas_Object *obj, double scale) } } +/** + * Gets the scaling of the widget. + * + * @param obj The widget object + * @return The scale to set (between 0 and 1.0) + * + * @ingroup Widget + */ EAPI double elm_widget_scale_get(const Evas_Object *obj) { @@ -880,6 +1242,14 @@ elm_widget_scale_get(const Evas_Object *obj) return sd->scale; } +/** + * Sets the style of the widget. + * + * @param obj The widget object + * @param style The style to set + * + * @ingroup Widget + */ EAPI void elm_widget_style_set(Evas_Object *obj, const char *style) { @@ -889,6 +1259,14 @@ elm_widget_style_set(Evas_Object *obj, const char *style) elm_widget_theme(obj); } +/** + * Gets the style of the widget. + * + * @param obj The widget object + * @return The style of the widget + * + * @ingroup Widget + */ EAPI const char * elm_widget_style_get(const Evas_Object *obj) { @@ -897,6 +1275,14 @@ elm_widget_style_get(const Evas_Object *obj) return "default"; } +/** + * Sets the type of the widget. + * + * @param obj The widget object + * @param type The widget type + * + * @ingroup Widget + */ EAPI void elm_widget_type_set(Evas_Object *obj, const char *type) { @@ -904,6 +1290,14 @@ elm_widget_type_set(Evas_Object *obj, const char *type) eina_stringshare_replace(&sd->type, type); } +/** + * Gets the type of the widget. + * + * @param obj The widget object + * @return The widget type + * + * @ingroup Widget + */ EAPI const char * elm_widget_type_get(const Evas_Object *obj) { diff --git a/src/lib/elm_win.c b/src/lib/elm_win.c index a5513f4..719c1b1 100644 --- a/src/lib/elm_win.c +++ b/src/lib/elm_win.c @@ -4,6 +4,8 @@ /** * @defgroup Win Win * + * The window class of Elementary. Contains functions to manipulate + * windows. */ typedef struct _Elm_Win Elm_Win; @@ -372,6 +374,26 @@ _elm_win_rescale(void) elm_widget_theme(obj); } +/** + * Adds a window object. If this is the first window created, pass NULL as + * @p parent. + * + * @param parent Parent object to add the window to, or NULL + * @param name The name of the window + * @param type The window type, one of the following: + * ELM_WIN_BASIC + * ELM_WIN_DIALOG_BASIC + * ELM_WIN_DESKTOP + * ELM_WIN_DOCK + * ELM_WIN_TOOLBAR + * ELM_WIN_MENU + * ELM_WIN_UTILITY + * ELM_WIN_SPLASH + * + * @return The created object, or NULL on failure + * + * @ingroup Win + */ EAPI Evas_Object * elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type) { @@ -528,6 +550,14 @@ elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type) return win->win_obj; } +/** + * Add @p subobj as a resize object of window @p obj. + * + * @param obj The window object + * @param subobj The resize object to add + * + * @ingroup Win + */ EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) { @@ -549,6 +579,14 @@ elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) _elm_win_eval_subobjs(obj); } +/** + * Delete @p subobj as a resize object of window @p obj. + * + * @param obj The window object + * @param subobj The resize object to add + * + * @ingroup Win + */ EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) { @@ -567,6 +605,14 @@ elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) _elm_win_eval_subobjs(obj); } +/** + * Set the title of the window + * + * @param obj The window object + * @param title The title to set + * + * @ingroup Win + */ EAPI void elm_win_title_set(Evas_Object *obj, const char *title) { @@ -577,6 +623,14 @@ elm_win_title_set(Evas_Object *obj, const char *title) ecore_evas_title_set(win->ee, title); } +/** + * Set the window's autodel state. + * + * @param obj The window object + * @param autodel If true, the window will automatically delete itself when closed + * + * @ingroup Win + */ EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) { @@ -587,6 +641,13 @@ elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) win->autodel = autodel; } +/** + * Activate a window object. + * + * @param obj The window object + * + * @ingroup Win + */ EAPI void elm_win_activate(Evas_Object *obj) { @@ -597,6 +658,13 @@ elm_win_activate(Evas_Object *obj) ecore_evas_activate(win->ee); } +/** + * Lower a window object. + * + * @param obj The window object + * + * @ingroup Win + */ EAPI void elm_win_lower(Evas_Object *obj) { @@ -607,6 +675,13 @@ elm_win_lower(Evas_Object *obj) ecore_evas_lower(win->ee); } +/** + * Raise a window object. + * + * @param obj The window object + * + * @ingroup Win + */ EAPI void elm_win_raise(Evas_Object *obj) { @@ -617,6 +692,14 @@ elm_win_raise(Evas_Object *obj) ecore_evas_raise(win->ee); } +/** + * Set the borderless state of a window. + * + * @param obj The window object + * @param borderless If true, the window is borderless + * + * @ingroup Win + */ EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) { @@ -628,6 +711,14 @@ elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) _elm_win_xwin_update(win); } +/** + * Get the borderless state of a window. + * + * @param obj The window object + * @return If true, the window is borderless + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) { @@ -638,6 +729,14 @@ elm_win_borderless_get(const Evas_Object *obj) return ecore_evas_borderless_get(win->ee); } +/** + * Set the shaped state of a window. + * + * @param obj The window object + * @param shaped If true, the window is shaped + * + * @ingroup Win + */ EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) { @@ -649,6 +748,14 @@ elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) _elm_win_xwin_update(win); } +/** + * Get the shaped state of a window. + * + * @param obj The window object + * @return If true, the window is shaped + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) { @@ -659,6 +766,14 @@ elm_win_shaped_get(const Evas_Object *obj) return ecore_evas_shaped_get(win->ee); } +/** + * Set the alpha channel state of a window. + * + * @param obj The window object + * @param alpha If true, the window has an alpha channel + * + * @ingroup Win + */ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) { @@ -683,6 +798,14 @@ elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) ecore_evas_alpha_set(win->ee, alpha); } +/** + * Get the alpha channel state of a window. + * + * @param obj The window object + * @return If true, the window has an alpha channel + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) { @@ -693,6 +816,14 @@ elm_win_alpha_get(const Evas_Object *obj) return ecore_evas_alpha_get(win->ee); } +/** + * Set the transparency state of a window. + * + * @param obj The window object + * @param transparent If true, the window is transparent + * + * @ingroup Win + */ EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) { @@ -710,6 +841,14 @@ elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) ecore_evas_transparent_set(win->ee, transparent); } +/** + * Get the transparency state of a window. + * + * @param obj The window object + * @return If true, the window is transparent + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) { @@ -721,6 +860,14 @@ elm_win_transparent_get(const Evas_Object *obj) return ecore_evas_transparent_get(win->ee); } +/** + * Set the override state of a window. + * + * @param obj The window object + * @param override If true, the window is overridden + * + * @ingroup Win + */ EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) { @@ -732,6 +879,14 @@ elm_win_override_set(Evas_Object *obj, Eina_Bool override) _elm_win_xwin_update(win); } +/** + * Get the override state of a window. + * + * @param obj The window object + * @return If true, the window is overridden + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) { @@ -742,6 +897,14 @@ elm_win_override_get(const Evas_Object *obj) return ecore_evas_override_get(win->ee); } +/** + * Set the fullscreen state of a window. + * + * @param obj The window object + * @param fullscreen If true, the window is fullscreen + * + * @ingroup Win + */ EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) { @@ -762,6 +925,14 @@ elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) } } +/** + * Get the fullscreen state of a window. + * + * @param obj The window object + * @return If true, the window is fullscreen + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) { @@ -783,6 +954,14 @@ elm_win_fullscreen_get(const Evas_Object *obj) return EINA_FALSE; } +/** + * Set the maximized state of a window. + * + * @param obj The window object + * @param maximized If true, the window is maximized + * + * @ingroup Win + */ EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) { @@ -794,6 +973,14 @@ elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) _elm_win_xwin_update(win); } +/** + * Get the maximized state of a window. + * + * @param obj The window object + * @return If true, the window is maximized + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) { @@ -804,6 +991,14 @@ elm_win_maximized_get(const Evas_Object *obj) return ecore_evas_maximized_get(win->ee); } +/** + * Set the iconified state of a window. + * + * @param obj The window object + * @param iconified If true, the window is iconified + * + * @ingroup Win + */ EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) { @@ -815,6 +1010,14 @@ elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) _elm_win_xwin_update(win); } +/** + * Get the iconified state of a window. + * + * @param obj The window object + * @return If true, the window is iconified + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) { @@ -825,6 +1028,14 @@ elm_win_iconified_get(const Evas_Object *obj) return ecore_evas_iconified_get(win->ee); } +/** + * Set the layer of the window. + * + * @param obj The window object + * @param layer The layer of the window + * + * @ingroup Win + */ EAPI void elm_win_layer_set(Evas_Object *obj, int layer) { @@ -836,6 +1047,14 @@ elm_win_layer_set(Evas_Object *obj, int layer) _elm_win_xwin_update(win); } +/** + * Get the layer of the window. + * + * @param obj The window object + * @return The layer of the window + * + * @ingroup Win + */ EAPI int elm_win_layer_get(const Evas_Object *obj) { @@ -846,6 +1065,14 @@ elm_win_layer_get(const Evas_Object *obj) return ecore_evas_layer_get(win->ee); } +/** + * Set the rotation of the window. + * + * @param obj The window object + * @param rotation The rotation of the window, in degrees (0-360) + * + * @ingroup Win + */ EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) { @@ -862,6 +1089,14 @@ elm_win_rotation_set(Evas_Object *obj, int rotation) _elm_win_xwin_update(win); } +/** + * Rotates the window and resizes it + * + * @param obj The window object + * @param layer The rotation of the window in degrees (0-360) + * + * @ingroup Win + */ EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) { @@ -878,6 +1113,14 @@ elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) _elm_win_xwin_update(win); } +/** + * Get the rotation of the window. + * + * @param obj The window object + * @return The rotation of the window in degrees (0-360) + * + * @ingroup Win + */ EAPI int elm_win_rotation_get(const Evas_Object *obj) { @@ -888,6 +1131,14 @@ elm_win_rotation_get(const Evas_Object *obj) return win->rot; } +/** + * Set the sticky state of the window. + * + * @param obj The window object + * @param sticky If true, the window's sticky state is enabled + * + * @ingroup Win + */ EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) { @@ -899,6 +1150,14 @@ elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) _elm_win_xwin_update(win); } +/** + * Get the sticky state of the window. + * + * @param obj The window object + * @return If true, the window's sticky state is enabled + * + * @ingroup Win + */ EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) { @@ -909,6 +1168,30 @@ elm_win_sticky_get(const Evas_Object *obj) return ecore_evas_sticky_get(win->ee); } +/** + * Sets the keyboard mode of the window. + * + * @param obj The window object + * @param mode The mode to set; one of: + * ELM_WIN_KEYBOARD_UNKNOWN + * ELM_WIN_KEYBOARD_OFF + * ELM_WIN_KEYBOARD_ON + * ELM_WIN_KEYBOARD_ALPHA + * ELM_WIN_KEYBOARD_NUMERIC + * ELM_WIN_KEYBOARD_PIN + * ELM_WIN_KEYBOARD_PHONE_NUMBER + * ELM_WIN_KEYBOARD_HEX + * ELM_WIN_KEYBOARD_TERMINAL + * ELM_WIN_KEYBOARD_PASSWORD + * ELM_WIN_KEYBOARD_IP + * ELM_WIN_KEYBOARD_HOST + * ELM_WIN_KEYBOARD_FILE + * ELM_WIN_KEYBOARD_URL + * ELM_WIN_KEYBOARD_KEYPAD + * ELM_WIN_KEYBOARD_J2ME + * + * @ingroup Win + */ EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) { @@ -926,6 +1209,14 @@ elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) #endif } +/** + * Sets whether the window is a keyboard. + * + * @param obj The window object + * @param is_keyboard If true, the window is a virtual keyboard + * + * @ingroup Win + */ EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) { @@ -940,6 +1231,15 @@ elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) #endif } +/** + * Get the screen position of a window. + * + * @param obj The window object + * @param x The int to store the x coordinate to + * @param y The int to store the y coordinate to + * + * @ingroup Win + */ EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) { @@ -1231,6 +1531,11 @@ _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info) } } +/** + * @defgroup Inwin Inwin + * + * An inwin is a window inside a window that is useful for a quick popup. It does not hover. + */ EAPI Evas_Object * elm_win_inwin_add(Evas_Object *obj) { @@ -1264,6 +1569,13 @@ elm_win_inwin_add(Evas_Object *obj) return obj2; } +/** + * Activates an inwin object + * + * @param obj The inwin to activate + * + * @ingroup Inwin + */ EAPI void elm_win_inwin_activate(Evas_Object *obj) { @@ -1276,6 +1588,14 @@ elm_win_inwin_activate(Evas_Object *obj) elm_widget_focused_object_clear(elm_widget_parent_get(obj)); } +/** + * Set the content of an inwin object. + * + * @param obj The inwin object + * @param content The object to set as content + * + * @ingroup Inwin + */ EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) { @@ -1296,6 +1616,15 @@ elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) } /* windowing spcific calls - shall we do this differently? */ +/** + * Get the Ecore_X_Window of an Evas_Object + * + * @param obj The object + * + * @return The Ecore_X_Window of @p obj + * + * @ingroup Win + */ EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) { -- 2.7.4