From 855b8d2709e34532ddcfb81769640cfbfc15ae34 Mon Sep 17 00:00:00 2001 From: ChunEon Park Date: Tue, 17 Apr 2012 01:35:46 +0000 Subject: [PATCH] elementary - +ingroup, fixed indentations. SVN revision: 70249 --- legacy/elementary/src/lib/elc_ctxpopup.h | 1 + legacy/elementary/src/lib/elc_dayselector.h | 9 + legacy/elementary/src/lib/elc_fileselector.h | 1 + .../src/lib/elc_fileselector_button.h | 31 + .../src/lib/elc_fileselector_entry.h | 35 + legacy/elementary/src/lib/elc_hoversel.h | 27 + .../elementary/src/lib/elc_multibuttonentry.h | 1 + legacy/elementary/src/lib/elm_actionslider.h | 17 + legacy/elementary/src/lib/elm_bg.h | 1 + legacy/elementary/src/lib/elm_box.h | 43 + legacy/elementary/src/lib/elm_bubble.h | 7 + legacy/elementary/src/lib/elm_button.h | 20 + legacy/elementary/src/lib/elm_cache.h | 1 + legacy/elementary/src/lib/elm_calendar.h | 3 + legacy/elementary/src/lib/elm_check.h | 9 + legacy/elementary/src/lib/elm_clock.h | 1 + legacy/elementary/src/lib/elm_cnp.h | 1 + legacy/elementary/src/lib/elm_config.h | 7 +- legacy/elementary/src/lib/elm_cursor.h | 1 + legacy/elementary/src/lib/elm_datetime.h | 1152 ++++++++--------- legacy/elementary/src/lib/elm_debug.h | 1 + legacy/elementary/src/lib/elm_entry.h | 183 +++ legacy/elementary/src/lib/elm_finger.h | 1 + legacy/elementary/src/lib/elm_flip.h | 21 + legacy/elementary/src/lib/elm_flipselector.h | 1 + legacy/elementary/src/lib/elm_focus.h | 1 + legacy/elementary/src/lib/elm_font.h | 1 + legacy/elementary/src/lib/elm_frame.h | 13 + legacy/elementary/src/lib/elm_general.h | 1 + legacy/elementary/src/lib/elm_gengrid.h | 1 + legacy/elementary/src/lib/elm_genlist.h | 1 + legacy/elementary/src/lib/elm_gesture_layer.h | 2 + .../elementary/src/lib/elm_getting_started.h | 1 + legacy/elementary/src/lib/elm_glview.h | 1 + legacy/elementary/src/lib/elm_grid.h | 1 + legacy/elementary/src/lib/elm_hover.h | 15 + legacy/elementary/src/lib/elm_icon.h | 1 + legacy/elementary/src/lib/elm_image.h | 1 + legacy/elementary/src/lib/elm_index.h | 1 + legacy/elementary/src/lib/elm_label.h | 23 + legacy/elementary/src/lib/elm_layout.h | 1 + legacy/elementary/src/lib/elm_menu.h | 42 + legacy/elementary/src/lib/elm_mirroring.h | 10 +- legacy/elementary/src/lib/elm_notify.h | 19 + legacy/elementary/src/lib/elm_panel.h | 13 + legacy/elementary/src/lib/elm_photo.h | 1 + legacy/elementary/src/lib/elm_photocam.h | 41 +- legacy/elementary/src/lib/elm_plug.h | 1 + legacy/elementary/src/lib/elm_progressbar.h | 1 + legacy/elementary/src/lib/elm_radio.h | 18 +- legacy/elementary/src/lib/elm_route.h | 2 + legacy/elementary/src/lib/elm_scale.h | 1 + legacy/elementary/src/lib/elm_scroll.h | 1 + legacy/elementary/src/lib/elm_scroller.h | 42 + legacy/elementary/src/lib/elm_separator.h | 7 + legacy/elementary/src/lib/elm_slideshow.h | 1 + legacy/elementary/src/lib/elm_store.h | 39 + legacy/elementary/src/lib/elm_table.h | 21 + legacy/elementary/src/lib/elm_theme.h | 47 + legacy/elementary/src/lib/elm_thumb.h | 1 + legacy/elementary/src/lib/elm_tooltip.h | 11 + legacy/elementary/src/lib/elm_transit.h | 1 - legacy/elementary/src/lib/elm_video.h | 1 + legacy/elementary/src/lib/elm_web.h | 108 ++ legacy/elementary/src/lib/elm_win.h | 206 ++- 65 files changed, 1673 insertions(+), 602 deletions(-) diff --git a/legacy/elementary/src/lib/elc_ctxpopup.h b/legacy/elementary/src/lib/elc_ctxpopup.h index bb5934a6bb..45c1b194e9 100644 --- a/legacy/elementary/src/lib/elc_ctxpopup.h +++ b/legacy/elementary/src/lib/elc_ctxpopup.h @@ -1,5 +1,6 @@ /** * @defgroup Ctxpopup Ctxpopup + * @ingroup Elementary * * @image html img/widget/ctxpopup/preview-00.png * @image latex img/widget/ctxpopup/preview-00.eps diff --git a/legacy/elementary/src/lib/elc_dayselector.h b/legacy/elementary/src/lib/elc_dayselector.h index ca18615f39..e5e5088f0d 100644 --- a/legacy/elementary/src/lib/elc_dayselector.h +++ b/legacy/elementary/src/lib/elc_dayselector.h @@ -1,5 +1,6 @@ /** * @defgroup Dayselector Dayselector + * @ingroup Elementary * * @image html img/widget/dayselector/preview-00.png * @image latex img/widget/dayselector/preview-00.eps @@ -106,6 +107,7 @@ EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent); * @see Elm_Dayselector_Day * @see elm_dayselector_day_selected_get() * + * @ingroup Dayselector */ EAPI void elm_dayselector_day_selected_set(Evas_Object *obj, Elm_Dayselector_Day day, Eina_Bool selected); @@ -119,6 +121,7 @@ EAPI void elm_dayselector_day_selected_set(Evas_Object *obj, Elm_Dayselector_D * @see Elm_Dayselector_Day * @see elm_dayselector_day_selected_set() * + * @ingroup Dayselector */ EAPI Eina_Bool elm_dayselector_day_selected_get(const Evas_Object *obj, Elm_Dayselector_Day day); @@ -131,6 +134,7 @@ EAPI Eina_Bool elm_dayselector_day_selected_get(const Evas_Object *obj, Elm_Da * @see Elm_Dayselector_Day * @see elm_dayselector_week_start_get() * + * @ingroup Dayselector */ EAPI void elm_dayselector_week_start_set(Evas_Object *obj, Elm_Dayselector_Day day); @@ -143,6 +147,7 @@ EAPI void elm_dayselector_week_start_set(Evas_Object *obj, Elm_Dayselector_Day * @see Elm_Dayselector_Day * @see elm_dayselector_week_start_set() * + * @ingroup Dayselector */ EAPI Elm_Dayselector_Day elm_dayselector_week_start_get(const Evas_Object *obj); @@ -155,6 +160,7 @@ EAPI Elm_Dayselector_Day elm_dayselector_week_start_get(const Evas_Object *obj * @see Elm_Dayselector_Day * @see elm_dayselector_weekend_start_get() * + * @ingroup Dayselector */ EAPI void elm_dayselector_weekend_start_set(Evas_Object *obj, Elm_Dayselector_Day day); @@ -167,6 +173,7 @@ EAPI void elm_dayselector_weekend_start_set(Evas_Object *obj, Elm_Dayselector_ * @see Elm_Dayselector_Day * @see elm_dayselector_weekend_start_set() * + * @ingroup Dayselector */ EAPI Elm_Dayselector_Day elm_dayselector_weekend_start_get(const Evas_Object *obj); @@ -178,6 +185,7 @@ EAPI Elm_Dayselector_Day elm_dayselector_weekend_start_get(const Evas_Object * * * @see elm_dayselector_weekend_length_get() * + * @ingroup Dayselector */ EAPI void elm_dayselector_weekend_length_set(Evas_Object *obj, unsigned int length); @@ -190,6 +198,7 @@ EAPI void elm_dayselector_weekend_length_set(Evas_Object *obj, unsigned int le * @see Elm_Dayselector_Day * @see elm_dayselector_weekend_length_set() * + * @ingroup Dayselector */ EAPI unsigned int elm_dayselector_weekend_length_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elc_fileselector.h b/legacy/elementary/src/lib/elc_fileselector.h index 501fb88dbc..bf11c677f2 100644 --- a/legacy/elementary/src/lib/elc_fileselector.h +++ b/legacy/elementary/src/lib/elc_fileselector.h @@ -1,5 +1,6 @@ /** * @defgroup Fileselector File Selector + * @ingroup Elementary * * @image html img/widget/fileselector/preview-00.png * @image latex img/widget/fileselector/preview-00.eps diff --git a/legacy/elementary/src/lib/elc_fileselector_button.h b/legacy/elementary/src/lib/elc_fileselector_button.h index 73c965145a..725677b2e4 100644 --- a/legacy/elementary/src/lib/elc_fileselector_button.h +++ b/legacy/elementary/src/lib/elc_fileselector_button.h @@ -1,5 +1,6 @@ /** * @defgroup File_Selector_Button File Selector Button + * @ingroup Elementary * * @image html img/widget/fileselector_button/preview-00.png * @image latex img/widget/fileselector_button/preview-00.eps @@ -60,6 +61,8 @@ * @param parent The parent object * @return a new file selector button widget handle or @c NULL, on * errors + * + * @ingroup File_Selector_Button */ EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent); @@ -77,6 +80,8 @@ EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent * button widget is @b not under "inwin mode". * * @see elm_fileselector_button_window_title_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title); @@ -88,6 +93,8 @@ EAPI void elm_fileselector_button_window_title_set(Evas_O * @return Title of the file selector button's window * * @see elm_fileselector_button_window_title_get() for more details + * + * @ingroup File_Selector_Button */ EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj); @@ -104,6 +111,8 @@ EAPI const char *elm_fileselector_button_window_title_get(const * window (when applicable) is 400x400 pixels. * * @see elm_fileselector_button_window_size_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height); @@ -119,6 +128,8 @@ EAPI void elm_fileselector_button_window_size_set(Evas_Ob * interested in: they'll be ignored by the function. * * @see elm_fileselector_button_window_size_set(), for more details + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height); @@ -135,6 +146,8 @@ EAPI void elm_fileselector_button_window_size_get(const E * environment variable's value. * * @see elm_fileselector_button_path_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path); @@ -146,6 +159,8 @@ EAPI void elm_fileselector_button_path_set(Evas_Object *o * @return path The path string * * @see elm_fileselector_button_path_set() for more details + * + * @ingroup File_Selector_Button */ EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj); @@ -166,6 +181,8 @@ EAPI const char *elm_fileselector_button_path_get(const Evas_Obj * selectors. * * @see elm_fileselector_expandable_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value); @@ -178,6 +195,8 @@ EAPI void elm_fileselector_button_expandable_set(Evas_Obj * is in tree view, @c EINA_FALSE otherwise (and or errors) * * @see elm_fileselector_expandable_set() for more details + * + * @ingroup File_Selector_Button */ EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj); @@ -196,6 +215,8 @@ EAPI Eina_Bool elm_fileselector_button_expandable_get(const Ev * selector. * * @see elm_fileselector_folder_only_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value); @@ -210,6 +231,8 @@ EAPI void elm_fileselector_button_folder_only_set(Evas_Ob * are being displayed in it too (and on errors) * * @see elm_fileselector_button_folder_only_set() for more details + * + * @ingroup File_Selector_Button */ EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj); @@ -227,6 +250,8 @@ EAPI Eina_Bool elm_fileselector_button_folder_only_get(const E * selector. * * @see elm_fileselector_is_save_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value); @@ -240,6 +265,8 @@ EAPI void elm_fileselector_button_is_save_set(Evas_Object * errors) * * @see elm_fileselector_button_is_save_set() for more details + * + * @ingroup File_Selector_Button */ EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj); @@ -254,6 +281,8 @@ EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_ * * @see elm_win_inwin_add() for more information on inner windows * @see elm_fileselector_button_inwin_mode_get() + * + * @ingroup File_Selector_Button */ EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value); @@ -267,6 +296,8 @@ EAPI void elm_fileselector_button_inwin_mode_set(Evas_Obj * if it will use a dedicated window * * @see elm_fileselector_button_inwin_mode_set() for more details + * + * @ingroup File_Selector_Button */ EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elc_fileselector_entry.h b/legacy/elementary/src/lib/elc_fileselector_entry.h index c5ac35615c..53640c5d0e 100644 --- a/legacy/elementary/src/lib/elc_fileselector_entry.h +++ b/legacy/elementary/src/lib/elc_fileselector_entry.h @@ -1,5 +1,6 @@ /** * @defgroup File_Selector_Entry File Selector Entry + * @ingroup Elementary * * @image html img/widget/fileselector_entry/preview-00.png * @image latex img/widget/fileselector_entry/preview-00.eps @@ -72,6 +73,8 @@ * @param parent The parent object * @return a new file selector entry widget handle or @c NULL, on * errors + * + * @ingroup File_Selector_Entry */ EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent); @@ -89,6 +92,8 @@ EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) * entry widget is @b not under "inwin mode". * * @see elm_fileselector_entry_window_title_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title); @@ -100,6 +105,8 @@ EAPI void elm_fileselector_entry_window_title_set(Evas_Ob * @return Title of the file selector entry's window * * @see elm_fileselector_entry_window_title_get() for more details + * + * @ingroup File_Selector_Entry */ EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj); @@ -116,6 +123,8 @@ EAPI const char *elm_fileselector_entry_window_title_get(const E * window (when applicable) is 400x400 pixels. * * @see elm_fileselector_entry_window_size_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height); @@ -131,6 +140,8 @@ EAPI void elm_fileselector_entry_window_size_set(Evas_Obj * interested in: they'll be ignored by the function. * * @see elm_fileselector_entry_window_size_set(), for more details + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height); @@ -147,6 +158,8 @@ EAPI void elm_fileselector_entry_window_size_get(const Ev * environment variable's value. * * @see elm_fileselector_entry_path_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path); @@ -158,6 +171,8 @@ EAPI void elm_fileselector_entry_path_set(Evas_Object *ob * @return path The path string * * @see elm_fileselector_entry_path_set() for more details + * + * @ingroup File_Selector_Entry */ EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj); @@ -177,6 +192,8 @@ EAPI const char *elm_fileselector_entry_path_get(const Evas_Obje * selectors. * * @see elm_fileselector_expandable_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value); @@ -189,6 +206,8 @@ EAPI void elm_fileselector_entry_expandable_set(Evas_Obje * is in tree view, @c EINA_FALSE otherwise (and or errors) * * @see elm_fileselector_expandable_set() for more details + * + * @ingroup File_Selector_Entry */ EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj); @@ -207,6 +226,8 @@ EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Eva * selector. * * @see elm_fileselector_folder_only_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value); @@ -221,6 +242,8 @@ EAPI void elm_fileselector_entry_folder_only_set(Evas_Obj * are being displayed in it too (and on errors) * * @see elm_fileselector_entry_folder_only_set() for more details + * + * @ingroup File_Selector_Entry */ EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj); @@ -238,6 +261,8 @@ EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Ev * selector. * * @see elm_fileselector_is_save_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value); @@ -251,6 +276,8 @@ EAPI void elm_fileselector_entry_is_save_set(Evas_Object * errors) * * @see elm_fileselector_entry_is_save_set() for more details + * + * @ingroup File_Selector_Entry */ EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj); @@ -265,6 +292,8 @@ EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_O * * @see elm_win_inwin_add() for more information on inner windows * @see elm_fileselector_entry_inwin_mode_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value); @@ -278,6 +307,8 @@ EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Obje * if it will use a dedicated window * * @see elm_fileselector_entry_inwin_mode_set() for more details + * + * @ingroup File_Selector_Entry */ EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj); @@ -294,6 +325,8 @@ EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Eva * environment variable's value. * * @see elm_fileselector_entry_path_get() + * + * @ingroup File_Selector_Entry */ EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path); @@ -306,6 +339,8 @@ EAPI void elm_fileselector_entry_selected_set(Evas_Object * on @p obj widget, a @b stringshared string * * @see elm_fileselector_entry_path_set() + * + * @ingroup File_Selector_Entry */ EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elc_hoversel.h b/legacy/elementary/src/lib/elc_hoversel.h index 79f4db79ba..a17fdbea88 100644 --- a/legacy/elementary/src/lib/elc_hoversel.h +++ b/legacy/elementary/src/lib/elc_hoversel.h @@ -1,5 +1,6 @@ /** * @defgroup Hoversel Hoversel + * @ingroup Elementary * * @image html img/widget/hoversel/preview-00.png * @image latex img/widget/hoversel/preview-00.eps @@ -42,6 +43,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Hoversel */ EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent); @@ -54,6 +57,8 @@ EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent); * * @note The initial button will display horizontally regardless of this * setting. + * + * @ingroup Hoversel */ EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal); @@ -64,6 +69,8 @@ EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, * @return If true, the hover will expand horizontally to the right. * * @see elm_hoversel_horizontal_set() + * + * @ingroup Hoversel */ EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj); @@ -76,6 +83,8 @@ EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object * Sets the hover parent object, the area that will be darkened when the * hoversel is clicked. Should probably be the window that the hoversel is * in. See @ref Hover objects for more information. + * + * @ingroup Hoversel */ EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent); @@ -88,6 +97,8 @@ EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj * Gets the hover parent object. * * @see elm_hoversel_hover_parent_set() + * + * @ingroup Hoversel */ EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj); @@ -96,6 +107,8 @@ EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Objec * had clicked the button. * * @param obj The hoversel object + * + * @ingroup Hoversel */ EAPI void elm_hoversel_hover_begin(Evas_Object *obj); @@ -104,6 +117,8 @@ EAPI void elm_hoversel_hover_begin(Evas_Object *obj); * outside the hover. * * @param obj The hoversel object + * + * @ingroup Hoversel */ EAPI void elm_hoversel_hover_end(Evas_Object *obj); @@ -113,6 +128,8 @@ EAPI void elm_hoversel_hover_end(Evas_Object *obj); * @param obj The hoversel object * @return This will return EINA_TRUE if the hoversel is expanded or * EINA_FALSE if it is not expanded. + * + * @ingroup Hoversel */ EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj); @@ -125,6 +142,8 @@ EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *o * elm_hoversel_expanded_get() to check first. * * @see elm_object_item_del() + * + * @ingroup Hoversel */ EAPI void elm_hoversel_clear(Evas_Object *obj); @@ -135,6 +154,8 @@ EAPI void elm_hoversel_clear(Evas_Object *obj); * @return Returns a list of Elm_Object_Item* * * @see elm_hoversel_item_add() + * + * @ingroup Hoversel */ EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj); @@ -157,6 +178,8 @@ EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) * * For more information on what @p icon_file and @p icon_type are, see the * @ref Icon "icon documentation". + * + * @ingroup Hoversel */ EAPI Elm_Object_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data); @@ -174,6 +197,8 @@ EAPI Elm_Object_Item *elm_hoversel_item_add(Evas_Object *obj, const * an edje file. * * @see elm_hoversel_item_add() + * + * @ingroup Hoversel */ EAPI void elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type); @@ -189,6 +214,8 @@ EAPI void elm_hoversel_item_icon_set(Elm_Object_Item *it * * @see elm_hoversel_item_icon_set() * @see elm_hoversel_item_add() + * + * @ingroup Hoversel */ EAPI void elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type); diff --git a/legacy/elementary/src/lib/elc_multibuttonentry.h b/legacy/elementary/src/lib/elc_multibuttonentry.h index cc4de8489b..d7470983f1 100644 --- a/legacy/elementary/src/lib/elc_multibuttonentry.h +++ b/legacy/elementary/src/lib/elc_multibuttonentry.h @@ -1,5 +1,6 @@ /** * @defgroup Multibuttonentry Multibuttonentry + * @ingroup Elementary * * A Multibuttonentry is a widget to allow a user enter text and manage it as a number * of buttons. Each text button is inserted by pressing the "return" key. diff --git a/legacy/elementary/src/lib/elm_actionslider.h b/legacy/elementary/src/lib/elm_actionslider.h index 8822022523..5c191cc640 100644 --- a/legacy/elementary/src/lib/elm_actionslider.h +++ b/legacy/elementary/src/lib/elm_actionslider.h @@ -1,5 +1,6 @@ /** * @addtogroup Actionslider Actionslider + * @ingroup Elementary * * @image html img/widget/actionslider/preview-00.png * @image latex img/widget/actionslider/preview-00.eps @@ -54,6 +55,8 @@ typedef enum * * @param parent The parent object * @return The new actionslider object or NULL if it cannot be created + * + * @ingroup Actionslider */ EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent); @@ -62,6 +65,8 @@ EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent); * * @param obj The actionslider object * @return The selected label + * + * @ingroup Actionslider */ EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj); @@ -70,6 +75,8 @@ EAPI const char *elm_actionslider_selected_label_get(const Evas_ * * @param obj The actionslider object. * @param pos The position of the indicator. + * + * @ingroup Actionslider */ EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos); @@ -78,6 +85,8 @@ EAPI void elm_actionslider_indicator_pos_set(Evas_Object * * @param obj The actionslider object. * @return The position of the indicator. + * + * @ingroup Actionslider */ EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj); @@ -87,6 +96,8 @@ EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_O * * @param obj The actionslider object. * @param pos Bit mask indicating the magnet positions. + * + * @ingroup Actionslider */ EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos); @@ -95,6 +106,8 @@ EAPI void elm_actionslider_magnet_pos_set(Evas_Object *ob * * @param obj The actionslider object. * @return The positions with magnet property. + * + * @ingroup Actionslider */ EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj); @@ -106,6 +119,8 @@ EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Obje * * @param obj The actionslider object. * @param pos Bit mask indicating the enabled positions. + * + * @ingroup Actionslider */ EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos); @@ -114,6 +129,8 @@ EAPI void elm_actionslider_enabled_pos_set(Evas_Object *o * * @param obj The actionslider object. * @return The enabled positions. + * + * @ingroup Actionslider */ EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_bg.h b/legacy/elementary/src/lib/elm_bg.h index 1a869d4067..d7a8251c85 100644 --- a/legacy/elementary/src/lib/elm_bg.h +++ b/legacy/elementary/src/lib/elm_bg.h @@ -1,5 +1,6 @@ /** * @defgroup Bg Bg + * @ingroup Elementary * * @image html img/widget/bg/preview-00.png * @image latex img/widget/bg/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_box.h b/legacy/elementary/src/lib/elm_box.h index 9ee693dc55..43011ab254 100644 --- a/legacy/elementary/src/lib/elm_box.h +++ b/legacy/elementary/src/lib/elm_box.h @@ -1,5 +1,6 @@ /** * @defgroup Box Box + * @ingroup Elementary * * @image html img/widget/box/preview-00.png * @image latex img/widget/box/preview-00.eps width=\textwidth @@ -86,6 +87,8 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition; * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Box */ EAPI Evas_Object *elm_box_add(Evas_Object *parent); @@ -102,6 +105,8 @@ EAPI Evas_Object *elm_box_add(Evas_Object *parent); * @param obj The box object * @param horizontal The horizontal flag (EINA_TRUE = horizontal, * EINA_FALSE = vertical) + * + * @ingroup Box */ EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal); @@ -123,6 +128,8 @@ EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj); * * @param obj The box object * @param homogeneous The homogeneous flag + * + * @ingroup Box */ EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous); @@ -131,6 +138,8 @@ EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool hom * * @param obj The box object * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise + * + * @ingroup Box */ EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj); @@ -152,6 +161,8 @@ EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj); * @see elm_box_unpack() * @see elm_box_unpack_all() * @see elm_box_clear() + * + * @ingroup Box */ EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj); @@ -173,6 +184,8 @@ EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subob * @see elm_box_unpack() * @see elm_box_unpack_all() * @see elm_box_clear() + * + * @ingroup Box */ EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj); @@ -194,6 +207,8 @@ EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) * @see elm_box_unpack() * @see elm_box_unpack_all() * @see elm_box_clear() + * + * @ingroup Box */ EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before); @@ -215,6 +230,8 @@ EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subo * @see elm_box_unpack() * @see elm_box_unpack_all() * @see elm_box_clear() + * + * @ingroup Box */ EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after); @@ -228,6 +245,8 @@ EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subob * * @see elm_box_unpack() * @see elm_box_unpack_all() + * + * @ingroup Box */ EAPI void elm_box_clear(Evas_Object *obj); @@ -242,6 +261,8 @@ EAPI void elm_box_clear(Evas_Object *obj); * * @see elm_box_unpack_all() * @see elm_box_clear() + * + * @ingroup Box */ EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj); @@ -258,6 +279,8 @@ EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj); * * @see elm_box_clear() * @see elm_box_unpack() + * + * @ingroup Box */ EAPI void elm_box_unpack_all(Evas_Object *obj); @@ -270,6 +293,8 @@ EAPI void elm_box_unpack_all(Evas_Object *obj); * You must free this list with eina_list_free() once you are done with it. * * @param obj The box object + * + * @ingroup Box */ EAPI Eina_List *elm_box_children_get(const Evas_Object *obj); @@ -284,6 +309,8 @@ EAPI Eina_List *elm_box_children_get(const Evas_Object *obj); * @param obj The box object * @param horizontal The horizontal space between elements * @param vertical The vertical space between elements + * + * @ingroup Box */ EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical); @@ -295,6 +322,8 @@ EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizo * @param vertical The vertical space between elements * * @see elm_box_padding_set() + * + * @ingroup Box */ EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical); @@ -308,6 +337,8 @@ EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord * @param obj The box object * @param horizontal The horizontal alignment of elements * @param vertical The vertical alignment of elements + * + * @ingroup Box */ EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical); @@ -319,6 +350,8 @@ EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, * @param vertical The vertical alignment of elements * * @see elm_box_align_set() + * + * @ingroup Box */ EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical); @@ -332,6 +365,8 @@ EAPI void elm_box_align_get(const Evas_Object *obj, double *horiz * added item you must force recalculate before doing so. * * @param obj The box object. + * + * @ingroup Box */ EAPI void elm_box_recalculate(Evas_Object *obj); @@ -367,6 +402,8 @@ EAPI void elm_box_recalculate(Evas_Object *obj); * @param free_data Function called to free @p data * * @see elm_box_layout_transition() + * + * @ingroup Box */ EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, Ecore_Cb free_data); @@ -401,6 +438,8 @@ EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_La * @see elm_box_transition_new * @see elm_box_transition_free * @see elm_box_layout_set + * + * @ingroup Box */ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data); @@ -434,6 +473,8 @@ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object * * @see elm_box_transition_new * @see elm_box_layout_transition + * + * @ingroup Box */ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data); @@ -447,6 +488,8 @@ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Obje * * @see elm_box_transition_new * @see elm_box_layout_transition + * + * @ingroup Box */ EAPI void elm_box_transition_free(void *data); diff --git a/legacy/elementary/src/lib/elm_bubble.h b/legacy/elementary/src/lib/elm_bubble.h index 8e1afdb8ec..16fc8dfe8c 100644 --- a/legacy/elementary/src/lib/elm_bubble.h +++ b/legacy/elementary/src/lib/elm_bubble.h @@ -1,5 +1,6 @@ /** * @defgroup Bubble Bubble + * @ingroup Elementary * * @image html img/widget/bubble/preview-00.png * @image latex img/widget/bubble/preview-00.eps @@ -73,6 +74,8 @@ typedef enum * @return The new object or NULL if it cannot be created * * This function adds a text bubble to the given parent evas object. + * + * @ingroup Bubble */ EAPI Evas_Object *elm_bubble_add(Evas_Object *parent); @@ -86,6 +89,8 @@ EAPI Evas_Object *elm_bubble_add(Evas_Object *parent); * determine where the arrow in the frame points to and where label, icon and * info are shown. * + * + * @ingroup Bubble */ EAPI void elm_bubble_pos_set(Evas_Object *obj, Elm_Bubble_Pos pos); @@ -96,6 +101,8 @@ EAPI void elm_bubble_pos_set(Evas_Object *obj, Elm_Bubble_Pos pos); * @return The given corner for the bubble. * * This function gets the selected corner of the bubble. + * + * @ingroup Bubble */ EAPI Elm_Bubble_Pos elm_bubble_pos_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_button.h b/legacy/elementary/src/lib/elm_button.h index 9a60708199..c5eeba4b25 100644 --- a/legacy/elementary/src/lib/elm_button.h +++ b/legacy/elementary/src/lib/elm_button.h @@ -1,5 +1,6 @@ /** * @defgroup Button Button + * @ingroup Elementary * * @image html img/widget/button/preview-00.png * @image latex img/widget/button/preview-00.eps @@ -52,11 +53,18 @@ * @li @ref button_example_01 */ +/** + * @addtogroup Button + * @{ + */ + /** * Add a new button to the parent's canvas * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Button */ EAPI Evas_Object *elm_button_add(Evas_Object *parent); @@ -74,6 +82,8 @@ EAPI Evas_Object *elm_button_add(Evas_Object *parent); * * @param obj The button object * @param on A bool to turn on/off the event + * + * @ingroup Button */ EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on); @@ -84,6 +94,8 @@ EAPI void elm_button_autorepeat_set(Evas_Object *obj, Ei * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise * * @see elm_button_autorepeat_set() + * + * @ingroup Button */ EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj); @@ -100,6 +112,8 @@ EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *o * * @see elm_button_autorepeat_set() * @see elm_button_autorepeat_gap_timeout_set() + * + * @ingroup Button */ EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t); @@ -110,6 +124,8 @@ EAPI void elm_button_autorepeat_initial_timeout_set(Evas * @return Timeout in seconds * * @see elm_button_autorepeat_initial_timeout_set() + * + * @ingroup Button */ EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj); @@ -123,6 +139,8 @@ EAPI double elm_button_autorepeat_initial_timeout_get(cons * @param t Interval in seconds * * @see elm_button_autorepeat_initial_timeout_set() + * + * @ingroup Button */ EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t); @@ -131,6 +149,8 @@ EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Obj * * @param obj The button object * @return Interval in seconds + * + * @ingroup Button */ EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_cache.h b/legacy/elementary/src/lib/elm_cache.h index ef0e602ab1..7546f6b482 100644 --- a/legacy/elementary/src/lib/elm_cache.h +++ b/legacy/elementary/src/lib/elm_cache.h @@ -1,5 +1,6 @@ /** * @defgroup Caches Caches + * @ingroup Elementary * * These are functions which let one fine-tune some cache values for * Elementary applications, thus allowing for performance adjustments. diff --git a/legacy/elementary/src/lib/elm_calendar.h b/legacy/elementary/src/lib/elm_calendar.h index cc9464672b..761fc18914 100644 --- a/legacy/elementary/src/lib/elm_calendar.h +++ b/legacy/elementary/src/lib/elm_calendar.h @@ -1,5 +1,6 @@ /** * @defgroup Calendar Calendar + * @ingroup Elementary * * This is a Calendar widget. Calender widget helps applications to flexibly * display a calender with day of the week, day, year and month. Applications will be @@ -97,6 +98,8 @@ typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a c * @return String representing time that will be set to calendar's text. * * @see elm_calendar_format_function_set() + * + * @ingroup Calendar */ typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime); diff --git a/legacy/elementary/src/lib/elm_check.h b/legacy/elementary/src/lib/elm_check.h index 0681caa894..b495fcebe1 100644 --- a/legacy/elementary/src/lib/elm_check.h +++ b/legacy/elementary/src/lib/elm_check.h @@ -1,5 +1,6 @@ /** * @defgroup Check Check + * @ingroup Elementary * * @image html img/widget/check/preview-00.png * @image latex img/widget/check/preview-00.eps @@ -53,6 +54,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Check */ EAPI Evas_Object * elm_check_add(Evas_Object *parent); @@ -65,6 +68,8 @@ EAPI Evas_Object * elm_check_add(Evas_Object *parent); * This sets the state of the check. If set with elm_check_state_pointer_set() * the state of that variable is also changed. Calling this @b doesn't cause * the "changed" signal to be emitted. + * + * @ingroup Check */ EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state); @@ -73,6 +78,8 @@ EAPI void elm_check_state_set(Evas_Object *obj, Eina_Boo * * @param obj The check object * @return The boolean state + * + * @ingroup Check */ EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj); @@ -88,6 +95,8 @@ EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj); * then when this is called, the check objects state will also be modified to * reflect the value of the boolean @p statep points to, just like calling * elm_check_state_set(). + * + * @ingroup Check */ EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep); diff --git a/legacy/elementary/src/lib/elm_clock.h b/legacy/elementary/src/lib/elm_clock.h index ecf5c1f0c8..fbe9ba0485 100644 --- a/legacy/elementary/src/lib/elm_clock.h +++ b/legacy/elementary/src/lib/elm_clock.h @@ -1,5 +1,6 @@ /** * @defgroup Clock Clock + * @ingroup Elementary * * @image html img/widget/clock/preview-00.png * @image latex img/widget/clock/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_cnp.h b/legacy/elementary/src/lib/elm_cnp.h index b61ef5985e..2b45c919c9 100644 --- a/legacy/elementary/src/lib/elm_cnp.h +++ b/legacy/elementary/src/lib/elm_cnp.h @@ -1,5 +1,6 @@ /** * @defgroup CopyPaste CopyPaste + * @ingroup Elementary * * Implements the following functionality * a. select, copy/cut and paste diff --git a/legacy/elementary/src/lib/elm_config.h b/legacy/elementary/src/lib/elm_config.h index edab212498..413eab8353 100644 --- a/legacy/elementary/src/lib/elm_config.h +++ b/legacy/elementary/src/lib/elm_config.h @@ -1,5 +1,6 @@ /** * @defgroup Config Elementary Config + * @ingroup Elementary * * Elementary configuration is formed by a set options bounded to a * given @ref Profile profile, like @ref Theme theme, @ref Fingers @@ -54,6 +55,7 @@ EAPI void elm_config_all_flush(void); /** * @defgroup Profile Elementary Profile + * @ingroup Elementary * * Profiles are pre-set options that affect the whole look-and-feel of * Elementary-based applications. There are, for example, profiles @@ -140,7 +142,8 @@ EAPI void elm_config_profile_set(const char *profile); */ /** - * @defgroup Scrolling Scrolling + * @defgroup Scrolling Elementary Scrolling + * @ingroup Elementary * * These are functions setting how scrollable views in Elementary * widgets should behave on user interaction. @@ -478,6 +481,7 @@ EAPI void elm_config_scale_set(double scale); /** * @defgroup Password_last_show Password show last + * @ingroup Elementary * * Show last feature of password mode enables user to view * the last input entered for few seconds before masking it. @@ -541,6 +545,7 @@ EAPI void elm_config_password_show_last_timeout_set(double password_show_la /** * @defgroup Engine Elementary Engine + * @ingroup Elementary * * These are functions setting and querying which rendering engine * Elementary will use for drawing its windows' pixels. diff --git a/legacy/elementary/src/lib/elm_cursor.h b/legacy/elementary/src/lib/elm_cursor.h index 14da21f551..84a404a31c 100644 --- a/legacy/elementary/src/lib/elm_cursor.h +++ b/legacy/elementary/src/lib/elm_cursor.h @@ -1,5 +1,6 @@ /** * @defgroup Cursors Cursors + * @ingroup Elementary * * The Elementary cursor is an internal smart object used to * customize the mouse cursor displayed over objects (or diff --git a/legacy/elementary/src/lib/elm_datetime.h b/legacy/elementary/src/lib/elm_datetime.h index 042cdc9f52..36785cb7cc 100644 --- a/legacy/elementary/src/lib/elm_datetime.h +++ b/legacy/elementary/src/lib/elm_datetime.h @@ -1,592 +1,592 @@ +/** + * @defgroup Datetime Datetime + * @ingroup Elementary + * + * + * @image html img/widget/datetime/preview-00.png + * @image latex img/widget/datetime/preview-00.eps + * + * @image html img/widget/datetime/preview-01.png + * @image latex img/widget/datetime/preview-01.eps + * + * @image html img/widget/datetime/preview-02.png + * @image latex img/widget/datetime/preview-02.eps + * + * Datetime widget is used to display and input date & time values. + * This widget displays date and time as per the system's locale settings (Date + * includes Day, Month & Year along with the defined separators and + * Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored. + * + * The corresponding Month, AM/PM strings are displayed according to the + * system’s language settings. + * + * Datetime format is a combination of LIBC standard characters like + * “%%d %%b %%Y %%I : %%M %%p” which, as a whole represents both Date as well as Time + * format. + * + * Elm_datetime supports only the following sub set of libc date format specifiers: + * + * @b %%Y : The year as a decimal number including the century (example: 2011). + * + * @b %%y : The year as a decimal number without a century (range 00 to 99) + * + * @b %%m : The month as a decimal number (range 01 to 12). + * + * @b %%b : The abbreviated month name according to the current locale. + * + * @b %%B : The full month name according to the current locale. + * + * @b %%h : The abbreviated month name according to the current locale(same as %%b). + * + * @b %%d : The day of the month as a decimal number (range 01 to 31). + * + * @b %%e : The day of the month as a decimal number (range 1 to 31). single + * digits are preceded by a blank. + * + * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). + * + * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). + * + * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single + * digits are preceded by a blank. + * + * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single + * digits are preceded by a blank. + * + * @b %%M : The minute as a decimal number (range 00 to 59). + * + * @b %%p : Either 'AM' or 'PM' according to the given time value, or the + * corresponding strings for the current locale. Noon is treated as 'PM' + * and midnight as 'AM' + * + * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for + * the current locale. + * + * @b %%c : The preferred date and time representation for the current locale. + * + * @b %%x : The preferred date representation for the current locale without the time. + * + * @b %%X : The preferred time representation for the current locale without the date. + * + * @b %%r : The complete calendar time using the AM/PM format of the current locale. + * + * @b %%R : The hour and minute in decimal numbers using the format %H:%M. + * + * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. + * + * @b %%D : The date using the format %%m/%%d/%%y. + * + * @b %%F : The date using the format %%Y-%%m-%%d. + * + * (For more reference on the available LIBC date format specifiers, please + * visit the link: + * http://www.gnu.org/s/hello/manual/libc.html#Formatting-Calendar-Time ) + * + * Datetime widget can provide Unicode @b separators in between its fields + * except for AM/PM field. + * A separator can be any Unicode character other than the LIBC standard + * date format specifiers.( Example: In the format %%b %%d @b , %%y %%H @b : %%M + * comma(,) is separator for date field %%d and colon(:) is separator for + * hour field %%H ). + * + * The default format is a predefined one, based on the system Locale. + * + * Hour format 12hr(1-12) or 24hr(0-23) display can be selected by setting + * the corresponding user format. + * + * Datetime supports six fields: Year, Month, Date, Hour, Minute, AM/PM. + * Depending on the Datetime module that is loaded, the user can see + * different UI to select the individual field values. + * + * The individual fields of Datetime can be arranged in any order according to the format + * set by application. + * + * There is a provision to set the visibility of a particular field as TRUE/ FALSE + * so that only time/ only date / only required fields will be displayed. + * + * Each field is having a default minimum and maximum values just like the daily + * calendar information. These min/max values can be modified as per the application usage. + * + * User can enter the values only in between the range of maximum and minimum. + * Apart from these APIs, there is a provision to display only a limited set of + * values out of the possible values. APIs to select the individual field limits + * are intended for this purpose. + * + * The whole widget is left aligned and its size grows horizontally depending + * on the current format and each field's visible/disabled state. + * + * Datetime individual field selection is implemented in a modular style. + * Module can be implemented as a Ctxpopup based selection or an ISE based + * selection or even a spinner like selection etc. + * + * Datetime Module design: + * + * The following functions are expected to be implemented in a Datetime module: + * + * Field creation: + * 
+ *
+ *  __________                                            __________
+ * |          |----- obj_hook() ---------------------->>>|          |
+ * |          |<<<----------------returns Mod_data ------|          |
+ * | Datetime |_______                                   |          |
+ * |  widget  |       |Assign module call backs          |  Module  |
+ * |   base   |<<<____|                                  |          |
+ * |          |                                          |          |
+ * |          |----- field_create() ------------------>>>|          |
+ * |__________|<<<----------------returns field_obj -----|__________|
+ *
+ *
+ * + * Field value setting: + * 
+ *
+ *  __________                                          __________
+ * |          |                                        |          |
+ * | Datetime |<<<----------elm_datetime_value_set()---|          |
+ * |  widget  |                                        |  Module  |
+ * |   base   |----display_field_value()------------>>>|          |
+ * |__________|                                        |__________|
+ *
+ *
+ * + * del_hook: + * 
+ *  __________                                          __________
+ * |          |                                        |          |
+ * | Datetime |----obj_unhook()-------------------->>>>|          |
+ * |  widget  |                                        |  Module  |
+ * |   base   |         <<<-----frees mod_data---------|          |
+ * |__________|                                        |__________|
+ *
+ *
+ * + * + * Any module can use the following shared functions that are implemented in elm_datetime.c : + * + * field_format_get() - gives the field format. + * + * field_limit_get() - gives the field minimum, maximum limits. + * + * To enable a module, set the ELM_MODULES environment variable as shown: + * + * export ELM_MODULES="datetime_input_ctxpopup>datetime/api" + * + * + * Datetime widgets emits the following signals: + * + * @li @b "changed" - whenever Datetime field value is changed, this signal is sent. + * + * @li @b "language,changed" - whenever system locale changes, this signal is sent. + * + * Here is an example on its usage: + * @li @ref datetime_example + * + */ - /** - * @defgroup Datetime Datetime - * - * - * @image html img/widget/datetime/preview-00.png - * @image latex img/widget/datetime/preview-00.eps - * - * @image html img/widget/datetime/preview-01.png - * @image latex img/widget/datetime/preview-01.eps - * - * @image html img/widget/datetime/preview-02.png - * @image latex img/widget/datetime/preview-02.eps - * - * Datetime widget is used to display and input date & time values. - * This widget displays date and time as per the system's locale settings (Date - * includes Day, Month & Year along with the defined separators and - * Time includes Hour, Minute & AM/PM fields. Separator for AM/PM field is ignored. - * - * The corresponding Month, AM/PM strings are displayed according to the - * system’s language settings. - * - * Datetime format is a combination of LIBC standard characters like - * “%%d %%b %%Y %%I : %%M %%p” which, as a whole represents both Date as well as Time - * format. - * - * Elm_datetime supports only the following sub set of libc date format specifiers: - * - * @b %%Y : The year as a decimal number including the century (example: 2011). - * - * @b %%y : The year as a decimal number without a century (range 00 to 99) - * - * @b %%m : The month as a decimal number (range 01 to 12). - * - * @b %%b : The abbreviated month name according to the current locale. - * - * @b %%B : The full month name according to the current locale. - * - * @b %%h : The abbreviated month name according to the current locale(same as %%b). - * - * @b %%d : The day of the month as a decimal number (range 01 to 31). - * - * @b %%e : The day of the month as a decimal number (range 1 to 31). single - * digits are preceded by a blank. - * - * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). - * - * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). - * - * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single - * digits are preceded by a blank. - * - * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single - * digits are preceded by a blank. - * - * @b %%M : The minute as a decimal number (range 00 to 59). - * - * @b %%p : Either 'AM' or 'PM' according to the given time value, or the - * corresponding strings for the current locale. Noon is treated as 'PM' - * and midnight as 'AM' - * - * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for - * the current locale. - * - * @b %%c : The preferred date and time representation for the current locale. - * - * @b %%x : The preferred date representation for the current locale without the time. - * - * @b %%X : The preferred time representation for the current locale without the date. - * - * @b %%r : The complete calendar time using the AM/PM format of the current locale. - * - * @b %%R : The hour and minute in decimal numbers using the format %H:%M. - * - * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. - * - * @b %%D : The date using the format %%m/%%d/%%y. - * - * @b %%F : The date using the format %%Y-%%m-%%d. - * - * (For more reference on the available LIBC date format specifiers, please - * visit the link: - * http://www.gnu.org/s/hello/manual/libc.html#Formatting-Calendar-Time ) - * - * Datetime widget can provide Unicode @b separators in between its fields - * except for AM/PM field. - * A separator can be any Unicode character other than the LIBC standard - * date format specifiers.( Example: In the format %%b %%d @b , %%y %%H @b : %%M - * comma(,) is separator for date field %%d and colon(:) is separator for - * hour field %%H ). - * - * The default format is a predefined one, based on the system Locale. - * - * Hour format 12hr(1-12) or 24hr(0-23) display can be selected by setting - * the corresponding user format. - * - * Datetime supports six fields: Year, Month, Date, Hour, Minute, AM/PM. - * Depending on the Datetime module that is loaded, the user can see - * different UI to select the individual field values. - * - * The individual fields of Datetime can be arranged in any order according to the format - * set by application. - * - * There is a provision to set the visibility of a particular field as TRUE/ FALSE - * so that only time/ only date / only required fields will be displayed. - * - * Each field is having a default minimum and maximum values just like the daily - * calendar information. These min/max values can be modified as per the application usage. - * - * User can enter the values only in between the range of maximum and minimum. - * Apart from these APIs, there is a provision to display only a limited set of - * values out of the possible values. APIs to select the individual field limits - * are intended for this purpose. - * - * The whole widget is left aligned and its size grows horizontally depending - * on the current format and each field's visible/disabled state. - * - * Datetime individual field selection is implemented in a modular style. - * Module can be implemented as a Ctxpopup based selection or an ISE based - * selection or even a spinner like selection etc. - * - * Datetime Module design: - * - * The following functions are expected to be implemented in a Datetime module: - * - * Field creation: - * 
-    *
-    *  __________                                            __________
-    * |          |----- obj_hook() ---------------------->>>|          |
-    * |          |<<<----------------returns Mod_data ------|          |
-    * | Datetime |_______                                   |          |
-    * |  widget  |       |Assign module call backs          |  Module  |
-    * |   base   |<<<____|                                  |          |
-    * |          |                                          |          |
-    * |          |----- field_create() ------------------>>>|          |
-    * |__________|<<<----------------returns field_obj -----|__________|
-    *
-    *
- * - * Field value setting: - * 
-    *
-    *  __________                                          __________
-    * |          |                                        |          |
-    * | Datetime |<<<----------elm_datetime_value_set()---|          |
-    * |  widget  |                                        |  Module  |
-    * |   base   |----display_field_value()------------>>>|          |
-    * |__________|                                        |__________|
-    *
-    *
- * - * del_hook: - * 
-    *  __________                                          __________
-    * |          |                                        |          |
-    * | Datetime |----obj_unhook()-------------------->>>>|          |
-    * |  widget  |                                        |  Module  |
-    * |   base   |         <<<-----frees mod_data---------|          |
-    * |__________|                                        |__________|
-    *
-    *
- * - * - * Any module can use the following shared functions that are implemented in elm_datetime.c : - * - * field_format_get() - gives the field format. - * - * field_limit_get() - gives the field minimum, maximum limits. - * - * To enable a module, set the ELM_MODULES environment variable as shown: - * - * export ELM_MODULES="datetime_input_ctxpopup>datetime/api" - * - * - * Datetime widgets emits the following signals: - * - * @li @b "changed" - whenever Datetime field value is changed, this signal is sent. - * - * @li @b "language,changed" - whenever system locale changes, this signal is sent. - * - * Here is an example on its usage: - * @li @ref datetime_example - * - */ +/** + * @addtogroup Datetime + * @{ + */ - /** - * @addtogroup Datetime - * @{ - */ +/** + * Identifies a Datetime field, The widget supports 6 fields : Year, month, + * Date, Hour, Minute, AM/PM + * + */ +typedef enum _Elm_Datetime_Field_Type +{ + ELM_DATETIME_YEAR = 0, /**< Indicates Year field */ + ELM_DATETIME_MONTH = 1, /**< Indicates Month field */ + ELM_DATETIME_DATE = 2, /**< Indicates Date field */ + ELM_DATETIME_HOUR = 3, /**< Indicates Hour field */ + ELM_DATETIME_MINUTE = 4, /**< Indicates Minute field */ + ELM_DATETIME_AMPM = 5, /**< Indicates AM/PM field */ +} Elm_Datetime_Field_Type; - /** - * Identifies a Datetime field, The widget supports 6 fields : Year, month, - * Date, Hour, Minute, AM/PM - * - */ - typedef enum _Elm_Datetime_Field_Type - { - ELM_DATETIME_YEAR = 0, /**< Indicates Year field */ - ELM_DATETIME_MONTH = 1, /**< Indicates Month field */ - ELM_DATETIME_DATE = 2, /**< Indicates Date field */ - ELM_DATETIME_HOUR = 3, /**< Indicates Hour field */ - ELM_DATETIME_MINUTE = 4, /**< Indicates Minute field */ - ELM_DATETIME_AMPM = 5, /**< Indicates AM/PM field */ - } Elm_Datetime_Field_Type; +/** + * @brief Adds a new datetime Widget + * + * The default datetime format and corresponding strings are based on current locale. + * + * @param parent The parent object + * @return The new object or NULL if it cannot be created + * + * This function inserts a new datetime widget on the canvas. + * + * @ingroup Datetime + */ +EAPI Evas_Object *elm_datetime_add(Evas_Object *parent); - /** - * @brief Adds a new datetime Widget - * - * The default datetime format and corresponding strings are based on current locale. - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * This function inserts a new datetime widget on the canvas. - * - * @ingroup Datetime - */ - EAPI Evas_Object *elm_datetime_add(Evas_Object *parent); +/** + * Get the datetime format. Format is a combination of allowed Libc date format + * specifiers like: "%b %d, %Y %I : %M %p". + * + * Maximum allowed format length is 64 chars. + * + * Format can include separators for each individual datetime field except + * for AM/PM field. + * + * Each separator can be a maximum of 6 UTF-8 bytes. + * Space is also taken as a separator. + * + * Following are the allowed set of format specifiers for each datetime field. + * + * @b %%Y : The year as a decimal number including the century. + * + * @b %%y : The year as a decimal number without a century (range 00 to 99). + * + * @b %%m : The month as a decimal number (range 01 to 12). + * + * @b %%b : The abbreviated month name according to the current locale. + * + * @b %%B : The full month name according to the current locale. + * + * @b %%h : The abbreviated month name according to the current locale(same as %%b). + * + * @b %%d : The day of the month as a decimal number (range 01 to 31). + * + * @b %%e : The day of the month as a decimal number (range 1 to 31). single + * digits are preceded by a blank. + * + * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). + * + * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). + * + * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single + * digits are preceded by a blank. + * + * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single + * digits are preceded by a blank. + * + * @b %%M : The minute as a decimal number (range 00 to 59). + * + * @b %%p : Either 'AM' or 'PM' according to the given time value, or the + * corresponding strings for the current locale. Noon is treated as 'PM' + * and midnight as 'AM'. + * + * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for + * the current locale. + * + * @b %%c : The preferred date and time representation for the current locale. + * + * @b %%x : The preferred date representation for the current locale without the time. + * + * @b %%X : The preferred time representation for the current locale without the date. + * + * @b %%r : The complete calendar time using the AM/PM format of the current locale. + * + * @b %%R : The hour and minute in decimal numbers using the format %H:%M. + * + * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. + * + * @b %%D : The date using the format %%m/%%d/%%y. + * + * @b %%F : The date using the format %%Y-%%m-%%d. + * + * These specifiers can be arranged in any order and the widget will display the + * fields accordingly. + * + * Default format is taken as per the system locale settings. + * + * @param obj The datetime object + * @return The datetime format string. Example: "%b %d, %Y %I : %M %p" + * + * @see elm_datetime_format_set() + * @ingroup Datetime + */ + EAPI const char *elm_datetime_format_get(const Evas_Object *obj); - /** - * Get the datetime format. Format is a combination of allowed Libc date format - * specifiers like: "%b %d, %Y %I : %M %p". - * - * Maximum allowed format length is 64 chars. - * - * Format can include separators for each individual datetime field except - * for AM/PM field. - * - * Each separator can be a maximum of 6 UTF-8 bytes. - * Space is also taken as a separator. - * - * Following are the allowed set of format specifiers for each datetime field. - * - * @b %%Y : The year as a decimal number including the century. - * - * @b %%y : The year as a decimal number without a century (range 00 to 99). - * - * @b %%m : The month as a decimal number (range 01 to 12). - * - * @b %%b : The abbreviated month name according to the current locale. - * - * @b %%B : The full month name according to the current locale. - * - * @b %%h : The abbreviated month name according to the current locale(same as %%b). - * - * @b %%d : The day of the month as a decimal number (range 01 to 31). - * - * @b %%e : The day of the month as a decimal number (range 1 to 31). single - * digits are preceded by a blank. - * - * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). - * - * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). - * - * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single - * digits are preceded by a blank. - * - * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single - * digits are preceded by a blank. - * - * @b %%M : The minute as a decimal number (range 00 to 59). - * - * @b %%p : Either 'AM' or 'PM' according to the given time value, or the - * corresponding strings for the current locale. Noon is treated as 'PM' - * and midnight as 'AM'. - * - * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for - * the current locale. - * - * @b %%c : The preferred date and time representation for the current locale. - * - * @b %%x : The preferred date representation for the current locale without the time. - * - * @b %%X : The preferred time representation for the current locale without the date. - * - * @b %%r : The complete calendar time using the AM/PM format of the current locale. - * - * @b %%R : The hour and minute in decimal numbers using the format %H:%M. - * - * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. - * - * @b %%D : The date using the format %%m/%%d/%%y. - * - * @b %%F : The date using the format %%Y-%%m-%%d. - * - * These specifiers can be arranged in any order and the widget will display the - * fields accordingly. - * - * Default format is taken as per the system locale settings. - * - * @param obj The datetime object - * @return The datetime format string. Example: "%b %d, %Y %I : %M %p" - * - * @see elm_datetime_format_set() - * @ingroup Datetime - */ - EAPI const char *elm_datetime_format_get(const Evas_Object *obj); +/** + * Set the datetime format. Format is a combination of allowed Libc date format + * specifiers like: "%b %d, %Y %I : %M %p". + * + * Maximum allowed format length is 64 chars. + * + * Format can include separators for each individual datetime field except + * for AM/PM field. + * + * Each separator can be a maximum of 6 UTF-8 bytes. + * Space is also taken as a separator. + * + * Following are the allowed set of format specifiers for each datetime field. + * + * @b %%Y : The year as a decimal number including the century. + * + * @b %%y : The year as a decimal number without a century (range 00 to 99). + * + * @b %%m : The month as a decimal number (range 01 to 12). + * + * @b %%b : The abbreviated month name according to the current locale. + * + * @b %%B : The full month name according to the current locale. + * + * @b %%h : The abbreviated month name according to the current locale(same as %%b). + * + * @b %%d : The day of the month as a decimal number (range 01 to 31). + * + * @b %%e : The day of the month as a decimal number (range 1 to 31). single + * digits are preceded by a blank. + * + * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). + * + * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). + * + * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single + * digits are preceded by a blank. + * + * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single + * digits are preceded by a blank. + * + * @b %%M : The minute as a decimal number (range 00 to 59). + * + * @b %%p : Either 'AM' or 'PM' according to the given time value, or the + * corresponding strings for the current locale. Noon is treated as 'PM' + * and midnight as 'AM'. + * + * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for + * the current locale. + * + * @b %%c : The preferred date and time representation for the current locale. + * + * @b %%x : The preferred date representation for the current locale without the time. + * + * @b %%X : The preferred time representation for the current locale without the date. + * + * @b %%r : The complete calendar time using the AM/PM format of the current locale. + * + * @b %%R : The hour and minute in decimal numbers using the format %H:%M. + * + * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. + * + * @b %%D : The date using the format %%m/%%d/%%y. + * + * @b %%F : The date using the format %%Y-%%m-%%d. + * + * These specifiers can be arranged in any order and the widget will display the + * fields accordingly. + * + * Default format is taken as per the system locale settings. + * + * @param obj The datetime object + * @param fmt The datetime format + * + * @see elm_datetime_format_get() + * @ingroup Datetime + */ +EAPI void elm_datetime_format_set(Evas_Object *obj, const char *fmt); - /** - * Set the datetime format. Format is a combination of allowed Libc date format - * specifiers like: "%b %d, %Y %I : %M %p". - * - * Maximum allowed format length is 64 chars. - * - * Format can include separators for each individual datetime field except - * for AM/PM field. - * - * Each separator can be a maximum of 6 UTF-8 bytes. - * Space is also taken as a separator. - * - * Following are the allowed set of format specifiers for each datetime field. - * - * @b %%Y : The year as a decimal number including the century. - * - * @b %%y : The year as a decimal number without a century (range 00 to 99). - * - * @b %%m : The month as a decimal number (range 01 to 12). - * - * @b %%b : The abbreviated month name according to the current locale. - * - * @b %%B : The full month name according to the current locale. - * - * @b %%h : The abbreviated month name according to the current locale(same as %%b). - * - * @b %%d : The day of the month as a decimal number (range 01 to 31). - * - * @b %%e : The day of the month as a decimal number (range 1 to 31). single - * digits are preceded by a blank. - * - * @b %%I : The hour as a decimal number using a 12-hour clock (range 01 to 12). - * - * @b %%H : The hour as a decimal number using a 24-hour clock (range 00 to 23). - * - * @b %%k : The hour (24-hour clock) as a decimal number (range 0 to 23). single - * digits are preceded by a blank. - * - * @b %%l : The hour (12-hour clock) as a decimal number (range 1 to 12); single - * digits are preceded by a blank. - * - * @b %%M : The minute as a decimal number (range 00 to 59). - * - * @b %%p : Either 'AM' or 'PM' according to the given time value, or the - * corresponding strings for the current locale. Noon is treated as 'PM' - * and midnight as 'AM'. - * - * @b %%P : Like %p but in lower case: 'am' or 'pm' or a corresponding string for - * the current locale. - * - * @b %%c : The preferred date and time representation for the current locale. - * - * @b %%x : The preferred date representation for the current locale without the time. - * - * @b %%X : The preferred time representation for the current locale without the date. - * - * @b %%r : The complete calendar time using the AM/PM format of the current locale. - * - * @b %%R : The hour and minute in decimal numbers using the format %H:%M. - * - * @b %%T : The time of day in decimal numbers using the format %H:%M:%S. - * - * @b %%D : The date using the format %%m/%%d/%%y. - * - * @b %%F : The date using the format %%Y-%%m-%%d. - * - * These specifiers can be arranged in any order and the widget will display the - * fields accordingly. - * - * Default format is taken as per the system locale settings. - * - * @param obj The datetime object - * @param fmt The datetime format - * - * @see elm_datetime_format_get() - * @ingroup Datetime - */ - EAPI void elm_datetime_format_set(Evas_Object *obj, const char *fmt); +/** + * @brief Get the upper boundary of a field. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * @param obj The datetime object + * @param maxtime Time structure containing the maximum time value. + * @return int The maximum value of the field. + * + * @see elm_datetime_value_max_set() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_value_max_get(const Evas_Object *obj, struct tm *maxtime); - /** - * @brief Get the upper boundary of a field. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * @param obj The datetime object - * @param maxtime Time structure containing the maximum time value. - * @return int The maximum value of the field. - * - * @see elm_datetime_value_max_set() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_value_max_get(const Evas_Object *obj, struct tm *maxtime); +/** + * @brief Set the upper boundary of a field. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * @param obj The datetime object + * @param maxtime Time structure containing the maximum time value. + * @return EINA_TRUE if maximum value is accepted. + * + * @see elm_datetime_value_max_get() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_value_max_set(Evas_Object *obj, const struct tm *maxtime); - /** - * @brief Set the upper boundary of a field. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * @param obj The datetime object - * @param maxtime Time structure containing the maximum time value. - * @return EINA_TRUE if maximum value is accepted. - * - * @see elm_datetime_value_max_get() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_value_max_set(Evas_Object *obj, const struct tm *maxtime); +/** + * @brief Get the lower boundary of a field. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * @param obj The datetime object + * @param mintime Time structure. + * @return EINA_TRUE if minimum value is successfully returned. + * + * @see elm_datetime_value_min_set() + * @ingroup Datepicker + */ +EAPI Eina_Bool elm_datetime_value_min_get(const Evas_Object *obj, struct tm *mintime); - /** - * @brief Get the lower boundary of a field. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * @param obj The datetime object - * @param mintime Time structure. - * @return EINA_TRUE if minimum value is successfully returned. - * - * @see elm_datetime_value_min_set() - * @ingroup Datepicker - */ - EAPI Eina_Bool elm_datetime_value_min_get(const Evas_Object *obj, struct tm *mintime); +/** + * @brief Set the lower boundary of a field. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * @param obj The datetime object. + * @param mintime Time structure containing the minimum time value. + * @return EINA_TRUE if minimum value is accepted. + * + * @see elm_datetime_value_min_get() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_value_min_set(Evas_Object *obj, const struct tm *mintime); - /** - * @brief Set the lower boundary of a field. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * @param obj The datetime object. - * @param mintime Time structure containing the minimum time value. - * @return EINA_TRUE if minimum value is accepted. - * - * @see elm_datetime_value_min_get() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_value_min_set(Evas_Object *obj, const struct tm *mintime); +/** + * @brief Get the field limits of a field. + * + * Limits can be set to individual fields, independently, except for AM/PM field. + * Any field can display the values only in between these Minimum and Maximum limits unless + * the corresponding time value is restricted from MinTime to MaxTime. + * That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime. + * + * There is no provision to set the limits of AM/PM field. + * + * @param obj The datetime object + * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. + * @param min Reference to field's minimum value + * @param max Reference to field's maximum value + * + * @see elm_datetime_field_limit_set() + * @ingroup Datetime + */ +EAPI void elm_datetime_field_limit_get(const Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, int *min, int *max); - /** - * @brief Get the field limits of a field. - * - * Limits can be set to individual fields, independently, except for AM/PM field. - * Any field can display the values only in between these Minimum and Maximum limits unless - * the corresponding time value is restricted from MinTime to MaxTime. - * That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime. - * - * There is no provision to set the limits of AM/PM field. - * - * @param obj The datetime object - * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. - * @param min Reference to field's minimum value - * @param max Reference to field's maximum value - * - * @see elm_datetime_field_limit_set() - * @ingroup Datetime - */ - EAPI void elm_datetime_field_limit_get(const Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, int *min, int *max); +/** + * @brief Set the field limits of a field. + * + * Limits can be set to individual fields, independently, except for AM/PM field. + * Any field can display the values only in between these Minimum and Maximum limits unless + * the corresponding time value is restricted from MinTime to MaxTime. + * That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime. + * + * There is no provision to set the limits of AM/PM field. + * + * @param obj The datetime object + * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. + * @param min Reference to field's minimum value + * @param max Reference to field's maximum value + * + * @see elm_datetime_field_limit_set() + * @ingroup Datetime + */ +EAPI void elm_datetime_field_limit_set(Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, int min, int max); - /** - * @brief Set the field limits of a field. - * - * Limits can be set to individual fields, independently, except for AM/PM field. - * Any field can display the values only in between these Minimum and Maximum limits unless - * the corresponding time value is restricted from MinTime to MaxTime. - * That is, Min/ Max field limits always works under the limitations of MinTime/ MaxTime. - * - * There is no provision to set the limits of AM/PM field. - * - * @param obj The datetime object - * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. - * @param min Reference to field's minimum value - * @param max Reference to field's maximum value - * - * @see elm_datetime_field_limit_set() - * @ingroup Datetime - */ - EAPI void elm_datetime_field_limit_set(Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, int min, int max); +/** + * @brief Get the current value of a field. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * @param obj The datetime object. + * @param currtime Time structure. + * @return EINA_TRUE if current time is returned successfully. + * + * @see elm_datetime_field_value_set() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_value_get(const Evas_Object *obj, struct tm *currtime); - /** - * @brief Get the current value of a field. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * @param obj The datetime object. - * @param currtime Time structure. - * @return EINA_TRUE if current time is returned successfully. - * - * @see elm_datetime_field_value_set() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_value_get(const Evas_Object *obj, struct tm *currtime); +/** + * @brief Set the current value of a Datetime object. + * + * Year: years since 1900. Negative value represents year below 1900 (year + * value -30 represents 1870). Year default range is from 70 to 137. + * + * Month: default value range is from 0 to 11. + * + * Date: default value range is from 1 to 31 according to the month value. + * + * Hour: default value will be in terms of 24 hr format (0~23) + * + * Minute: default value range is from 0 to 59. + * + * + * @param obj The datetime object. + * @param newtime Time structure filled with values to be set. + * @return EINA_TRUE if current time is set successfully. + * + * @see elm_datetime_value_set() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_value_set(Evas_Object *obj, const struct tm *newtime); - /** - * @brief Set the current value of a Datetime object. - * - * Year: years since 1900. Negative value represents year below 1900 (year - * value -30 represents 1870). Year default range is from 70 to 137. - * - * Month: default value range is from 0 to 11. - * - * Date: default value range is from 1 to 31 according to the month value. - * - * Hour: default value will be in terms of 24 hr format (0~23) - * - * Minute: default value range is from 0 to 59. - * - * - * @param obj The datetime object. - * @param newtime Time structure filled with values to be set. - * @return EINA_TRUE if current time is set successfully. - * - * @see elm_datetime_value_set() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_value_set(Evas_Object *obj, const struct tm *newtime); +/** + * @brief Get whether a field can be visible/not + * + * @param obj The datetime object + * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc + * @return bool @c EINA_TRUE, if field can be visible. @c EINA_FALSE otherwise. + * + * @see elm_datetime_field_visible_set() + * @ingroup Datetime + */ +EAPI Eina_Bool elm_datetime_field_visible_get(const Evas_Object *obj, Elm_Datetime_Field_Type fieldtype); - /** - * @brief Get whether a field can be visible/not - * - * @param obj The datetime object - * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc - * @return bool @c EINA_TRUE, if field can be visible. @c EINA_FALSE otherwise. - * - * @see elm_datetime_field_visible_set() - * @ingroup Datetime - */ - EAPI Eina_Bool elm_datetime_field_visible_get(const Evas_Object *obj, Elm_Datetime_Field_Type fieldtype); +/** + * @brief Set a field to be visible or not. + * Setting this API True does not ensure that the field is visible, apart from + * this, the field's format must be present in Datetime overall format. + * If a field's visibility is set to False then it won't appear even though + * its format is present in overall format. + * So if and only if this API is set true and the corresponding field's format + * is present in Datetime format, the field is visible. + * + * By default the field visibility is set to True. + * + * @param obj The datetime object + * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. + * @param visible @c EINA_TRUE field can be visible, @c EINA_FALSE otherwise. + * + * @see elm_datetime_field_visible_get() + * @ingroup Datetime + */ +EAPI void elm_datetime_field_visible_set(Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, Eina_Bool visible); - /** - * @brief Set a field to be visible or not. - * Setting this API True does not ensure that the field is visible, apart from - * this, the field's format must be present in Datetime overall format. - * If a field's visibility is set to False then it won't appear even though - * its format is present in overall format. - * So if and only if this API is set true and the corresponding field's format - * is present in Datetime format, the field is visible. - * - * By default the field visibility is set to True. - * - * @param obj The datetime object - * @param fieldtype Type of the field. ELM_DATETIME_YEAR etc. - * @param visible @c EINA_TRUE field can be visible, @c EINA_FALSE otherwise. - * - * @see elm_datetime_field_visible_get() - * @ingroup Datetime - */ - EAPI void elm_datetime_field_visible_set(Evas_Object *obj, Elm_Datetime_Field_Type fieldtype, Eina_Bool visible); - - /** - * @} - */ +/** + * @} + */ diff --git a/legacy/elementary/src/lib/elm_debug.h b/legacy/elementary/src/lib/elm_debug.h index c81c666ae1..f5de943ec8 100644 --- a/legacy/elementary/src/lib/elm_debug.h +++ b/legacy/elementary/src/lib/elm_debug.h @@ -1,5 +1,6 @@ /** * @defgroup Debug Debug + * @ingroup Elementary * Don't use it unless you are sure. * * @{ diff --git a/legacy/elementary/src/lib/elm_entry.h b/legacy/elementary/src/lib/elm_entry.h index dce5f40f06..3660e3c103 100644 --- a/legacy/elementary/src/lib/elm_entry.h +++ b/legacy/elementary/src/lib/elm_entry.h @@ -1,5 +1,6 @@ /** * @defgroup Entry Entry + * @ingroup Elementary * * @image html img/widget/entry/preview-00.png * @image latex img/widget/entry/preview-00.eps width=\textwidth @@ -452,6 +453,8 @@ typedef Edje_Entry_Change_Info Elm_Entry_Change_Info; * * @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); @@ -469,6 +472,8 @@ EAPI Evas_Object *elm_entry_add(Evas_Object *parent); * @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); @@ -480,6 +485,8 @@ EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool si * on a single line. * * @see elm_entry_single_line_set() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj); @@ -491,6 +498,8 @@ EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj); * * @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); @@ -502,6 +511,8 @@ EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool passw * as asterisks (*). * * @see elm_entry_password_set() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj); @@ -512,6 +523,8 @@ EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj); * @param entry The text to be displayed * * @note Using this function bypasses text filters + * + * @ingroup Entry */ EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry); @@ -521,6 +534,8 @@ EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) * * @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); @@ -536,6 +551,8 @@ EAPI const char *elm_entry_entry_get(const Evas_Object *obj); * @param entry The text to be displayed * * @see elm_entry_markup_filter_append() + * + * @ingroup Entry */ EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry); @@ -548,6 +565,8 @@ EAPI void elm_entry_entry_append(Evas_Object *obj, const char *ent * * @param obj The entry object * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise. + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj); @@ -564,6 +583,8 @@ EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj); * * @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); @@ -593,6 +614,8 @@ EAPI const char *elm_entry_selection_get(const Evas_Object *obj); * * @param obj The entry object * @return The textblock object. + * + * @ingroup Entry */ EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj); @@ -605,6 +628,8 @@ EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj); * @param obj The entry object * * @see elm_entry_textblock_get() + * + * @ingroup Entry */ EAPI void elm_entry_calc_force(Evas_Object *obj); @@ -625,6 +650,8 @@ EAPI void elm_entry_calc_force(Evas_Object *obj); * @param entry The text to insert * * @see elm_entry_markup_filter_append() + * + * @ingroup Entry */ EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry); @@ -651,6 +678,8 @@ EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type * @return Wrap type * * @see also elm_entry_line_wrap_set() + * + * @ingroup Entry */ EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj); @@ -669,6 +698,8 @@ EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj); * @param obj The entry object * @param editable If EINA_TRUE, user input will be inserted in the entry, * if not, the entry is read-only and no user input is allowed. + * + * @ingroup Entry */ EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable); @@ -680,6 +711,8 @@ EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool edita * If false, it is not editable by the user * * @see elm_entry_editable_set() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj); @@ -687,6 +720,8 @@ EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj); * 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); @@ -694,6 +729,8 @@ EAPI void elm_entry_select_none(Evas_Object *obj); * This selects all text within the entry. * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_select_all(Evas_Object *obj); @@ -702,6 +739,8 @@ EAPI void elm_entry_select_all(Evas_Object *obj); * * @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); @@ -710,6 +749,8 @@ EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj); * * @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); @@ -718,6 +759,8 @@ EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj); * * @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); @@ -726,6 +769,8 @@ EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj); * * @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); @@ -733,6 +778,8 @@ EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj); * 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); @@ -740,6 +787,8 @@ EAPI void elm_entry_cursor_begin_set(Evas_Object *obj); * 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); @@ -747,6 +796,8 @@ EAPI void elm_entry_cursor_end_set(Evas_Object *obj); * 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); @@ -754,6 +805,8 @@ EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj); * 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); @@ -762,6 +815,8 @@ EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj); * 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); @@ -770,6 +825,8 @@ EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj); * 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); @@ -787,6 +844,8 @@ EAPI void elm_entry_cursor_selection_end(Evas_Object *obj); * EINA_FALSE otherwise. * * @see elm_entry_cursor_is_visible_format_get() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj); @@ -798,6 +857,8 @@ EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj); * if it's an invisible one or no format exists. * * @see elm_entry_cursor_is_format_get() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj); @@ -811,6 +872,8 @@ EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object * * @param obj The entry object * @return The text pointed by the cursors. + * + * @ingroup Entry */ EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj); @@ -827,6 +890,8 @@ EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj); * @param w returned geometry * @param h returned geometry * @return EINA_TRUE upon success, EINA_FALSE upon failure + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h); @@ -838,6 +903,8 @@ EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Ev * * @param obj The entry object * @param pos The position of the cursor + * + * @ingroup Entry */ EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos); @@ -846,6 +913,8 @@ EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos); * * @param obj The entry object * @return The cursor position + * + * @ingroup Entry */ EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj); @@ -853,6 +922,8 @@ EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj); * 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); @@ -860,6 +931,8 @@ EAPI void elm_entry_selection_cut(Evas_Object *obj); * 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); @@ -867,6 +940,8 @@ EAPI void elm_entry_selection_copy(Evas_Object *obj); * This executes a "paste" action in the entry. * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_selection_paste(Evas_Object *obj); @@ -877,6 +952,8 @@ EAPI void elm_entry_selection_paste(Evas_Object *obj); * @param obj The entry object * * @see elm_entry_context_menu_item_add() + * + * @ingroup Entry */ EAPI void elm_entry_context_menu_clear(Evas_Object *obj); @@ -898,6 +975,8 @@ EAPI void elm_entry_context_menu_clear(Evas_Object *obj); * @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); @@ -906,6 +985,8 @@ EAPI void elm_entry_context_menu_item_add(Evas_Object *obj, const * * @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); @@ -915,6 +996,8 @@ EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Ei * * @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); @@ -933,6 +1016,8 @@ EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *o * @param data The data passed to @p func * * @see @ref entry-items + * + * @ingroup Entry */ EAPI void elm_entry_item_provider_append(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data); @@ -945,6 +1030,8 @@ EAPI void elm_entry_item_provider_append(Evas_Object *obj, Elm_Ent * @param obj The entry object * @param func The function called to provide the item object * @param data The data passed to @p func + * + * @ingroup Entry */ EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data); @@ -957,6 +1044,8 @@ EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Elm_En * @param obj The entry object * @param func The function called to provide the item object * @param data The data passed to @p func + * + * @ingroup Entry */ EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data); @@ -975,6 +1064,8 @@ EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Elm_Ent * @param obj The entry object * @param func The function to use as text filter * @param data User data to pass to @p func + * + * @ingroup Entry */ EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data); @@ -987,6 +1078,8 @@ EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Ent * @param obj The entry object * @param func The function to use as text filter * @param data User data to pass to @p func + * + * @ingroup Entry */ EAPI void elm_entry_markup_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data); @@ -999,6 +1092,8 @@ EAPI void elm_entry_markup_filter_prepend(Evas_Object *obj, Elm_En * @param obj The entry object * @param func The filter function to remove * @param data The user data passed when adding the function + * + * @ingroup Entry */ EAPI void elm_entry_markup_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data); @@ -1010,6 +1105,8 @@ EAPI void elm_entry_markup_filter_remove(Evas_Object *obj, Elm_Ent * * @param s The string (in markup) to be converted * @return The converted string (in UTF-8). It should be freed. + * + * @ingroup Entry */ EAPI char *elm_entry_markup_to_utf8(const char *s); @@ -1021,6 +1118,8 @@ EAPI char *elm_entry_markup_to_utf8(const char *s); * * @param s The string (in UTF-8) to be converted * @return The converted string (in markup). It should be freed. + * + * @ingroup Entry */ EAPI char *elm_entry_utf8_to_markup(const char *s); @@ -1037,6 +1136,8 @@ EAPI char *elm_entry_utf8_to_markup(const char *s); * @param file The path to the file to load and save * @param format The file format * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format); @@ -1049,6 +1150,8 @@ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, E * @param obj The entry object * @param file The path to the file to load and save * @param format The file format + * + * @ingroup Entry */ EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format); @@ -1057,6 +1160,8 @@ EAPI void elm_entry_file_get(const Evas_Object *obj, const char ** * elm_entry_file_set() * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_file_save(Evas_Object *obj); @@ -1067,6 +1172,8 @@ EAPI void elm_entry_file_save(Evas_Object *obj); * @param autosave Autosave the loaded file or not * * @see elm_entry_file_set() + * + * @ingroup Entry */ EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave); @@ -1077,6 +1184,8 @@ EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autos * @return Autosave the loaded file or not * * @see elm_entry_file_set() + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj); @@ -1087,6 +1196,8 @@ EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj); * * @param obj The entry object * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise + * + * @ingroup Entry */ EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll); @@ -1098,6 +1209,8 @@ EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scr * * @param obj The entry object * @return The scrollable state + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj); @@ -1108,6 +1221,8 @@ EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj); * @param obj The entry object * @param setting EINA_TRUE if the object should be displayed, * EINA_FALSE if not. + * + * @ingroup Entry */ EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting); @@ -1118,6 +1233,8 @@ EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool s * @param obj The entry object * @param setting EINA_TRUE if the object should be displayed, * EINA_FALSE if not. + * + * @ingroup Entry */ EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting); @@ -1132,6 +1249,8 @@ EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool se * @param obj The entry object * @param h The horizontal scrollbar policy to apply * @param v The vertical scrollbar policy to apply + * + * @ingroup Entry */ EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v); @@ -1144,6 +1263,8 @@ EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scr * @param obj The entry object * @param h_bounce The horizontal bounce state * @param v_bounce The vertical bounce state + * + * @ingroup Entry */ EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce); @@ -1153,6 +1274,8 @@ EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounc * @param obj The Entry object * @param h_bounce Allow bounce horizontally * @param v_bounce Allow bounce vertically + * + * @ingroup Entry */ EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce); @@ -1161,6 +1284,8 @@ EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool * * * @param obj The entry object * @param layout layout type + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout); @@ -1171,6 +1296,8 @@ EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, E * @return layout type * * @see elm_entry_input_panel_layout_set + * + * @ingroup Entry */ EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj); @@ -1179,6 +1306,8 @@ EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object * * * @param obj The entry object * @param autocapital_type The type of autocapitalization + * + * @ingroup Entry */ EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type); @@ -1187,6 +1316,8 @@ EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm * * @param obj The entry object * @return autocapitalization type + * + * @ingroup Entry */ EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj); @@ -1195,6 +1326,8 @@ EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *ob * * @param obj The entry object * @param enabled If true, the input panel is appeared when entry is clicked or has a focus + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled); @@ -1203,6 +1336,8 @@ EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, * * @param obj The entry object * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj); @@ -1213,6 +1348,8 @@ EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE). * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_show(Evas_Object *obj); @@ -1223,6 +1360,8 @@ EAPI void elm_entry_input_panel_show(Evas_Object *obj); * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE) * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_hide(Evas_Object *obj); @@ -1233,6 +1372,8 @@ EAPI void elm_entry_input_panel_hide(Evas_Object *obj); * * @param obj The entry object * @param lang language to be set to the input panel. + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang); @@ -1243,6 +1384,8 @@ EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, * * @param obj The entry object * @return input panel language type + * + * @ingroup Entry */ EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj); @@ -1256,6 +1399,8 @@ EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object * @param obj The entry object * @param data The specific data to be set to the input panel. * @param len the length of data, in bytes, to send to the input panel + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len); @@ -1267,6 +1412,8 @@ EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, c * @param obj The entry object * @param data The specific data to be got from the input panel * @param len The length of data + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len); @@ -1277,6 +1424,8 @@ EAPI void elm_entry_input_panel_imdata_get(const Evas_Object * * * @param obj The entry object * @param return_key_type The type of "return" key on the input panel + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type); @@ -1287,6 +1436,8 @@ EAPI void elm_entry_input_panel_return_key_type_set(Evas_Objec * * @param obj The entry object * @return The type of "return" key on the input panel + * + * @ingroup Entry */ EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj); @@ -1296,6 +1447,8 @@ EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(c * @param obj The entry object * @param disabled The state to put in in: @c EINA_TRUE for * disabled, @c EINA_FALSE for enabled + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled); @@ -1304,6 +1457,8 @@ EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_O * * @param obj The entry object * @return EINA_TRUE if it should be disabled + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj); @@ -1316,6 +1471,8 @@ EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const * * @param obj The entry object * @param enabled If @p enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text. + * + * @ingroup Entry */ EAPI void elm_entry_input_panel_return_key_autoenabled_set(Evas_Object *obj, Eina_Bool enabled); @@ -1324,6 +1481,8 @@ EAPI void elm_entry_input_panel_return_key_autoenabled_set(Eva * * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_imf_context_reset(Evas_Object *obj); @@ -1332,6 +1491,8 @@ EAPI void elm_entry_imf_context_reset(Evas_Object *obj); * * @param obj The entry object * @param prediction Whether the entry should allow to use the text prediction. + * + * @ingroup Entry */ EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction); @@ -1340,6 +1501,8 @@ EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Ein * * @param obj The entry object * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE. + * + * @ingroup Entry */ EAPI Eina_Bool elm_entry_prediction_allow_get(const Evas_Object *obj); @@ -1386,6 +1549,8 @@ struct _Elm_Entry_Filter_Limit_Size * * This filter, like any others, does not apply when setting the entry text * directly with elm_object_text_set(). + * + * @ingroup Entry */ EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text); @@ -1425,6 +1590,8 @@ struct _Elm_Entry_Filter_Accept_Set * * This filter, like any others, does not apply when setting the entry text * directly with elm_object_text_set() + * + * @ingroup Entry */ EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text); @@ -1438,6 +1605,8 @@ EAPI void elm_entry_filter_accept_set(void *data, Evas_Object * * @param obj The entry object * @return The input method context (Ecore_IMF_Context *) in entry. + * + * @ingroup Entry */ EAPI void *elm_entry_imf_context_get(Evas_Object *obj); @@ -1466,6 +1635,8 @@ typedef enum { * @param obj The entry object * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT. + * + * @ingroup Entry */ EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode); @@ -1478,6 +1649,8 @@ EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode * @param obj The entry object * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT. + * + * @ingroup Entry */ EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Evas_Object *obj); @@ -1489,6 +1662,8 @@ EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Evas_Object *obj); * * @param obj The entry object * @param parent The object to use as parent for the hover + * + * @ingroup Entry */ EAPI void elm_entry_anchor_hover_parent_set(Evas_Object *obj, Evas_Object *parent); @@ -1501,6 +1676,8 @@ EAPI void elm_entry_anchor_hover_parent_set(Evas_Object * * * @param obj The entry object * @return The object used as parent for the hover, NULL if none is set. + * + * @ingroup Entry */ EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Object *obj); @@ -1516,6 +1693,8 @@ EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Ob * @param style The style to use for the underlying hover * * @see elm_object_style_set() + * + * @ingroup Entry */ EAPI void elm_entry_anchor_hover_style_set(Evas_Object *obj, const char *style); @@ -1528,6 +1707,8 @@ EAPI void elm_entry_anchor_hover_style_set(Evas_Object *o * @return The style to use by the hover. NULL means the default is used. * * @see elm_object_style_set() + * + * @ingroup Entry */ EAPI const char *elm_entry_anchor_hover_style_get(const Evas_Object *obj); @@ -1539,6 +1720,8 @@ EAPI const char *elm_entry_anchor_hover_style_get(const Evas_Obj * terminates this popup, returning the entry to its normal state. * * @param obj The entry object + * + * @ingroup Entry */ EAPI void elm_entry_anchor_hover_end(Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_finger.h b/legacy/elementary/src/lib/elm_finger.h index f86482ac0c..cfe5d2ebd8 100644 --- a/legacy/elementary/src/lib/elm_finger.h +++ b/legacy/elementary/src/lib/elm_finger.h @@ -1,5 +1,6 @@ /** * @defgroup Fingers Fingers + * @ingroup Elementary * * Elementary is designed to be finger-friendly for touchscreens, * and so in addition to scaling for display resolution, it can diff --git a/legacy/elementary/src/lib/elm_flip.h b/legacy/elementary/src/lib/elm_flip.h index 9e5d77c9fc..b292c77bf0 100644 --- a/legacy/elementary/src/lib/elm_flip.h +++ b/legacy/elementary/src/lib/elm_flip.h @@ -1,5 +1,6 @@ /** * @defgroup Flip Flip + * @ingroup Elementary * * @image html img/widget/flip/preview-00.png * @image latex img/widget/flip/preview-00.eps @@ -68,6 +69,8 @@ typedef enum * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Flip */ EAPI Evas_Object *elm_flip_add(Evas_Object *parent); @@ -77,6 +80,8 @@ EAPI Evas_Object *elm_flip_add(Evas_Object *parent); * @param obj The flip object * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is * showing. + * + * @ingroup Flip */ Eina_Bool elm_flip_front_visible_get(const Evas_Object *obj); @@ -89,6 +94,8 @@ Eina_Bool elm_flip_front_visible_get(const Evas_Object *obj); * @param y The Y coordinate * * @warning This function currently does nothing. + * + * @ingroup Flip */ EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y); @@ -137,6 +144,8 @@ EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord * * @image html elm_flip.png * @image latex elm_flip.eps width=\textwidth + * + * @ingroup Flip */ EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode); @@ -162,6 +171,8 @@ EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode); * @note ELM_FLIP_INTERACTION_ROTATE won't cause * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to * happen, those can only be achieved with elm_flip_go(); + * + * @ingroup Flip */ EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode); @@ -172,6 +183,8 @@ EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_In * @return The interactive flip mode * * Returns the interactive flip mode set by elm_flip_interaction_set() + * + * @ingroup Flip */ EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj); @@ -187,6 +200,8 @@ EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj); * call this function once for each direction that should be enabled. * * @see elm_flip_interaction_set() + * + * @ingroup Flip */ EAPI void elm_flip_interaction_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled); @@ -200,6 +215,8 @@ EAPI void elm_flip_interaction_direction_enabled_set(Evas_Object * Gets the enabled state set by elm_flip_interaction_direction_enabled_set() * * @see elm_flip_interaction_set() + * + * @ingroup Flip */ EAPI Eina_Bool elm_flip_interaction_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir); @@ -216,6 +233,8 @@ EAPI Eina_Bool elm_flip_interaction_direction_enabled_get(Evas_Object * smaller than the finger size set(as set in your Elementary configuration). * * @see elm_flip_interaction_set() + * + * @ingroup Flip */ EAPI void elm_flip_interaction_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize); @@ -228,6 +247,8 @@ EAPI void elm_flip_interaction_direction_hitsize_set(Evas_Object * * Returns the amount of sensitive area set by * elm_flip_interaction_direction_hitsize_set(). + * + * @ingroup Flip */ EAPI double elm_flip_interaction_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir); diff --git a/legacy/elementary/src/lib/elm_flipselector.h b/legacy/elementary/src/lib/elm_flipselector.h index 2f84d4a474..03df5bcfc2 100644 --- a/legacy/elementary/src/lib/elm_flipselector.h +++ b/legacy/elementary/src/lib/elm_flipselector.h @@ -1,5 +1,6 @@ /** * @defgroup Flipselector Flip Selector + * @ingroup Elementary * * @image html img/widget/flipselector/preview-00.png * @image latex img/widget/flipselector/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_focus.h b/legacy/elementary/src/lib/elm_focus.h index 5afd697840..59fc97cdc5 100644 --- a/legacy/elementary/src/lib/elm_focus.h +++ b/legacy/elementary/src/lib/elm_focus.h @@ -1,5 +1,6 @@ /** * @defgroup Focus Focus + * @ingroup Elementary * * An Elementary application has, at all times, one (and only one) * @b focused object. This is what determines where the input diff --git a/legacy/elementary/src/lib/elm_font.h b/legacy/elementary/src/lib/elm_font.h index 0739954a3e..cf21df7530 100644 --- a/legacy/elementary/src/lib/elm_font.h +++ b/legacy/elementary/src/lib/elm_font.h @@ -1,5 +1,6 @@ /** * @defgroup Fonts Elementary Fonts + * @ingroup Elementary * * These are functions dealing with font rendering, selection and the * like for Elementary applications. One might fetch which system diff --git a/legacy/elementary/src/lib/elm_frame.h b/legacy/elementary/src/lib/elm_frame.h index b963e778c3..74eba2ab65 100644 --- a/legacy/elementary/src/lib/elm_frame.h +++ b/legacy/elementary/src/lib/elm_frame.h @@ -1,5 +1,6 @@ /** * @defgroup Frame Frame + * @ingroup Elementary * * @image html img/widget/frame/preview-00.png * @image latex img/widget/frame/preview-00.eps @@ -44,6 +45,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Frame */ EAPI Evas_Object *elm_frame_add(Evas_Object *parent); @@ -55,6 +58,8 @@ EAPI Evas_Object *elm_frame_add(Evas_Object *parent); * When @p enable is EINA_TRUE, clicking a frame's label will collapse the frame * vertically, shrinking it to the height of the label. * By default, this is DISABLED. + * + * @ingroup Frame */ EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool autocollapse); @@ -66,6 +71,8 @@ EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool autocollapse); * When this returns EINA_TRUE, clicking a frame's label will collapse the frame * vertically, shrinking it to the height of the label. * By default, this is DISABLED. + * + * @ingroup Frame */ EAPI Eina_Bool elm_frame_autocollapse_get(const Evas_Object *obj); @@ -75,6 +82,8 @@ EAPI Eina_Bool elm_frame_autocollapse_get(const Evas_Object *obj); * @param collapse true to collapse, false to expand * * Use this to toggle the collapsed state of a frame, bypassing animations. + * + * @ingroup Frame */ EAPI void elm_frame_collapse_set(Evas_Object *obj, Eina_Bool collapse); @@ -84,6 +93,8 @@ EAPI void elm_frame_collapse_set(Evas_Object *obj, Eina_Bool collapse); * @return true if collapsed, false otherwise * * Use this to determine the collapse state of a frame. + * + * @ingroup Frame */ EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj); @@ -93,6 +104,8 @@ EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj); * @param collapse true to collapse, false to expand * * Use this to toggle the collapsed state of a frame, triggering animations. + * + * @ingroup Frame */ EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse); diff --git a/legacy/elementary/src/lib/elm_general.h b/legacy/elementary/src/lib/elm_general.h index 8c7d300a4b..08cd205424 100644 --- a/legacy/elementary/src/lib/elm_general.h +++ b/legacy/elementary/src/lib/elm_general.h @@ -1,5 +1,6 @@ /** * @defgroup General General + * @ingroup Elementary * * @brief General Elementary API. Functions that don't relate to * Elementary objects specifically. diff --git a/legacy/elementary/src/lib/elm_gengrid.h b/legacy/elementary/src/lib/elm_gengrid.h index c8d74ec2c7..12297b9851 100644 --- a/legacy/elementary/src/lib/elm_gengrid.h +++ b/legacy/elementary/src/lib/elm_gengrid.h @@ -1,5 +1,6 @@ /** * @defgroup Gengrid Gengrid (Generic grid) + * @ingroup Elementary * * This widget aims to position objects in a grid layout while * actually creating and rendering only the visible ones, using the diff --git a/legacy/elementary/src/lib/elm_genlist.h b/legacy/elementary/src/lib/elm_genlist.h index fe02237374..6f49429304 100644 --- a/legacy/elementary/src/lib/elm_genlist.h +++ b/legacy/elementary/src/lib/elm_genlist.h @@ -1,5 +1,6 @@ /** * @defgroup Genlist Genlist + * @ingroup Elementary * * @image html img/widget/genlist/preview-00.png * @image latex img/widget/genlist/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_gesture_layer.h b/legacy/elementary/src/lib/elm_gesture_layer.h index eb14897bbc..48cd0278be 100644 --- a/legacy/elementary/src/lib/elm_gesture_layer.h +++ b/legacy/elementary/src/lib/elm_gesture_layer.h @@ -1,5 +1,7 @@ /** * @defgroup Elm_Gesture_Layer Gesture Layer + * @ingroup Elementary + * * Gesture Layer Usage: * * Use Gesture Layer to detect gestures. diff --git a/legacy/elementary/src/lib/elm_getting_started.h b/legacy/elementary/src/lib/elm_getting_started.h index 1931eb0eaf..9b11a54540 100644 --- a/legacy/elementary/src/lib/elm_getting_started.h +++ b/legacy/elementary/src/lib/elm_getting_started.h @@ -1,5 +1,6 @@ /** * @defgroup Start Getting Started + * @ingroup Elementary * * To write an Elementary app, you can get started with the following: * diff --git a/legacy/elementary/src/lib/elm_glview.h b/legacy/elementary/src/lib/elm_glview.h index 636e9e1d9d..30dff2bc8a 100644 --- a/legacy/elementary/src/lib/elm_glview.h +++ b/legacy/elementary/src/lib/elm_glview.h @@ -1,5 +1,6 @@ /** * @defgroup GLView GLView + * @ingroup Elementary * * A GLView widget allows for simple GL rendering in elementary environment. * GLView hides all the complicated evas_gl details so that the user only diff --git a/legacy/elementary/src/lib/elm_grid.h b/legacy/elementary/src/lib/elm_grid.h index d458ec3a03..816802388c 100644 --- a/legacy/elementary/src/lib/elm_grid.h +++ b/legacy/elementary/src/lib/elm_grid.h @@ -1,5 +1,6 @@ /** * @defgroup Grid Grid + * @ingroup Elementary * * The grid is a grid layout widget that lays out a series of children as a * fixed "grid" of widgets using a given percentage of the grid width and diff --git a/legacy/elementary/src/lib/elm_hover.h b/legacy/elementary/src/lib/elm_hover.h index 18722f95be..21dd4b586e 100644 --- a/legacy/elementary/src/lib/elm_hover.h +++ b/legacy/elementary/src/lib/elm_hover.h @@ -1,5 +1,6 @@ /** * @defgroup Hover Hover + * @ingroup Elementary * * @image html img/widget/hover/preview-00.png * @image latex img/widget/hover/preview-00.eps @@ -99,6 +100,8 @@ typedef enum * * @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); @@ -109,6 +112,8 @@ EAPI Evas_Object *elm_hover_add(Evas_Object *parent); * @param target The object to center the hover onto. * * This function will cause the hover to be centered on the target object. + * + * @ingroup Hover */ EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target); @@ -119,6 +124,8 @@ EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target); * @return The target object for the hover. * * @see elm_hover_target_set() + * + * @ingroup Hover */ EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj); @@ -130,6 +137,8 @@ EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj); * * This function will cause the hover to take up the entire space that the * parent object fills. + * + * @ingroup Hover */ EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent); @@ -140,6 +149,8 @@ EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent); * @return The parent object to locate the hover over. * * @see elm_hover_parent_set() + * + * @ingroup Hover */ EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj); @@ -168,6 +179,8 @@ EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj); * returned position may be in either axis. * * @see elm_object_part_content_set() + * + * @ingroup Hover */ EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis); @@ -177,6 +190,8 @@ EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, El * @param obj The hover object * Use this function to simulate clicking outside the hover to dismiss it. * In this way, the hover will be hidden and the "clicked" signal will be emitted. + * + * @ingroup Hover */ EAPI void elm_hover_dismiss(Evas_Object *obj); /** diff --git a/legacy/elementary/src/lib/elm_icon.h b/legacy/elementary/src/lib/elm_icon.h index 3f4b078d18..0cbae8802f 100644 --- a/legacy/elementary/src/lib/elm_icon.h +++ b/legacy/elementary/src/lib/elm_icon.h @@ -1,5 +1,6 @@ /** * @defgroup Icon Icon + * @ingroup Elementary * * @image html img/widget/icon/preview-00.png * @image latex img/widget/icon/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_image.h b/legacy/elementary/src/lib/elm_image.h index 465c0d3402..59a904f8c4 100644 --- a/legacy/elementary/src/lib/elm_image.h +++ b/legacy/elementary/src/lib/elm_image.h @@ -1,5 +1,6 @@ /** * @defgroup Image Image + * @ingroup Elementary * * @image html img/widget/image/preview-00.png * @image latex img/widget/image/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_index.h b/legacy/elementary/src/lib/elm_index.h index 82793a7ae6..33e41be8be 100644 --- a/legacy/elementary/src/lib/elm_index.h +++ b/legacy/elementary/src/lib/elm_index.h @@ -1,5 +1,6 @@ /** * @defgroup Index Index + * @ingroup Elementary * * @image html img/widget/index/preview-00.png * @image latex img/widget/index/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_label.h b/legacy/elementary/src/lib/elm_label.h index 0887ca1077..7fdc619247 100644 --- a/legacy/elementary/src/lib/elm_label.h +++ b/legacy/elementary/src/lib/elm_label.h @@ -1,5 +1,6 @@ /** * @defgroup Label Label + * @ingroup Elementary * * @image html img/widget/label/preview-00.png * @image latex img/widget/label/preview-00.eps @@ -36,6 +37,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Label */ EAPI Evas_Object *elm_label_add(Evas_Object *parent); @@ -50,6 +53,8 @@ EAPI Evas_Object *elm_label_add(Evas_Object *parent); * @li ELM_WRAP_CHAR - wrap between characters * @li ELM_WRAP_WORD - wrap between words * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap + * + * @ingroup Label */ EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap); @@ -60,6 +65,8 @@ EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_W * @return Wrap type * * @see elm_label_line_wrap_set() + * + * @ingroup Label */ EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj); @@ -72,6 +79,8 @@ EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) * This function sets the maximum width size hint of the label. * * @warning This is only relevant if the label is inside a container. + * + * @ingroup Label */ EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w); @@ -82,6 +91,8 @@ EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas * @return The wrap width in pixels at a minimum where words need to wrap * * @see elm_label_wrap_width_set() + * + * @ingroup Label */ EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj); @@ -96,6 +107,8 @@ EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj * * @warning This doesn't work with slide(elm_label_slide_set()) or if the * chosen wrap method was ELM_WRAP_WORD. + * + * @ingroup Label */ EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis); @@ -106,6 +119,8 @@ EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_B * @return If true, an ellipsis will be shown at the end of the label area. * * @see elm_label_ellipsis_set() + * + * @ingroup Label */ EAPI Eina_Bool elm_label_ellipsis_get(const Evas_Object *obj); @@ -120,6 +135,8 @@ EAPI Eina_Bool elm_label_ellipsis_get(const Evas_Object *obj); * * @warning This only works with the themes "slide_short", "slide_long" and * "slide_bounce". + * + * @ingroup Label */ EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide); @@ -130,6 +147,8 @@ EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool * @return If true, sliding effect is shown. * * @see elm_label_slide_set() + * + * @ingroup Label */ EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj); @@ -139,6 +158,8 @@ EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj); * @param obj The label object * @param duration The duration in seconds in moving text from slide begin position * to slide end position + * + * @ingroup Label */ EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration); @@ -149,6 +170,8 @@ EAPI void elm_label_slide_duration_set(Evas_Object *obj, * @return The duration time in moving text from slide begin position to slide end position * * @see elm_label_slide_duration_set() + * + * @ingroup Label */ EAPI double elm_label_slide_duration_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_layout.h b/legacy/elementary/src/lib/elm_layout.h index 1f87fd4b58..cc45e11337 100644 --- a/legacy/elementary/src/lib/elm_layout.h +++ b/legacy/elementary/src/lib/elm_layout.h @@ -1,5 +1,6 @@ /** * @defgroup Layout Layout + * @ingroup Elementary * * @image html img/widget/layout/preview-00.png * @image latex img/widget/layout/preview-00.eps width=\textwidth diff --git a/legacy/elementary/src/lib/elm_menu.h b/legacy/elementary/src/lib/elm_menu.h index e9382cea1e..36a04236ef 100644 --- a/legacy/elementary/src/lib/elm_menu.h +++ b/legacy/elementary/src/lib/elm_menu.h @@ -1,5 +1,6 @@ /** * @defgroup Menu Menu + * @ingroup Elementary * * @image html img/widget/menu/preview-00.png * @image latex img/widget/menu/preview-00.eps @@ -35,6 +36,8 @@ * * @param parent The parent object. * @return The new object or NULL if it cannot be created. + * + * @ingroup Menu */ EAPI Evas_Object *elm_menu_add(Evas_Object *parent); @@ -43,6 +46,8 @@ EAPI Evas_Object *elm_menu_add(Evas_Object *parent); * * @param obj The menu object. * @param parent The new parent. + * + * @ingroup Menu */ EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent); @@ -53,6 +58,8 @@ EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Obj * @return The parent. * * @see elm_menu_parent_set() + * + * @ingroup Menu */ EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj); @@ -66,6 +73,8 @@ EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj); * Sets the top-left position of the menu to (@p x,@p y). * * @note @p x and @p y coordinates are relative to parent. + * + * @ingroup Menu */ EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); @@ -76,6 +85,8 @@ EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, * @return void * * Hides the menu and all it's sub-menus. + * + * @ingroup Menu */ EAPI void elm_menu_close(Evas_Object *obj); @@ -84,6 +95,8 @@ EAPI void elm_menu_close(Evas_Object *obj); * * @param obj The menu object * @return An Eina_List* of @p item's items + * + * @ingroup Menu */ EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj); @@ -95,6 +108,7 @@ EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj); * * @warning Don't manipulate this object! * + * @ingroup Menu */ EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it); @@ -108,6 +122,8 @@ EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item * @param func Function called when the user select the item. * @param data Data sent by the callback. * @return Returns the new item. + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data); @@ -118,6 +134,8 @@ EAPI Elm_Object_Item *elm_menu_item_add(Evas_Object *obj, Elm_Object * @param icon The name of icon object to set for the content of @p item * * Once this icon is set, any previously set icon will be deleted. + * + * @ingroup Menu */ EAPI void elm_menu_item_icon_name_set(Elm_Object_Item *it, const char *icon); @@ -128,6 +146,8 @@ EAPI void elm_menu_item_icon_name_set(Elm_Object_Item *i * @return The string representation of @p item's icon or NULL * * @see elm_menu_item_icon_name_set() + * + * @ingroup Menu */ EAPI const char *elm_menu_item_icon_name_get(const Elm_Object_Item *it); @@ -136,6 +156,8 @@ EAPI const char *elm_menu_item_icon_name_get(const Elm_Object_I * * @param it The menu item object. * @param selected The selected/unselected state of the item + * + * @ingroup Menu */ EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected); @@ -146,6 +168,8 @@ EAPI void elm_menu_item_selected_set(Elm_Object_Item *it * @return The selected/unselected state of the item * * @see elm_menu_item_selected_set() + * + * @ingroup Menu */ EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it); @@ -157,6 +181,8 @@ EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_It * @return The created item or NULL on failure * * This is item is a @ref Separator. + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent); @@ -167,6 +193,8 @@ EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, * @return If true, @p item is a separator * * @see elm_menu_item_separator_add() + * + * @ingroup Menu */ EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it); @@ -177,6 +205,8 @@ EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it * @return An Eina_List* of @p item's subitems * * @see elm_menu_add() + * + * @ingroup Menu */ EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it); @@ -190,6 +220,8 @@ EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_It * For a sub-menu, this number is relative to the first item in the sub-menu. * * @note Index values begin with 0 + * + * @ingroup Menu */ EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it); @@ -201,6 +233,8 @@ EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item * * @see elm_menu_item_selected_get() * @see elm_menu_item_selected_set() + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object *obj); @@ -209,6 +243,8 @@ EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * * * @param obj The menu object * @return The last item, or NULL if none + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object *obj); @@ -217,6 +253,8 @@ EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object *obj) * * @param obj The menu object * @return The first item, or NULL if none + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object *obj); @@ -225,6 +263,8 @@ EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object *obj * * @param it The menu item object. * @return The item after it, or NULL if none + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it); @@ -233,6 +273,8 @@ EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item * * * @param it The menu item object. * @return The item before it, or NULL if none + * + * @ingroup Menu */ EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it); diff --git a/legacy/elementary/src/lib/elm_mirroring.h b/legacy/elementary/src/lib/elm_mirroring.h index fcedfa9626..24baa481f8 100644 --- a/legacy/elementary/src/lib/elm_mirroring.h +++ b/legacy/elementary/src/lib/elm_mirroring.h @@ -1,5 +1,6 @@ /** * @defgroup Mirroring Mirroring + * @ingroup Elementary * * These functions allow you to set ui-mirroring on specific * widgets or the whole interface. Widgets can be in one of two @@ -17,6 +18,8 @@ * * @param obj The widget. * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise + * + * @ingroup Mirroring */ EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj); @@ -25,6 +28,8 @@ EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj); * * @param obj The widget. * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it. + * + * @ingroup Mirroring */ EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored); @@ -34,7 +39,8 @@ EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored); * @param obj The widget. * @return mirrored mode setting of the object. * - **/ + * @ingroup Mirroring + */ EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj); /** @@ -43,6 +49,8 @@ EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj); * elm_mirrored_set(). * @param obj The widget. * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual. + * + * @ingroup Mirroring */ EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic); diff --git a/legacy/elementary/src/lib/elm_notify.h b/legacy/elementary/src/lib/elm_notify.h index 4354621034..bd0550515d 100644 --- a/legacy/elementary/src/lib/elm_notify.h +++ b/legacy/elementary/src/lib/elm_notify.h @@ -1,5 +1,6 @@ /** * @defgroup Notify Notify + * @ingroup Elementary * * @image html img/widget/notify/preview-00.png * @image latex img/widget/notify/preview-00.eps @@ -53,6 +54,8 @@ typedef enum * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Notify */ EAPI Evas_Object *elm_notify_add(Evas_Object *parent); @@ -64,6 +67,8 @@ EAPI Evas_Object *elm_notify_add(Evas_Object *parent); * * Once the parent object is set, a previously set one will be disconnected * and replaced. + * + * @ingroup Notify */ EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent); @@ -74,6 +79,8 @@ EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_O * @return The parent * * @see elm_notify_parent_set() + * + * @ingroup Notify */ EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj); @@ -86,6 +93,8 @@ EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj); * Sets the position in which the notify will appear in its parent. * * @see @ref Elm_Notify_Orient for possible values. + * + * @ingroup Notify */ EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient); @@ -96,6 +105,8 @@ EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_No * * @see elm_notify_orient_set() * @see Elm_Notify_Orient + * + * @ingroup Notify */ EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj); @@ -116,6 +127,8 @@ EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj); * * @note If the value > 0.0 and the notify is previously visible, the * timer will be started with this value, canceling any running timer. + * + * @ingroup Notify */ EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout); @@ -124,6 +137,8 @@ EAPI void elm_notify_timeout_set(Evas_Object *obj, doubl * @param obj the notify object * * @see elm_notify_timeout_set() + * + * @ingroup Notify */ EAPI double elm_notify_timeout_get(const Evas_Object *obj); @@ -138,6 +153,8 @@ EAPI double elm_notify_timeout_get(const Evas_Object *obj) * by the others widgets, else the events are blocked. * * @note The default value is EINA_TRUE. + * + * @ingroup Notify */ EAPI void elm_notify_allow_events_set(Evas_Object *obj, Eina_Bool allow); @@ -146,6 +163,8 @@ EAPI void elm_notify_allow_events_set(Evas_Object *obj, * @param obj the notify object * * @see elm_notify_allow_events_set() + * + * @ingroup Notify */ EAPI Eina_Bool elm_notify_allow_events_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_panel.h b/legacy/elementary/src/lib/elm_panel.h index c41fae8494..391d447815 100644 --- a/legacy/elementary/src/lib/elm_panel.h +++ b/legacy/elementary/src/lib/elm_panel.h @@ -1,5 +1,6 @@ /** * @defgroup Panel Panel + * @ingroup Elementary * * @image html img/widget/panel/preview-00.png * @image latex img/widget/panel/preview-00.eps @@ -40,6 +41,8 @@ typedef enum * @param parent The parent object * * @return The panel object, or NULL on failure + * + * @ingroup Panel */ EAPI Evas_Object *elm_panel_add(Evas_Object *parent); @@ -53,6 +56,8 @@ EAPI Evas_Object *elm_panel_add(Evas_Object *parent); * @li ELM_PANEL_ORIENT_RIGHT * * Sets from where the panel will (dis)appear. + * + * @ingroup Panel */ EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient); @@ -61,6 +66,8 @@ EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Pan * * @param obj The panel object * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure. + * + * @ingroup Panel */ EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj); @@ -69,6 +76,8 @@ EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj); * * @param obj The panel object * @param hidden If true, the panel will run the animation to disappear. + * + * @ingroup Panel */ EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden); @@ -77,6 +86,8 @@ EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bo * * @param obj The panel object * @return EINA_TRUE if it is hidden state + * + * @ingroup Panel */ EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj); @@ -84,6 +95,8 @@ EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj); * @brief Toggle the hidden state of the panel from code * * @param obj The panel object + * + * @ingroup Panel */ EAPI void elm_panel_toggle(Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_photo.h b/legacy/elementary/src/lib/elm_photo.h index 1ebbaf064f..b5e9d78491 100644 --- a/legacy/elementary/src/lib/elm_photo.h +++ b/legacy/elementary/src/lib/elm_photo.h @@ -1,5 +1,6 @@ /** * @defgroup Photo Photo + * @ingroup Elementary * * For displaying a photo, for ex., a person (contact). Simple, yet * with a very specific purpose. diff --git a/legacy/elementary/src/lib/elm_photocam.h b/legacy/elementary/src/lib/elm_photocam.h index 9043f7c187..2adb1b0b23 100644 --- a/legacy/elementary/src/lib/elm_photocam.h +++ b/legacy/elementary/src/lib/elm_photocam.h @@ -1,5 +1,6 @@ /** * @defgroup Photocam Photocam + * @ingroup Elementary * * @image html img/widget/photocam/preview-00.png * @image latex img/widget/photocam/preview-00.eps @@ -54,6 +55,8 @@ typedef enum * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Photocam */ EAPI Evas_Object *elm_photocam_add(Evas_Object *parent); @@ -70,6 +73,8 @@ EAPI Evas_Object *elm_photocam_add(Evas_Object *parent); * adjust its size at this point and begin a background load process for this * photo that at some time in the future will be displayed at the full * quality needed. + * + * @ingroup Photocam */ EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file); @@ -80,6 +85,8 @@ EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char * * @return Returns the path * * @see elm_photocam_file_set() + * + * @ingroup Photocam */ EAPI const char *elm_photocam_file_get(const Evas_Object *obj); @@ -94,6 +101,8 @@ EAPI const char *elm_photocam_file_get(const Evas_Object *obj); * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must * be greater than 0. It is suggested to stick to powers of 2. (1, 2, 4, 8, * 16, 32, etc.). + * + * @ingroup Photocam */ EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom); @@ -111,6 +120,8 @@ EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) * * @see elm_photocam_zoom_set() * @see elm_photocam_zoom_mode_set() + * + * @ingroup Photocam */ EAPI double elm_photocam_zoom_get(const Evas_Object *obj); @@ -129,6 +140,8 @@ EAPI double elm_photocam_zoom_get(const Evas_Object *obj); * the photo fits EXACTLY inside the scroll frame with no pixels outside this * region. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no * pixels within the frame are left unfilled. + * + * @ingroup Photocam */ EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode); @@ -141,6 +154,8 @@ EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Pho * This gets the current zoom mode of the photocam object. * * @see elm_photocam_zoom_mode_set() + * + * @ingroup Photocam */ EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj); @@ -154,6 +169,8 @@ EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj); * This gets the current photo pixel width and height (for the original). * The size will be returned in the integers @p w and @p h that are pointed * to. + * + * @ingroup Photocam */ EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h); @@ -168,6 +185,8 @@ EAPI void elm_photocam_image_size_get(const Evas_Object *obj, * * @see elm_photocam_image_region_show() * @see elm_photocam_image_region_bring_in() + * + * @ingroup Photocam */ EAPI void elm_photocam_image_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h); @@ -181,6 +200,8 @@ EAPI void elm_photocam_image_region_get(const Evas_Object *obj * @param h Height of region in image original pixels * * This shows the region of the image without using animation. + * + * @ingroup Photocam */ EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h); @@ -194,6 +215,8 @@ EAPI void elm_photocam_image_region_show(Evas_Object *obj, int * @param h Height of region in image original pixels * * This shows the region of the image using animation. + * + * @ingroup Photocam */ EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h); @@ -207,6 +230,8 @@ EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, * photocam. The default is off. This will stop zooming using animation on * zoom level changes and change instantly. This will stop any existing * animations that are running. + * + * @ingroup Photocam */ EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused); @@ -219,6 +244,8 @@ EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool * This gets the current paused state for the photocam object. * * @see elm_photocam_paused_set() + * + * @ingroup Photocam */ EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj); @@ -231,6 +258,8 @@ EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj); * This gets the internal image object inside photocam. Do not modify it. It * is for inspection only, and hooking callbacks to. Nothing else. It may be * deleted at any time as well. + * + * @ingroup Photocam */ EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj); @@ -240,6 +269,8 @@ EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *o * @param obj The photocam object * @param h_bounce set this to @c EINA_TRUE for horizontal bouncing * @param v_bounce set this to @c EINA_TRUE for vertical bouncing + * + * @ingroup Photocam */ EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce); @@ -251,6 +282,8 @@ EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool * @param v_bounce vertical bouncing * * @see elm_photocam_bounce_set() + * + * @ingroup Photocam */ EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce); @@ -262,8 +295,10 @@ EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina * * This sets the gesture state to on(EINA_TRUE) or off (EINA_FALSE) for * photocam. The default is off. This will start multi touch zooming. + * + * @ingroup Photocam */ -EAPI void elm_photocam_gesture_enabled_set(Evas_Object *obj, Eina_Bool gesture); +EAPI void elm_photocam_gesture_enabled_set(Evas_Object *obj, Eina_Bool gesture); /** * @brief Get the gesture state for photocam. @@ -274,8 +309,10 @@ EAPI void elm_photocam_gesture_enabled_set(Evas_Object *obj, Eina_Bool gest * This gets the current gesture state for the photocam object. * * @see elm_photocam_gesture_enabled_set() + * + * @ingroup Photocam */ -EAPI Eina_Bool elm_photocam_gesture_enabled_get(const Evas_Object *obj); +EAPI Eina_Bool elm_photocam_gesture_enabled_get(const Evas_Object *obj); /** * @} */ diff --git a/legacy/elementary/src/lib/elm_plug.h b/legacy/elementary/src/lib/elm_plug.h index 01afbbd7b1..ed79d85bb4 100644 --- a/legacy/elementary/src/lib/elm_plug.h +++ b/legacy/elementary/src/lib/elm_plug.h @@ -1,5 +1,6 @@ /** * @defgroup Plug Plug + * @ingroup Elementary * * An object that allows one to show an image which other process created. * It can be used anywhere like any other elementary widget. diff --git a/legacy/elementary/src/lib/elm_progressbar.h b/legacy/elementary/src/lib/elm_progressbar.h index ce2d217fd6..69475dc376 100644 --- a/legacy/elementary/src/lib/elm_progressbar.h +++ b/legacy/elementary/src/lib/elm_progressbar.h @@ -1,5 +1,6 @@ /** * @defgroup Progressbar Progress bar + * @ingroup Elementary * * The progress bar is a widget for visually representing the * progress status of a given job/task. diff --git a/legacy/elementary/src/lib/elm_radio.h b/legacy/elementary/src/lib/elm_radio.h index cfe18b89b3..5bb82a76e2 100644 --- a/legacy/elementary/src/lib/elm_radio.h +++ b/legacy/elementary/src/lib/elm_radio.h @@ -1,5 +1,6 @@ /** * @defgroup Radio Radio + * @ingroup Elementary * * @image html img/widget/radio/preview-00.png * @image latex img/widget/radio/preview-00.eps @@ -57,6 +58,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Radio */ EAPI Evas_Object *elm_radio_add(Evas_Object *parent); @@ -70,6 +73,8 @@ EAPI Evas_Object *elm_radio_add(Evas_Object *parent); * value assigned. In order to have them work as a group, they need to know * about each other. This adds the given radio object to the group of which * the group object indicated is a member. + * + * @ingroup Radio */ EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group); @@ -80,6 +85,8 @@ EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Obj * @param value The value to use if this radio object is selected * * This sets the value of the radio. + * + * @ingroup Radio */ EAPI void elm_radio_state_value_set(Evas_Object *obj, int value); @@ -90,8 +97,9 @@ EAPI void elm_radio_state_value_set(Evas_Object *obj, in * @return The value used if this radio object is selected * * This gets the value of the radio. - * * @see elm_radio_value_set() + * + * @ingroup Radio */ EAPI int elm_radio_state_value_get(const Evas_Object *obj); @@ -103,6 +111,8 @@ EAPI int elm_radio_state_value_get(const Evas_Object *o * * This sets the value of the radio group and will also set the value if * pointed to, to the value supplied, but will not call any callbacks. + * + * @ingroup Radio */ EAPI void elm_radio_value_set(Evas_Object *obj, int value); @@ -111,6 +121,8 @@ EAPI void elm_radio_value_set(Evas_Object *obj, int valu * * @param obj The radio object (any radio object of the group). * @return The integer state + * + * @ingroup Radio */ EAPI int elm_radio_value_get(const Evas_Object *obj); @@ -127,6 +139,8 @@ EAPI int elm_radio_value_get(const Evas_Object *obj); * when this is called, the radio objects state will also be modified to * reflect the value of the integer valuep points to, just like calling * elm_radio_value_set(). + * + * @ingroup Radio */ EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep); @@ -135,6 +149,8 @@ EAPI void elm_radio_value_pointer_set(Evas_Object *obj, * * @param obj Any radio object (any object of a group) * @return The selected radio object + * + * @ingroup Radio */ EAPI Evas_Object *elm_radio_selected_object_get(Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_route.h b/legacy/elementary/src/lib/elm_route.h index f2425912b0..5f5f4461a9 100644 --- a/legacy/elementary/src/lib/elm_route.h +++ b/legacy/elementary/src/lib/elm_route.h @@ -1,5 +1,6 @@ /** * @defgroup Route Route + * @ingroup Elementary * * For displaying a route on the map widget. * @@ -12,6 +13,7 @@ * @param parent The parent object * @return The new object or NULL if it cannot be created * + * @ingroup Route */ EAPI Evas_Object *elm_route_add(Evas_Object *parent); diff --git a/legacy/elementary/src/lib/elm_scale.h b/legacy/elementary/src/lib/elm_scale.h index 3477e3e961..4332e732c9 100644 --- a/legacy/elementary/src/lib/elm_scale.h +++ b/legacy/elementary/src/lib/elm_scale.h @@ -1,5 +1,6 @@ /** * @defgroup Scaling Widget Scaling + * @ingroup Elementary * * Different widgets can be scaled independently. These functions * allow you to manipulate this scaling on a per-widget basis. The diff --git a/legacy/elementary/src/lib/elm_scroll.h b/legacy/elementary/src/lib/elm_scroll.h index ca9aaed90b..51a2d4fc49 100644 --- a/legacy/elementary/src/lib/elm_scroll.h +++ b/legacy/elementary/src/lib/elm_scroll.h @@ -1,5 +1,6 @@ /** * @defgroup Scrollhints Scrollhints + * @ingroup Elementary * * Objects when inside a scroller can scroll, but this may not always be * desirable in certain situations. This allows an object to hint to itself diff --git a/legacy/elementary/src/lib/elm_scroller.h b/legacy/elementary/src/lib/elm_scroller.h index 73fd677a97..d9eca5270b 100644 --- a/legacy/elementary/src/lib/elm_scroller.h +++ b/legacy/elementary/src/lib/elm_scroller.h @@ -1,5 +1,6 @@ /** * @defgroup Scroller Scroller + * @ingroup Elementary * * A scroller holds a single object and "scrolls it around". This means that * it allows the user to use a scrollbar (or a finger) to drag the viewable @@ -59,6 +60,8 @@ typedef enum * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Scroller */ EAPI Evas_Object *elm_scroller_add(Evas_Object *parent); @@ -68,6 +71,8 @@ EAPI Evas_Object *elm_scroller_add(Evas_Object *parent); * @param obj The scroller object * @param widget The widget name to use (default is "scroller") * @param base The base name to use (default is "base") + * + * @ingroup Scroller */ EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base); @@ -82,6 +87,8 @@ EAPI void elm_scroller_custom_widget_base_theme_set(Evas * irrespective of its content. This will make the scroller minimum size the * right size horizontally and/or vertically to perfectly fit its content in * that direction. + * + * @ingroup Scroller */ EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h); @@ -97,6 +104,8 @@ EAPI void elm_scroller_content_min_limit(Evas_Object *ob * This will ensure all (or part if it does not fit) of the designated * region in the virtual content object (0, 0 starting at the top-left of the * virtual content object) is shown within the scroller. + * + * @ingroup Scroller */ EAPI void elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h); @@ -112,6 +121,8 @@ EAPI void elm_scroller_region_show(Evas_Object *obj, Eva * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies * respectively for the horizontal and vertical scrollbars. + * + * @ingroup Scroller */ EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v); @@ -123,6 +134,8 @@ EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_ * @param policy_v Vertical scrollbar policy * * @see elm_scroller_policy_set() + * + * @ingroup Scroller */ EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v); @@ -142,6 +155,8 @@ EAPI void elm_scroller_policy_get(const Evas_Object *obj * @note All coordinates are relative to the content. * * @see elm_scroller_region_show() + * + * @ingroup Scroller */ EAPI void elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h); @@ -153,6 +168,8 @@ EAPI void elm_scroller_region_get(const Evas_Object *obj * @param h Height of the content object. * * This gets the size of the content object of the scroller. + * + * @ingroup Scroller */ EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h); @@ -167,6 +184,8 @@ EAPI void elm_scroller_child_size_get(const Evas_Object * content object. This is a visual way to indicate the end has been reached. * This is enabled by default for both axis. This API will set if it is enabled * for the given axis with the boolean parameters for each axis. + * + * @ingroup Scroller */ EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce); @@ -178,6 +197,8 @@ EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina * @param v_bounce Will the scroller bounce vertically or not * * @see elm_scroller_bounce_set() + * + * @ingroup Scroller */ EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce); @@ -198,6 +219,8 @@ EAPI void elm_scroller_bounce_get(const Evas_Object *obj * is "half a viewport". Sane usable values are normally between 0.0 and 1.0 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for * the other axis. + * + * @ingroup Scroller */ EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel); @@ -212,6 +235,8 @@ EAPI void elm_scroller_page_relative_set(Evas_Object *ob * for that axis. * * @see elm_scroller_page_relative_set() + * + * @ingroup Scroller */ EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize); @@ -230,6 +255,8 @@ EAPI void elm_scroller_page_size_set(Evas_Object *obj, E * @see elm_scroller_last_page_get() * @see elm_scroller_page_show() * @see elm_scroller_page_bring_in() + * + * @ingroup Scroller */ EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber); @@ -246,6 +273,8 @@ EAPI void elm_scroller_current_page_get(const Evas_Objec * @see elm_scroller_current_page_get() * @see elm_scroller_page_show() * @see elm_scroller_page_bring_in() + * + * @ingroup Scroller */ EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber); @@ -270,6 +299,8 @@ EAPI void elm_scroller_last_page_get(const Evas_Object * * @endcode * * @see elm_scroller_page_bring_in() + * + * @ingroup Scroller */ EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber); @@ -294,6 +325,8 @@ EAPI void elm_scroller_page_show(Evas_Object *obj, int h * @endcode * * @see elm_scroller_page_show() + * + * @ingroup Scroller */ EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber); @@ -315,6 +348,8 @@ EAPI void elm_scroller_page_bring_in(Evas_Object *obj, i * show other content along the way. * * @see elm_scroller_region_show() + * + * @ingroup Scroller */ EAPI void elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h); @@ -326,6 +361,8 @@ EAPI void elm_scroller_region_bring_in(Evas_Object *obj, * * This enables or disabled event propagation from the scroller content to * the scroller and its parent. By default event propagation is disabled. + * + * @ingroup Scroller */ EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation); @@ -338,6 +375,8 @@ EAPI void elm_scroller_propagate_events_set(Evas_Object * This gets the event propagation for a scroller. * * @see elm_scroller_propagate_events_set() + * + * @ingroup Scroller */ EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj); @@ -359,6 +398,8 @@ EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_O * y=1.0, for showing the top most region of the content. * * Default values for x and y are 0.0 + * + * @ingroup Scroller */ EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y); @@ -373,6 +414,7 @@ EAPI void elm_scroller_gravity_set(Evas_Object *obj, dou * * @see elm_scroller_gravity_set() * + * @ingroup Scroller */ EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y); diff --git a/legacy/elementary/src/lib/elm_separator.h b/legacy/elementary/src/lib/elm_separator.h index f064b47ecf..1bc02d9b94 100644 --- a/legacy/elementary/src/lib/elm_separator.h +++ b/legacy/elementary/src/lib/elm_separator.h @@ -1,5 +1,6 @@ /** * @defgroup Separator Separator + * @ingroup Elementary * * @brief Separator is a very thin object used to separate other objects. * @@ -14,6 +15,8 @@ * @param parent The parent object * * @return The separator object, or NULL upon failure + * + * @ingroup Separator */ EAPI Evas_Object *elm_separator_add(Evas_Object *parent); /** @@ -21,6 +24,8 @@ EAPI Evas_Object *elm_separator_add(Evas_Object *parent); * * @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); /** @@ -30,6 +35,8 @@ EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizont * @return If true, the separator is horizontal * * @see elm_separator_horizontal_set() + * + * @ingroup Separator */ EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj); /** diff --git a/legacy/elementary/src/lib/elm_slideshow.h b/legacy/elementary/src/lib/elm_slideshow.h index cb3be1a2de..546b0024a2 100644 --- a/legacy/elementary/src/lib/elm_slideshow.h +++ b/legacy/elementary/src/lib/elm_slideshow.h @@ -1,5 +1,6 @@ /** * @defgroup Slideshow Slideshow + * @ingroup Elementary * * @image html img/widget/slideshow/preview-00.png * @image latex img/widget/slideshow/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_store.h b/legacy/elementary/src/lib/elm_store.h index d9b2c31f3c..8b28e91ccd 100644 --- a/legacy/elementary/src/lib/elm_store.h +++ b/legacy/elementary/src/lib/elm_store.h @@ -1,5 +1,6 @@ /** * @defgroup Store Elementary Store + * @ingroup Elementary * * Store is an abstracting API that is intended to farm off fetching of data * to threads running asynchronously from the mainloop that actually fetch @@ -144,6 +145,8 @@ struct _Elm_Store_Item_Info_Filesystem * This creates a new store object to then configure so it works. * * @return A new store object, or NULL if creation fails + * + * @ingroup Store */ EAPI Elm_Store *elm_store_filesystem_new(void); /** @@ -155,6 +158,8 @@ EAPI Elm_Store *elm_store_filesystem_new(void); * pending operation to do this). * * @param st The store to free + * + * @ingroup Store */ EAPI void elm_store_free(Elm_Store *st); @@ -171,6 +176,8 @@ EAPI void elm_store_free(Elm_Store *st); * * @param st The store to modify * @param dir A string giving the path to the directory to scan + * + * @ingroup Store */ EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir); @@ -182,6 +189,8 @@ EAPI void elm_store_filesystem_directory_set(Elm_Store *st, c * changes it or until the store is freed with elm_store_free(). * * @return A string with the path set, or NULL if none set. + * + * @ingroup Store */ EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st); @@ -195,6 +204,8 @@ EAPI const char *elm_store_filesystem_directory_get(const Elm_Store * * @param sti The store item to get the path from * @return A full path in a string or NULL if none available + * + * @ingroup Store */ EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti); @@ -207,6 +218,8 @@ EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_ * * @param st The store to do the filling. * @param obj The genlist object to fill in and control the content of from the store. + * + * @ingroup Store */ EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj); @@ -219,6 +232,8 @@ EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Ob * * @param st The store to modify * @param max The number of items to keep (should be greater than or equal to 0) + * + * @ingroup Store */ EAPI void elm_store_cache_set(Elm_Store *st, int max); @@ -230,6 +245,8 @@ EAPI void elm_store_cache_set(Elm_Store *st, int max); * @param st The store to query * @return The maximum number of items to cache (>= 0) * @see elm_store_cache_set() + * + * @ingroup Store */ EAPI int elm_store_cache_get(const Elm_Store *st); @@ -244,6 +261,8 @@ EAPI int elm_store_cache_get(const Elm_Store *st); * @param st The store to set the function of * @param func The function to be called * @param data the data pointer to be passed to the @p func function when called + * + * @ingroup Store */ EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data); @@ -261,6 +280,8 @@ EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_It * @param st The store to set the function of * @param func The function to be called * @param data the data pointer to be passed to the @p func function when called + * + * @ingroup Store */ EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data); @@ -274,6 +295,8 @@ EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_I * @param st The store to set the function of * @param func The function to be called * @param data the data pointer to be passed to the @p func function when called + * + * @ingroup Store */ EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data); @@ -282,6 +305,8 @@ EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store * * @param st The store to modify * @param use_thread EINA_TRUE to use a thread to fetch, EINA_FALSE don't use a thread. + * + * @ingroup Store */ EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread); @@ -290,6 +315,8 @@ EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool * * @return The state set currently for the store. * @see elm_store_fetch_thread_set() + * + * @ingroup Store */ EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st); @@ -304,6 +331,8 @@ EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st); * * @param st The store to modify * @param sorted EINA_TRUE if we are to sort, EINA_FALSE if not. + * + * @ingroup Store */ EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted); @@ -314,6 +343,8 @@ EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorte * * @param st The store to query * @return EINA_TRUE if sorted, EINA_FALSE if not. + * + * @ingroup Store */ EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st); @@ -327,6 +358,8 @@ EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st); * * @param sti The store item to set the data pointer of * @param data The data pointer to set. + * + * @ingroup Store */ EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data); @@ -337,6 +370,8 @@ EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void * * * @param sti The store item to query * @return The data pointer set on the item + * + * @ingroup Store */ EAPI void *elm_store_item_data_get(Elm_Store_Item *sti); @@ -347,6 +382,8 @@ EAPI void *elm_store_item_data_get(Elm_Store_Item *sti); * * @param sti The store item to query * @return The store the item belongs to + * + * @ingroup Store */ EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti); @@ -355,6 +392,8 @@ EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) * * @param sti The store item to query * @return The genlist object item handle controlled by this store item + * + * @ingroup Store */ EAPI const Elm_Object_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti); diff --git a/legacy/elementary/src/lib/elm_table.h b/legacy/elementary/src/lib/elm_table.h index 0e28e5f8d5..ceffc86335 100644 --- a/legacy/elementary/src/lib/elm_table.h +++ b/legacy/elementary/src/lib/elm_table.h @@ -1,5 +1,6 @@ /** * @defgroup Table Table + * @ingroup Elementary * * A container widget to arrange other widgets in a table where items can * span multiple columns or rows - even overlap (and then be raised or @@ -30,6 +31,8 @@ * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Table */ EAPI Evas_Object *elm_table_add(Evas_Object *parent); @@ -39,6 +42,8 @@ EAPI Evas_Object *elm_table_add(Evas_Object *parent); * @param obj The layout object * @param homogeneous A boolean to set if the layout is homogeneous in the * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous) + * + * @ingroup Table */ EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous); @@ -48,6 +53,8 @@ EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous * @param obj The table object * @return A boolean to indicating if the layout is homogeneous in the table * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous) + * + * @ingroup Table */ EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj); @@ -59,6 +66,8 @@ EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj); * @param vertical set the vertical padding. * * Default value is 0. + * + * @ingroup Table */ EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical); @@ -68,6 +77,8 @@ EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Ev * @param obj The layout object. * @param horizontal set the horizontal padding. * @param vertical set the vertical padding. + * + * @ingroup Table */ EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical); @@ -84,6 +95,8 @@ EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizon * @note All positioning inside the table is relative to rows and columns, so * a value of 0 for x and y, means the top left cell of the table, and a * value of 1 for w and h means @p subobj only takes that 1 cell. + * + * @ingroup Table */ EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h); @@ -92,6 +105,8 @@ EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int * * @param obj The table object * @param subobj The subobject + * + * @ingroup Table */ EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj); @@ -100,6 +115,8 @@ EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj); * * @param obj The table object * @param clear If true, will delete children, else just remove from table. + * + * @ingroup Table */ EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear); @@ -117,6 +134,8 @@ EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear); * @note All positioning inside the table is relative to rows and columns, so * a value of 0 for x and y, means the top left cell of the table, and a * value of 1 for w and h means @p subobj only takes that 1 cell. + * + * @ingroup Table */ EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h); @@ -130,6 +149,8 @@ EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int * @param h colspan * * @see elm_table_pack_set() + * + * @ingroup Table */ EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h); diff --git a/legacy/elementary/src/lib/elm_theme.h b/legacy/elementary/src/lib/elm_theme.h index 86cc0c103a..10c5f6a2a8 100644 --- a/legacy/elementary/src/lib/elm_theme.h +++ b/legacy/elementary/src/lib/elm_theme.h @@ -1,5 +1,6 @@ /** * @defgroup Theme Theme + * @ingroup Elementary * * Elementary uses Edje to theme its widgets, naturally. But for the most * part this is hidden behind a simpler interface that lets the user set @@ -91,6 +92,8 @@ typedef struct _Elm_Theme Elm_Theme; * actually apply it yet. The child of the scroller will have a specific * theme set to show this preview before the user decides to apply it to all * applications). + * + * @ingroup Theme */ EAPI Elm_Theme *elm_theme_new(void); @@ -100,6 +103,8 @@ EAPI Elm_Theme *elm_theme_new(void); * @param th The theme to free * * This frees a theme created with elm_theme_new(). + * + * @ingroup Theme */ EAPI void elm_theme_free(Elm_Theme *th); @@ -113,6 +118,8 @@ EAPI void elm_theme_free(Elm_Theme *th); * and overlays from @p th to @p thdst. If @p th references a theme, then * @p thdst is also set to reference it, with all the theme settings, * overlays and extensions that @p th had. + * + * @ingroup Theme */ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst); @@ -125,6 +132,8 @@ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst); * This clears @p th to be empty and then sets it to refer to @p thref * so @p th acts as an override to @p thref, but where its overrides * don't apply, it will fall through to @p thref for configuration. + * + * @ingroup Theme */ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref); @@ -136,6 +145,8 @@ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref); * * This gets the theme set as the reference theme by elm_theme_ref_set(). * If no theme is set as a reference, NULL is returned. + * + * @ingroup Theme */ EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th); @@ -147,6 +158,8 @@ EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th); * This returns the internal default theme setup handle that all widgets * use implicitly unless a specific theme is set. This is also often use * as a shorthand of NULL. + * + * @ingroup Theme */ EAPI Elm_Theme *elm_theme_default_get(void); @@ -166,6 +179,8 @@ EAPI Elm_Theme *elm_theme_default_get(void); * of trouble. * * @see elm_theme_extension_add() + * + * @ingroup Theme */ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item); @@ -176,6 +191,8 @@ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item); * @param item The name of the theme overlay * * @see elm_theme_overlay_add() + * + * @ingroup Theme */ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item); @@ -186,6 +203,8 @@ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item); * @return List of theme overlays. Do not free it. * * @see elm_theme_overlay_add() + * + * @ingroup Theme */ EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th); @@ -207,6 +226,8 @@ EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th); * Use this call instead of elm_theme_overlay_add() for almost all cases. * * @see elm_object_style_set() + * + * @ingroup Theme */ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item); @@ -217,6 +238,8 @@ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item); * @param item The name of the theme extension * * @see elm_theme_extension_add() + * + * @ingroup Theme */ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item); @@ -227,6 +250,8 @@ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item); * @return List of theme extensions. Do not free it. * * @see elm_theme_extension_add() + * + * @ingroup Theme */ EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th); @@ -245,6 +270,8 @@ EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th); * * @see elm_theme_get() * @see elm_theme_list_get() + * + * @ingroup Theme */ EAPI void elm_theme_set(Elm_Theme *th, const char *theme); @@ -259,6 +286,8 @@ EAPI void elm_theme_set(Elm_Theme *th, const char *theme); * * @see elm_theme_set() * @see elm_theme_list_get() + * + * @ingroup Theme */ EAPI const char *elm_theme_get(Elm_Theme *th); @@ -280,6 +309,8 @@ EAPI const char *elm_theme_get(Elm_Theme *th); * * @see elm_theme_set() * @see elm_theme_get() + * + * @ingroup Theme */ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th); @@ -298,6 +329,8 @@ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th); * relative to home. The @p in_search_path boolean pointed to is set to * EINA_TRUE if the file was a search-able file and is in the search path, * and EINA_FALSE otherwise. + * + * @ingroup Theme */ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path); @@ -310,6 +343,8 @@ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_ * in the given theme. If @p th is NULL, then the default theme is flushed. * Call this function if source theme data has changed in such a way as to * make any caches Elementary kept invalid. + * + * @ingroup Theme */ EAPI void elm_theme_flush(Elm_Theme *th); @@ -318,6 +353,8 @@ EAPI void elm_theme_flush(Elm_Theme *th); * * This will flush all themes in the current application context, by calling * elm_theme_flush() on each of them. + * + * @ingroup Theme */ EAPI void elm_theme_full_flush(void); @@ -330,6 +367,8 @@ EAPI void elm_theme_full_flush(void); * for theme elements, and returns them in alphabetical order as theme * element names in a list of strings. Free this with * elm_theme_name_available_list_free() when you are done with the list. + * + * @ingroup Theme */ EAPI Eina_List *elm_theme_name_available_list_new(void); @@ -339,6 +378,8 @@ EAPI Eina_List *elm_theme_name_available_list_new(void); * This frees the list of themes returned by * elm_theme_name_available_list_new(). Once freed the list should no longer * be used. a new list mys be created. + * + * @ingroup Theme */ EAPI void elm_theme_name_available_list_free(Eina_List *list); @@ -356,6 +397,8 @@ EAPI void elm_theme_name_available_list_free(Eina_List *list); * Use special themes with great care as this will annoy users and make * configuration difficult. Avoid any custom themes at all if it can be * helped. + * + * @ingroup Theme */ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th); @@ -369,6 +412,8 @@ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th); * set on that object. It will not return inherited themes from parents, only * the specific theme set for that specific object. See elm_object_theme_set() * for more information. + * + * @ingroup Theme */ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj); @@ -381,6 +426,8 @@ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj); * * This function is used to return data items from edc in @p th, an overlay, or an extension. * It works the same way as edje_file_data_get() except that the return is stringshared. + * + * @ingroup Theme */ EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key); diff --git a/legacy/elementary/src/lib/elm_thumb.h b/legacy/elementary/src/lib/elm_thumb.h index 823b8e4d1f..8aa0593389 100644 --- a/legacy/elementary/src/lib/elm_thumb.h +++ b/legacy/elementary/src/lib/elm_thumb.h @@ -1,5 +1,6 @@ /** * @defgroup Thumb Thumb + * @ingroup Elementary * * @image html img/widget/thumb/preview-00.png * @image latex img/widget/thumb/preview-00.eps diff --git a/legacy/elementary/src/lib/elm_tooltip.h b/legacy/elementary/src/lib/elm_tooltip.h index f4d7e17925..3daf1c7ea5 100644 --- a/legacy/elementary/src/lib/elm_tooltip.h +++ b/legacy/elementary/src/lib/elm_tooltip.h @@ -1,5 +1,6 @@ /** * @defgroup Tooltips Tooltips + * @ingroup Elementary * * The Tooltip is an (internal, for now) smart object used to show a * content in a frame on mouse hover of objects(or widgets), with @@ -34,6 +35,8 @@ EAPI void elm_object_tooltip_hide(Evas_Object *obj); * * @param obj The tooltip object. * @param text The text to be displayed. + * + * @ingroup Tooltips */ EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text); EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text); @@ -50,6 +53,8 @@ EAPI void elm_object_tooltip_unset(Evas_Object *obj); * * @param obj an object with tooltip already set. * @param style the theme style to use (default, transparent, ...) + * + * @ingroup Tooltips */ EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style); @@ -59,6 +64,8 @@ EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *styl * @param obj an object with tooltip already set. * @return style the theme style in use, defaults to "default". If the * object does not have a tooltip set, then NULL is returned. + * + * @ingroup Tooltips */ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj); @@ -70,6 +77,8 @@ EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj); * * This function allows a tooltip to expand beyond its parent window's canvas. * It will instead be limited only by the size of the display. + * + * @ingroup Tooltips */ EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable); @@ -81,6 +90,8 @@ EAPI Eina_Bool elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool * This function returns whether a tooltip is allowed to expand beyond * its parent window's canvas. * It will instead be limited only by the size of the display. + * + * @ingroup Tooltips */ EAPI Eina_Bool elm_object_tooltip_window_mode_get(const Evas_Object *obj); diff --git a/legacy/elementary/src/lib/elm_transit.h b/legacy/elementary/src/lib/elm_transit.h index b0569f9640..a167e9db87 100644 --- a/legacy/elementary/src/lib/elm_transit.h +++ b/legacy/elementary/src/lib/elm_transit.h @@ -1,5 +1,4 @@ /** - * * @defgroup Transit Transit * @ingroup Elementary * diff --git a/legacy/elementary/src/lib/elm_video.h b/legacy/elementary/src/lib/elm_video.h index 7d8af7f27f..018f632459 100644 --- a/legacy/elementary/src/lib/elm_video.h +++ b/legacy/elementary/src/lib/elm_video.h @@ -1,5 +1,6 @@ /** * @defgroup Video Video + * @ingroup Elementary * * @addtogroup Video * @{ diff --git a/legacy/elementary/src/lib/elm_web.h b/legacy/elementary/src/lib/elm_web.h index 6df12e95ad..b465906ab7 100644 --- a/legacy/elementary/src/lib/elm_web.h +++ b/legacy/elementary/src/lib/elm_web.h @@ -1,5 +1,6 @@ /** * @defgroup Web Web + * @ingroup Elementary * * @image html img/widget/web/preview-00.png * @image latex img/widget/web/preview-00.eps @@ -156,6 +157,8 @@ struct _Elm_Web_Menu_Item * * @see elm_web_popup_selected_set() * @see elm_web_popup_destroy() + * + * @ingroup Web */ typedef struct _Elm_Web_Menu Elm_Web_Menu; @@ -175,6 +178,8 @@ typedef struct _Elm_Web_Menu Elm_Web_Menu; * * @see elm_web_popup_selected_set() * @see elm_web_popup_destroy() + * + * @ingroup Web */ struct _Elm_Web_Menu { @@ -243,6 +248,8 @@ typedef enum * Returning @c NULL should cancel the request. * * @see elm_web_window_create_hook_set() + * + * @ingroup Web */ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features); @@ -262,6 +269,8 @@ typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_B * If the function returns @c NULL the popup will be ignored. * * @see elm_web_dialog_alert_hook_set() + * + * @ingroup Web */ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message); @@ -283,6 +292,8 @@ typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const * If the function returns @c NULL the popup will be ignored. * * @see elm_web_dialog_confirm_hook_set() + * + * @ingroup Web */ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret); @@ -307,6 +318,8 @@ typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, con * If the function returns @c NULL the popup will be ignored. * * @see elm_web_dialog_prompt_hook_set() + * + * @ingroup Web */ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret); @@ -333,6 +346,8 @@ typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, cons * If the function returns @c NULL the popup will be ignored. * * @see elm_web_dialog_file selector_hook_set() + * + * @ingroup Web */ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret); @@ -351,6 +366,8 @@ typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *ob * @li @p source_id Source id * * @see elm_web_console_message_hook_set() + * + * @ingroup Web */ typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id); @@ -362,6 +379,8 @@ typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char * * @see elm_web_uri_set() * @see elm_web_webkit_view_get() + * + * @ingroup Web */ EAPI Evas_Object *elm_web_add(Evas_Object *parent); @@ -371,6 +390,7 @@ EAPI Evas_Object *elm_web_add(Evas_Object *parent); * @param obj The object * @param user_agent String for useragent * + * @ingroup Web */ EAPI void elm_web_useragent_set(Evas_Object *obj, const char *user_agent); @@ -380,6 +400,7 @@ EAPI void elm_web_useragent_set(Evas_Object *obj, const char *user_agent); * @param obj The object * @return Useragent string * + * @ingroup Web */ EAPI const char* elm_web_useragent_get(const Evas_Object *obj); @@ -397,6 +418,8 @@ EAPI const char* elm_web_useragent_get(const Evas_Object *obj); * ewebkit) * * @see elm_web_add() + * + * @ingroup Web */ EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj); @@ -412,6 +435,8 @@ EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj); * @param obj The web object where to set the hook function * @param func The hook function to be called when a window is requested * @param data User data + * + * @ingroup Web */ EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data); @@ -427,6 +452,8 @@ EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_ * @param data User data * * @see elm_web_inwin_mode_set() + * + * @ingroup Web */ EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data); @@ -442,6 +469,8 @@ EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_D * @param data User data * * @see elm_web_inwin_mode_set() + * + * @ingroup Web */ EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data); @@ -457,6 +486,8 @@ EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web * @param data User data * * @see elm_web_inwin_mode_set() + * + * @ingroup Web */ EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data); @@ -473,6 +504,8 @@ EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_ * @param data User data * * @see elm_web_inwin_mode_set() + * + * @ingroup Web */ EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data); @@ -485,6 +518,8 @@ EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, E * @param obj The web object where to set the hook function * @param func The callback function to be used * @param data User data + * + * @ingroup Web */ EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data); @@ -495,6 +530,8 @@ EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_We * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise * * @see elm_web_tab_propagate_set() + * + * @ingroup Web */ EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj); @@ -509,6 +546,8 @@ EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj); * * @param obj The web object * @param propagate Whether to propagate Tab keys to Elementary or not + * + * @ingroup Web */ EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate); @@ -521,6 +560,8 @@ EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool pro * @param obj The web object * @param uri The URI to set * @return EINA_TRUE if the URI could be set, EINA_FALSE if an error occurred + * + * @ingroup Web */ EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri); @@ -533,6 +574,8 @@ EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri); * @param obj The web object * @return A stringshared internal string with the current URI, or NULL on * failure + * + * @ingroup Web */ EAPI const char *elm_web_uri_get(const Evas_Object *obj); @@ -545,6 +588,8 @@ EAPI const char *elm_web_uri_get(const Evas_Object *obj); * @param obj The web object * @return A stringshared internal string with the current title, or NULL on * failure + * + * @ingroup Web */ EAPI const char *elm_web_title_get(const Evas_Object *obj); @@ -559,6 +604,8 @@ EAPI const char *elm_web_title_get(const Evas_Object *obj); * @param g Green component * @param b Blue component * @param a Alpha component + * + * @ingroup Web */ EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a); @@ -573,6 +620,8 @@ EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int * @param g Green component * @param b Blue component * @param a Alpha component + * + * @ingroup Web */ EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a); @@ -584,6 +633,8 @@ EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int * @param obj The web object * @return A newly allocated string, or NULL if nothing is selected or an * error occurred + * + * @ingroup Web */ EAPI char *elm_web_selection_get(const Evas_Object *obj); @@ -598,6 +649,8 @@ EAPI char *elm_web_selection_get(const Evas_Object *obj); * @param index The index selected * * @see elm_web_popup_destroy() + * + * @ingroup Web */ EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index); @@ -612,6 +665,8 @@ EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index); * @param obj The web object * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE * if there was no menu to destroy + * + * @ingroup Web */ EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj); @@ -626,6 +681,8 @@ EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj); * * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not * or failure + * + * @ingroup Web */ EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap); @@ -639,6 +696,8 @@ EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *s * @param limit Maximum amount of matches, or zero to unlimited * * @return number of matched @a string + * + * @ingroup Web */ EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit); @@ -648,6 +707,8 @@ EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *s * @param obj The web object * * @return EINA_TRUE on success, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj); @@ -661,6 +722,8 @@ EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj); * @param highlight Whether to highlight the marks or not * * @return EINA_TRUE on success, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight); @@ -671,6 +734,8 @@ EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina * * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE * otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj); @@ -685,6 +750,8 @@ EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj * * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on * failure + * + * @ingroup Web */ EAPI double elm_web_load_progress_get(const Evas_Object *obj); @@ -698,6 +765,8 @@ EAPI double elm_web_load_progress_get(const Evas_Object *obj); * @param obj The web object * * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_stop(Evas_Object *obj); @@ -707,6 +776,8 @@ EAPI Eina_Bool elm_web_stop(Evas_Object *obj); * @param obj The web object * * @return EINA_TRUE on success, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_reload(Evas_Object *obj); @@ -716,6 +787,8 @@ EAPI Eina_Bool elm_web_reload(Evas_Object *obj); * @param obj The web object * * @return EINA_TRUE on success, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj); @@ -732,6 +805,8 @@ EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj); * @see elm_web_back_possible() * @see elm_web_forward() * @see elm_web_navigate() + * + * @ingroup Web */ EAPI Eina_Bool elm_web_back(Evas_Object *obj); @@ -748,6 +823,8 @@ EAPI Eina_Bool elm_web_back(Evas_Object *obj); * @see elm_web_forward_possible_get() * @see elm_web_back() * @see elm_web_navigate() + * + * @ingroup Web */ EAPI Eina_Bool elm_web_forward(Evas_Object *obj); @@ -766,6 +843,8 @@ EAPI Eina_Bool elm_web_forward(Evas_Object *obj); * @see elm_web_history_enabled_set() * @see elm_web_back() * @see elm_web_forward() + * + * @ingroup Web */ EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps); @@ -776,6 +855,8 @@ EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps); * * @return EINA_TRUE if it's possible to back in history, EINA_FALSE * otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_back_possible_get(Evas_Object *obj); @@ -786,6 +867,8 @@ EAPI Eina_Bool elm_web_back_possible_get(Evas_Object *obj); * * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE * otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_forward_possible_get(Evas_Object *obj); @@ -800,6 +883,8 @@ EAPI Eina_Bool elm_web_forward_possible_get(Evas_Object *obj); * * @return EINA_TRUE if enough history exists to perform the given jump, * EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_navigate_possible_get(Evas_Object *obj, int steps); @@ -809,6 +894,8 @@ EAPI Eina_Bool elm_web_navigate_possible_get(Evas_Object *obj, int steps * @param obj The web object * * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_history_enabled_get(const Evas_Object *obj); @@ -817,6 +904,8 @@ EAPI Eina_Bool elm_web_history_enabled_get(const Evas_Object *obj); * * @param obj The web object * @param enabled Whether to enable or disable the browsing history + * + * @ingroup Web */ EAPI void elm_web_history_enabled_set(Evas_Object *obj, Eina_Bool enabled); @@ -830,6 +919,8 @@ EAPI void elm_web_history_enabled_set(Evas_Object *obj, Eina_Bool e * * @param obj The web object * @param zoom The zoom level to set + * + * @ingroup Web */ EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom); @@ -845,6 +936,8 @@ EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom); * @param obj The web object * * @return The zoom level set on the object + * + * @ingroup Web */ EAPI double elm_web_zoom_get(const Evas_Object *obj); @@ -864,6 +957,8 @@ EAPI double elm_web_zoom_get(const Evas_Object *obj); * * @param obj The web object * @param mode The mode to set + * + * @ingroup Web */ EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode); @@ -874,6 +969,8 @@ EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode * * @return The current zoom mode set for the object, or * ::ELM_WEB_ZOOM_MODE_LAST on error + * + * @ingroup Web */ EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj); @@ -885,6 +982,8 @@ EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj); * @param y The y coordinate of the region to show * @param w The width of the region to show * @param h The height of the region to show + * + * @ingroup Web */ EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h); @@ -899,6 +998,8 @@ EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w * @param y The y coordinate of the region to show * @param w The width of the region to show * @param h The height of the region to show + * + * @ingroup Web */ EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h); @@ -911,6 +1012,8 @@ EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, i * * @param obj The web object * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window + * + * @ingroup Web */ EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value); @@ -920,6 +1023,8 @@ EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value) * @param obj The web object * * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj); @@ -934,6 +1039,8 @@ EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf * @param flag The web window feature flag whose value is required. * * @return EINA_TRUE if the flag is set, EINA_FALSE otherwise + * + * @ingroup Web */ EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_Window_Features *wf, Elm_Web_Window_Feature_Flag flag); @@ -944,6 +1051,7 @@ EAPI Eina_Bool elm_web_window_features_property_get(const Elm_Web_W * @param wf The web window features object * @param x, y, w, h - the co-ordinates of the web view window. * + * @ingroup Web */ EAPI void elm_web_window_features_region_get(const Elm_Web_Window_Features *wf, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h); diff --git a/legacy/elementary/src/lib/elm_win.h b/legacy/elementary/src/lib/elm_win.h index 009d7548be..0cf2810e7c 100644 --- a/legacy/elementary/src/lib/elm_win.h +++ b/legacy/elementary/src/lib/elm_win.h @@ -1,5 +1,6 @@ -/* win */ -/** @defgroup Win Win +/** + * @defgroup Win Win + * @ingroup Elementary * * @image html img/widget/win/preview-00.png * @image latex img/widget/win/preview-00.eps @@ -231,6 +232,8 @@ typedef enum * which the image object will be created. * * @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); @@ -248,6 +251,8 @@ EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, El * @return The created object, or NULL on failure * * @see elm_win_add() + * + * @ingroup Win */ EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title); @@ -277,6 +282,8 @@ EAPI Evas_Object *elm_win_util_standard_add(const char *name, const cha * * @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); @@ -290,6 +297,8 @@ EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Obje * * @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); @@ -298,6 +307,8 @@ EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Obje * * @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); @@ -310,6 +321,8 @@ EAPI void elm_win_title_set(Evas_Object *obj, const char *title * * @param obj The window object * @return The title + * + * @ingroup Win */ EAPI const char *elm_win_title_get(const Evas_Object *obj); @@ -318,6 +331,8 @@ EAPI const char *elm_win_title_get(const Evas_Object *obj); * * @param obj The window object * @param icon_name The icon name to set + * + * @ingroup Win */ EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *icon_name); @@ -330,6 +345,8 @@ EAPI void elm_win_icon_name_set(Evas_Object *obj, const char *i * * @param obj The window object * @return The icon name + * + * @ingroup Win */ EAPI const char *elm_win_icon_name_get(const Evas_Object *obj); @@ -338,6 +355,8 @@ EAPI const char *elm_win_icon_name_get(const Evas_Object *obj); * * @param obj The window object * @param role The role to set + * + * @ingroup Win */ EAPI void elm_win_role_set(Evas_Object *obj, const char *role); @@ -350,6 +369,8 @@ EAPI void elm_win_role_set(Evas_Object *obj, const char *role); * * @param obj The window object * @return The role + * + * @ingroup Win */ EAPI const char *elm_win_role_get(const Evas_Object *obj); @@ -365,6 +386,8 @@ EAPI const char *elm_win_role_get(const Evas_Object *obj); * * @param obj The window object * @param icon The object to use for an icon + * + * @ingroup Win */ EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object *icon); @@ -376,6 +399,8 @@ EAPI void elm_win_icon_object_set(Evas_Object *obj, Evas_Object * * @param obj The window object * @return The icon object set + * + * @ingroup Win */ EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj); @@ -396,6 +421,8 @@ EAPI const Evas_Object *elm_win_icon_object_get(const Evas_Object *obj); * @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); @@ -406,6 +433,8 @@ EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autod * @return If the window will automatically delete itself when closed * * @see elm_win_autodel_set() + * + * @ingroup Win */ EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj); @@ -421,6 +450,8 @@ EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj); * active one after it. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_activate(Evas_Object *obj); @@ -434,6 +465,8 @@ EAPI void elm_win_activate(Evas_Object *obj); * request. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_lower(Evas_Object *obj); @@ -447,6 +480,8 @@ EAPI void elm_win_lower(Evas_Object *obj); * request. * * @param obj The window object + * + * @ingroup Win */ EAPI void elm_win_raise(Evas_Object *obj); @@ -458,6 +493,8 @@ EAPI void elm_win_raise(Evas_Object *obj); * @param obj The window object * @param h If true, center horizontally. If false, do not change horizontal location. * @param v If true, center vertically. If false, do not change vertical location. + * + * @ingroup Win */ EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v); @@ -469,6 +506,8 @@ EAPI void elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bo * * @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); @@ -477,6 +516,8 @@ EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool bo * * @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); @@ -494,6 +535,8 @@ EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj); * @param shaped If true, the window is shaped * * @see elm_win_alpha_set() + * + * @ingroup Win */ EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped); @@ -504,6 +547,8 @@ EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped * @return If true, the window is shaped * * @see elm_win_shaped_set() + * + * @ingroup Win */ EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj); @@ -521,6 +566,8 @@ EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj); * @param alpha If true, the window has an alpha channel * * @see elm_win_alpha_set() + * + * @ingroup Win */ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha); @@ -529,6 +576,8 @@ EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha); * * @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); @@ -547,6 +596,8 @@ EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj); * * @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); @@ -557,6 +608,8 @@ EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool over * @return If true, the window is overridden * * @see elm_win_override_set() + * + * @ingroup Win */ EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj); @@ -565,6 +618,8 @@ EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj); * * @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); @@ -573,6 +628,8 @@ EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fu * * @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); @@ -581,6 +638,8 @@ EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj); * * @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); @@ -589,6 +648,8 @@ EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool max * * @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); @@ -597,6 +658,8 @@ EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj); * * @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); @@ -605,6 +668,8 @@ EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool ico * * @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); @@ -613,6 +678,8 @@ EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj); * * @param obj The window object * @param withdrawn If true, the window is withdrawn + * + * @ingroup Win */ EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool withdrawn); @@ -621,6 +688,8 @@ EAPI void elm_win_withdrawn_set(Evas_Object *obj, Eina_Bool wit * * @param obj The window object * @return If true, the window is withdrawn + * + * @ingroup Win */ EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj); @@ -629,6 +698,8 @@ EAPI Eina_Bool elm_win_withdrawn_get(const Evas_Object *obj); * * @param obj The window object * @param urgent If true, the window is urgent + * + * @ingroup Win */ EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent); @@ -637,6 +708,8 @@ EAPI void elm_win_urgent_set(Evas_Object *obj, Eina_Bool urgent * * @param obj The window object * @return If true, the window is urgent + * + * @ingroup Win */ EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj); @@ -645,6 +718,8 @@ EAPI Eina_Bool elm_win_urgent_get(const Evas_Object *obj); * * @param obj The window object * @param demand_attention If true, the window is demand_attention + * + * @ingroup Win */ EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_Bool demand_attention); @@ -653,6 +728,8 @@ EAPI void elm_win_demand_attention_set(Evas_Object *obj, Eina_B * * @param obj The window object * @return If true, the window is demand_attention + * + * @ingroup Win */ EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj); @@ -661,6 +738,8 @@ EAPI Eina_Bool elm_win_demand_attention_get(const Evas_Object *obj); * * @param obj The window object * @param modal If true, the window is modal + * + * @ingroup Win */ EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal); @@ -669,6 +748,8 @@ EAPI void elm_win_modal_set(Evas_Object *obj, Eina_Bool modal); * * @param obj The window object * @return If true, the window is modal + * + * @ingroup Win */ EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj); @@ -678,6 +759,8 @@ EAPI Eina_Bool elm_win_modal_get(const Evas_Object *obj); * @param obj The window object * @param aspect If 0, the window has no aspect limits, otherwise it is * width divided by height + * + * @ingroup Win */ EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect); @@ -686,6 +769,8 @@ EAPI void elm_win_aspect_set(Evas_Object *obj, double aspect); * * @param obj The window object * @return The aspect ratio set (0 by default) + * + * @ingroup Win */ EAPI double elm_win_aspect_get(const Evas_Object *obj); @@ -702,6 +787,8 @@ EAPI double elm_win_aspect_get(const Evas_Object *obj); * * @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); @@ -712,6 +799,8 @@ EAPI void elm_win_layer_set(Evas_Object *obj, int layer); * @return The layer of the window * * @see elm_win_layer_set() + * + * @ingroup Win */ EAPI int elm_win_layer_get(const Evas_Object *obj); @@ -728,6 +817,8 @@ EAPI int elm_win_layer_get(const Evas_Object *obj); * @param obj The window object * @param rotation The rotation of the window, in degrees (0-360), * counter-clockwise. + * + * @ingroup Win */ EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation); @@ -740,6 +831,8 @@ EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation); * @param obj The window object * @param rotation The rotation of the window in degrees (0-360), * counter-clockwise. + * + * @ingroup Win */ EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation); @@ -751,6 +844,8 @@ EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, in * * @see elm_win_rotation_set() * @see elm_win_rotation_with_resize_set() + * + * @ingroup Win */ EAPI int elm_win_rotation_get(const Evas_Object *obj); @@ -762,6 +857,8 @@ EAPI int elm_win_rotation_get(const Evas_Object *obj); * * @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); @@ -772,6 +869,8 @@ EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky * @return If true, the window's sticky state is enabled * * @see elm_win_sticky_set() + * + * @ingroup Win */ EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj); @@ -780,6 +879,8 @@ EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj); * * @param obj The window object * @param conformant The conformant flag (1 = conformant, 0 = non-conformant) + * + * @ingroup Win */ EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant); @@ -788,6 +889,8 @@ EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool co * * @param obj The window object * @return A boolean if this window is illume conformant or not + * + * @ingroup Win */ EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj); @@ -798,6 +901,8 @@ EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj); * * @param obj The window object * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window) + * + * @ingroup Win */ EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel); @@ -806,6 +911,8 @@ EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool qu * * @param obj The window object * @return A boolean if this window is a quickpanel or not + * + * @ingroup Win */ EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj); @@ -814,6 +921,8 @@ EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj); * * @param obj The window object * @param priority The major priority for this quickpanel + * + * @ingroup Win */ EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority); @@ -822,6 +931,8 @@ EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *ob * * @param obj The window object * @return The major priority of this quickpanel + * + * @ingroup Win */ EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj); @@ -830,6 +941,8 @@ EAPI int elm_win_quickpanel_priority_major_get(const Evas_Obje * * @param obj The window object * @param priority The minor priority for this quickpanel + * + * @ingroup Win */ EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority); @@ -838,6 +951,8 @@ EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *ob * * @param obj The window object * @return The minor priority of this quickpanel + * + * @ingroup Win */ EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj); @@ -846,6 +961,8 @@ EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Obje * * @param obj The window object * @param zone The requested zone for this quickpanel + * + * @ingroup Win */ EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone); @@ -854,6 +971,8 @@ EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zon * * @param obj The window object * @return The requested zone for this quickpanel + * + * @ingroup Win */ EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj); @@ -875,6 +994,8 @@ EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj); * * @param obj The window object * @param skip The skip flag state (EINA_TRUE if it is to be skipped) + * + * @ingroup Win */ EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip); @@ -891,6 +1012,8 @@ EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bo * @param obj The window object that lives in the environment to control * @param command The command to send * @param params Optional parameters for the command + * + * @ingroup Win */ EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params); @@ -905,6 +1028,8 @@ EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Ill * * @param obj The window object to get the inlined image from * @return The inlined image object, or NULL if none exists + * + * @ingroup Win */ EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj); @@ -912,6 +1037,8 @@ EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj); * Determine whether a window has focus * @param obj The window to query * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE + * + * @ingroup Win */ EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj); @@ -921,6 +1048,8 @@ EAPI Eina_Bool elm_win_focus_get(const Evas_Object *obj); * When @p constrain is true, @p obj will never resize larger than the screen. * @param obj The window object * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction + * + * @ingroup Win */ EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain); @@ -930,6 +1059,8 @@ EAPI void elm_win_screen_constrain_set(Evas_Object *obj, Eina_B * When this function returns true, @p obj will never resize larger than the screen. * @param obj The window object * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction + * + * @ingroup Win */ EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj); @@ -940,6 +1071,8 @@ EAPI Eina_Bool elm_win_screen_constrain_get(Evas_Object *obj); * @param y where to return the vertical offset value. May be NULL. * @param w where to return the width value. May be NULL. * @param h where to return the height value. May be NULL. + * + * @ingroup Win */ EAPI void elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h); @@ -951,6 +1084,8 @@ EAPI void elm_win_screen_size_get(const Evas_Object *obj, int * * * @param obj The window where to enable the highlight * @param enabled The enabled value for the highlight + * + * @ingroup Win */ EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled); @@ -960,6 +1095,8 @@ EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, * @param obj The window in which to check if the focus highlight is enabled * * @return EINA_TRUE if enabled, EINA_FALSE otherwise + * + * @ingroup Win */ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj); @@ -971,6 +1108,8 @@ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object * * @param obj The window where to set the style * @param style The style to set + * + * @ingroup Win */ EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style); @@ -983,6 +1122,8 @@ EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, c * @param obj The window to retrieve the highlights style from * * @return The style set or NULL if none was. Default is used in that case. + * + * @ingroup Win */ EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj); @@ -991,6 +1132,8 @@ EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object * * * @param obj The window object * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode + * + * @ingroup Win */ EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode); @@ -999,6 +1142,8 @@ EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_K * * @param obj The window object * @return The mode, one of #Elm_Win_Keyboard_Mode + * + * @ingroup Win */ EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj); @@ -1007,6 +1152,8 @@ EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj); * * @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); @@ -1015,6 +1162,8 @@ EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool * * @param obj The window object * @return If the window is a virtual keyboard + * + * @ingroup Win */ EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj); @@ -1023,6 +1172,8 @@ EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj); * * @param obj The window object * @param mode The mode to set, one of #Elm_Win_Indicator_Mode + * + * @ingroup Win */ EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_Indicator_Mode mode); @@ -1031,6 +1182,8 @@ EAPI void elm_win_indicator_mode_set(Evas_Object *obj, Elm_Win_ * * @param obj The window object * @return The mode, one of #Elm_Win_Indicator_Mode + * + * @ingroup Win */ EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj); @@ -1039,6 +1192,8 @@ EAPI Elm_Win_Indicator_Mode elm_win_indicator_mode_get(const Evas_Object *obj); * * @param obj The window object * @param mode The mode to set, one of #Elm_Win_Indicator_Opacity_Mode + * + * @ingroup Win */ EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_Win_Indicator_Opacity_Mode mode); @@ -1047,6 +1202,8 @@ EAPI void elm_win_indicator_opacity_set(Evas_Object *obj, Elm_W * * @param obj The window object * @return The mode, one of #Elm_Win_Indicator_Opacity_Mode + * + * @ingroup Win */ EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Object *obj); @@ -1056,6 +1213,8 @@ EAPI Elm_Win_Indicator_Opacity_Mode elm_win_indicator_opacity_get(const Evas_Obj * @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); @@ -1067,15 +1226,30 @@ EAPI void elm_win_screen_position_get(const Evas_Object *obj, i * @param svcnum A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. * @param svcsys A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. * @return If socket creation is successful + * + * @ingroup Win */ EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys); +/* X specific calls - won't work on non-x engines (return 0) */ +/** + * 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); + /** * @} */ /** * @defgroup Inwin Inwin + * @ingroup Win * * @image html img/widget/inwin/preview-00.png * @image latex img/widget/inwin/preview-00.eps @@ -1124,6 +1298,8 @@ EAPI Eina_Bool elm_win_socket_listen(Evas_Object *obj, const char *s * * @param parent The parent object * @return The new object or NULL if it cannot be created + * + * @ingroup Inwin */ EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent); @@ -1139,6 +1315,8 @@ EAPI Evas_Object *elm_win_inwin_add(Evas_Object *parent); * source "elm". * * @param obj The inwin to activate + * + * @ingroup Inwin */ EAPI void elm_win_inwin_activate(Evas_Object *obj); @@ -1151,6 +1329,8 @@ EAPI void elm_win_inwin_activate(Evas_Object *obj); * * @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); @@ -1168,6 +1348,8 @@ EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *conte * * @param obj The inwin object * @return The content that is being used + * + * @ingroup Inwin */ EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj); @@ -1178,28 +1360,12 @@ EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj); * * @param obj The inwin object * @return The content that was being used + * + * @ingroup Inwin */ EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj); /** * @} */ -/* X specific calls - won't work on non-x engines (return 0) */ -/** - * 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); - -/* smart callbacks called: - * "delete,request" - the user requested to delete the window - * "focus,in" - window got focus - * "focus,out" - window lost focus - * "moved" - window that holds the canvas was moved - */