From: Mike McCormack Date: Mon, 7 Nov 2011 08:00:16 +0000 (+0900) Subject: [fileselector, hoversel] remove documentation X-Git-Tag: REBUILDD-ARMEL-67367~25 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=17c8f89c9f83e8174ffac8ac4eb21398d0c5552b;p=framework%2Fuifw%2Felementary.git [fileselector, hoversel] remove documentation --- diff --git a/src/lib/elc_fileselector_button.c b/src/lib/elc_fileselector_button.c index 8dbacc0..2ba7290 100644 --- a/src/lib/elc_fileselector_button.c +++ b/src/lib/elc_fileselector_button.c @@ -1,21 +1,6 @@ #include #include "elm_priv.h" -/** - * @defgroup File_Selector_Button File Selector Button - * - * A button that, when clicked, creates an Elementary window (or inner - * window) with an Elementary File Selector within. When a file is - * chosen, the (inner) window is closed and the selected file is - * exposed as an evas_object_smart_callback_call() of the button. - * - * Signals that you can add callbacks for are: - * - * "file,chosen" - the user has selected a path, whose string pointer comes - * as event info - * - */ - typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -275,14 +260,6 @@ _elm_fileselector_button_label_get(const Evas_Object *obj, const char *item) return elm_object_text_get(wd->btn); } -/** - * Add a new file selector button into the parent object. - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * @ingroup File_Selector_Button - */ EAPI Evas_Object * elm_fileselector_button_add(Evas_Object *parent) { @@ -327,15 +304,6 @@ elm_fileselector_button_add(Evas_Object *parent) return obj; } -/** - * Set the label used in the file selector button. - * - * @param obj The button object - * @param label The text label text to be displayed on the button - * - * @ingroup File_Selector_Button - * @deprecated use elm_object_text_set() instead. - */ EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) @@ -343,32 +311,12 @@ elm_fileselector_button_label_set(Evas_Object *obj, _elm_fileselector_button_label_set(obj, NULL, label); } -/** - * Get the label used in the file selector button. - * - * @param obj The button object - * @return The button label - * - * @ingroup File_Selector_Button - * @deprecated use elm_object_text_set() instead. - */ EAPI const char * elm_fileselector_button_label_get(const Evas_Object *obj) { return _elm_fileselector_button_label_get(obj, NULL); } -/** - * Set the title of the file selector button's window. - * - * @param obj The button object - * @param title The title string - * - * Note that it will only take any effect if the fileselector button - * not at "inwin mode". - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) @@ -383,14 +331,6 @@ elm_fileselector_button_window_title_set(Evas_Object *obj, elm_win_title_set(wd->fsw, wd->window_title); } -/** - * Get the title of the file selector button's window. - * - * @param obj The button object - * @return Title of the file selector button's window - * - * @ingroup File_Selector_Button - */ EAPI const char * elm_fileselector_button_window_title_get(const Evas_Object *obj) { @@ -401,18 +341,6 @@ elm_fileselector_button_window_title_get(const Evas_Object *obj) return wd->window_title; } -/** - * Set the size of the file selector button's window. - * - * @param obj The button object - * @param width The width - * @param height The height - * - * Note that it will only take any effect if the fileselector button not at - * "inwin mode". Default size for the window (when applicable) is 400x400. - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, @@ -429,15 +357,6 @@ elm_fileselector_button_window_size_set(Evas_Object *obj, evas_object_resize(wd->fsw, wd->w, wd->h); } -/** - * Get the size of the file selector button's window. - * - * @param obj The button object - * @param width Pointer into which to store the width value - * @param height Pointer into which to store the height value - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, @@ -451,17 +370,6 @@ elm_fileselector_button_window_size_get(const Evas_Object *obj, if (height) *height = wd->h; } -/** - * Set the starting path of the file selector button's window. - * - * @param obj The button object - * @param path The path string - * - * It must be a directory path. - * Default path is "HOME" environment variable's value. - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) @@ -476,13 +384,6 @@ elm_fileselector_button_path_set(Evas_Object *obj, elm_fileselector_selected_set(wd->fs, wd->fsd.path); } -/** - * Get the last path of the file selector button's window. - * - * @param obj The button object - * - * @ingroup File_Selector_Button - */ EAPI const char * elm_fileselector_button_path_get(const Evas_Object *obj) { @@ -492,17 +393,6 @@ elm_fileselector_button_path_get(const Evas_Object *obj) return wd->fsd.path; } -/** - * Set whether the button's file selector is to present itself as an - * Elementary Generic List (which will expand its entries for nested - * directories) or as canonical list, which will be rendered again - * with the contents of each selected directory. - * - * @param obj The button object - * @param value The expandable flag - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) @@ -517,14 +407,6 @@ elm_fileselector_button_expandable_set(Evas_Object *obj, elm_fileselector_expandable_set(wd->fs, wd->fsd.expandable); } -/** - * Get the button's file selector expandable flag. - * - * @param obj The button object - * @return value The expandable flag - * - * @ingroup File_Selector_Button - */ EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) { @@ -535,15 +417,6 @@ elm_fileselector_button_expandable_get(const Evas_Object *obj) return wd->fsd.expandable; } -/** - * Set whether the button's file selector list is to display folders - * only or the directory contents, as well. - * - * @param obj The button object - * @param value The "folder only" flag - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) @@ -558,14 +431,6 @@ elm_fileselector_button_folder_only_set(Evas_Object *obj, elm_fileselector_folder_only_set(wd->fs, wd->fsd.folder_only); } -/** - * Get the button's file selector "folder only" flag. - * - * @param obj The button object - * @return value The "folder only" flag - * - * @ingroup File_Selector_Button - */ EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) { @@ -576,15 +441,6 @@ elm_fileselector_button_folder_only_get(const Evas_Object *obj) return wd->fsd.folder_only; } -/** - * Set whether the button's file selector has an editable text entry - * which will hold its current selection. - * - * @param obj The button object - * @param value The "is save" flag - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) @@ -599,14 +455,6 @@ elm_fileselector_button_is_save_set(Evas_Object *obj, elm_fileselector_is_save_set(wd->fs, wd->fsd.is_save); } -/** - * Get the button's file selector "is save" flag. - * - * @param obj The button object - * @return value The "is save" flag - * - * @ingroup File_Selector_Button - */ EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) { @@ -617,16 +465,6 @@ elm_fileselector_button_is_save_get(const Evas_Object *obj) return wd->fsd.is_save; } -/** - * Set whether the button's file selector will raise an Elementary - * Inner Window, instead of a dedicated Elementary Window. By default, - * it won't. - * - * @param obj The button object - * @param value The "inwin mode" flag - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) @@ -638,14 +476,6 @@ elm_fileselector_button_inwin_mode_set(Evas_Object *obj, wd->inwin_mode = value; } -/** - * Get the button's file selector "inwin mode" flag. - * - * @param obj The button object - * @return value The "inwin mode" flag - * - * @ingroup File_Selector_Button - */ EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) { @@ -656,18 +486,6 @@ elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) return wd->inwin_mode; } -/** - * Set the icon used for the button - * - * Once the icon object is set, a previously set one will be deleted. - * If you want to keep that old content object, use the - * elm_fileselector_button_icon_unset() function. - * - * @param obj The button object - * @param icon The icon object for the button - * - * @ingroup File_Selector_Button - */ EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) @@ -682,14 +500,6 @@ elm_fileselector_button_icon_set(Evas_Object *obj, elm_button_icon_set(wd->btn, icon); } -/** - * Get the icon used for the button - * - * @param obj The button object - * @return The icon object that is being used - * - * @ingroup File_Selector_Button - */ EAPI Evas_Object * elm_fileselector_button_icon_get(const Evas_Object *obj) { @@ -699,16 +509,6 @@ elm_fileselector_button_icon_get(const Evas_Object *obj) return elm_button_icon_get(wd->btn); } -/** - * Unset the icon used for the button - * - * Unparent and return the icon object which was set for this widget. - * - * @param obj The button object - * @return The icon object that was being used - * - * @ingroup File_Selector_Button - */ EAPI Evas_Object * elm_fileselector_button_icon_unset(Evas_Object *obj) { diff --git a/src/lib/elc_fileselector_entry.c b/src/lib/elc_fileselector_entry.c index 86f5191..653ee49 100644 --- a/src/lib/elc_fileselector_entry.c +++ b/src/lib/elc_fileselector_entry.c @@ -1,18 +1,6 @@ #include #include "elm_priv.h" - /** - * @defgroup File_Selector_Entry File Selector Entry - * - * An entry that shows to enter/display path and have an associated - * button to allow selecting the file from a dialog. - * - * The button, when clicked, creates an Elementary window (or inner - * window) with an Elementary File Selector within. When a file is - * chosen, the (inner) window is closed and the selected file is - * exposed as an evas_object_smart_callback_call() of the button. - */ - typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -232,14 +220,6 @@ _elm_fileselector_entry_button_label_get(const Evas_Object *obj, const char *ite return elm_object_text_get(wd->button); } -/** - * Add a new file selector entry into the parent object. - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * @ingroup File_Selector_Entry - */ EAPI Evas_Object * elm_fileselector_entry_add(Evas_Object *parent) { @@ -318,15 +298,6 @@ elm_fileselector_entry_add(Evas_Object *parent) return obj; } -/** - * Set the label used in the file selector entry. - * - * @param obj The entry object - * @param label The text label text to be displayed on the entry - * - * @ingroup File_Selector_Entry - * @deprecated use elm_object_text_set() instead. - */ EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) { @@ -339,16 +310,6 @@ elm_fileselector_entry_button_label_get(const Evas_Object *obj) return _elm_fileselector_entry_button_label_get(obj, NULL); } -/** - * Set the path to start the entry's file selector with, when clicked. - * - * @param obj The entry object - * @param path Path to a file/directory - * - * Default path is "HOME" environment variable's value. - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) { @@ -358,16 +319,6 @@ elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) elm_fileselector_button_path_set(wd->button, path); } -/** - * Get the last path which the entry's file selector was set to. - * - * @param obj The entry object - * @param path Path to a file/directory - * - * Default path is "HOME" environment variable's value. - * - * @ingroup File_Selector_Entry - */ EAPI const char * elm_fileselector_entry_selected_get(const Evas_Object *obj) { @@ -377,17 +328,6 @@ elm_fileselector_entry_selected_get(const Evas_Object *obj) return elm_fileselector_button_path_get(wd->button); } -/** - * Set the title of the file selector entry's window. - * - * @param obj The entry object - * @param title The title string - * - * Note that it will only take any effect if the fileselector entry - * not at "inwin mode". - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) { @@ -397,13 +337,6 @@ elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) elm_fileselector_button_window_title_set(wd->button, title); } -/** - * Get the title of the file selector entry's window. - * - * @param obj The entry object - * - * @ingroup File_Selector_Entry - */ EAPI const char * elm_fileselector_entry_window_title_get(const Evas_Object *obj) { @@ -413,18 +346,6 @@ elm_fileselector_entry_window_title_get(const Evas_Object *obj) return elm_fileselector_button_window_title_get(wd->button); } -/** - * Set the size of the file selector entry's window. - * - * @param obj The entry object - * @param width The width - * @param height The height - * - * Note that it will only take any effect if the fileselector entry not at - * "inwin mode". Default size for the window (when applicable) is 400x400. - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) { @@ -434,15 +355,6 @@ elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_ elm_fileselector_button_window_size_set(wd->button, width, height); } -/** - * Get the size of the file selector entry's window. - * - * @param obj The entry object - * @param width Pointer into which to store the width value - * @param height Pointer into which to store the height value - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) { @@ -452,16 +364,6 @@ elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width elm_fileselector_button_window_size_get(wd->button, width, height); } -/** - * Set the starting path of the file selector entry's window. - * - * @param obj The entry object - * @param path The path string - * - * It must be a directory path. - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) { @@ -472,13 +374,6 @@ elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) elm_entry_entry_set(wd->entry, path); } -/** - * Get the last path of the file selector entry's window. - * - * @param obj The entry object - * - * @ingroup File_Selector_Entry - */ EAPI const char * elm_fileselector_entry_path_get(const Evas_Object *obj) { @@ -488,17 +383,6 @@ elm_fileselector_entry_path_get(const Evas_Object *obj) return elm_entry_entry_get(wd->entry); } -/** - * Set whether the entry's file selector is to present itself as an - * Elementary Generic List (which will expand its entries for nested - * directories) or as canonical list, which will be rendered again - * with the contents of each selected directory. - * - * @param obj The entry object - * @param value The expandable flag - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) { @@ -508,14 +392,6 @@ elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) elm_fileselector_button_expandable_set(wd->button, value); } -/** - * Get the entry's file selector expandable flag. - * - * @param obj The entry object - * @return value The expandable flag - * - * @ingroup File_Selector_Entry - */ EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) { @@ -525,15 +401,6 @@ elm_fileselector_entry_expandable_get(const Evas_Object *obj) return elm_fileselector_button_expandable_get(wd->button); } -/** - * Set whether the entry's file selector list is to display folders - * only or the directory contents, as well. - * - * @param obj The entry object - * @param value The "folder only" flag - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) { @@ -543,14 +410,6 @@ elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) elm_fileselector_button_folder_only_set(wd->button, value); } -/** - * Get the entry's file selector "folder only" flag. - * - * @param obj The entry object - * @return value The "folder only" flag - * - * @ingroup File_Selector_Entry - */ EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) { @@ -560,15 +419,6 @@ elm_fileselector_entry_folder_only_get(const Evas_Object *obj) return elm_fileselector_button_folder_only_get(wd->button); } -/** - * Set whether the entry's file selector has an editable text entry - * which will hold its current selection. - * - * @param obj The entry object - * @param value The "is save" flag - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) { @@ -578,14 +428,6 @@ elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) elm_fileselector_button_is_save_set(wd->button, value); } -/** - * Get the entry's file selector "is save" flag. - * - * @param obj The entry object - * @return value The "is save" flag - * - * @ingroup File_Selector_Entry - */ EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) { @@ -595,16 +437,6 @@ elm_fileselector_entry_is_save_get(const Evas_Object *obj) return elm_fileselector_button_is_save_get(wd->button); } -/** - * Set whether the entry's file selector will raise an Elementary - * Inner Window, instead of a dedicated Elementary Window. By default, - * it won't. - * - * @param obj The entry object - * @param value The "inwin mode" flag - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) { @@ -614,14 +446,6 @@ elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) elm_fileselector_button_inwin_mode_set(wd->button, value); } -/** - * Get the entry's file selector "inwin mode" flag. - * - * @param obj The entry object - * @return value The "inwin mode" flag - * - * @ingroup File_Selector_Entry - */ EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) { @@ -631,16 +455,6 @@ elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) return elm_fileselector_button_inwin_mode_get(wd->button); } -/** - * Set the icon used for the entry button - * - * Once the icon object is set, a previously set one will be deleted. - * - * @param obj The entry object - * @param icon The image for the entry - * - * @ingroup File_Selector_Entry - */ EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) { @@ -650,14 +464,6 @@ elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) elm_fileselector_button_icon_set(wd->button, icon); } -/** - * Get the icon used for the entry button - * - * @param obj The entry object - * @return The image for the entry - * - * @ingroup File_Selector_Entry - */ EAPI Evas_Object * elm_fileselector_entry_button_icon_get(const Evas_Object *obj) { @@ -667,16 +473,6 @@ elm_fileselector_entry_button_icon_get(const Evas_Object *obj) return elm_fileselector_button_icon_get(wd->button); } -/** - * Unset the icon used for the entry button - * - * Unparent and return the icon object which was set for this widget. - * - * @param obj The entry object - * @return The icon object that was being used - * - * @ingroup File_Selector_Entry - */ EAPI Evas_Object * elm_fileselector_entry_button_icon_unset(Evas_Object *obj) { diff --git a/src/lib/elc_hoversel.c b/src/lib/elc_hoversel.c index 49e602c..50ddba2 100644 --- a/src/lib/elc_hoversel.c +++ b/src/lib/elc_hoversel.c @@ -1,22 +1,6 @@ #include #include "elm_priv.h" -/** - * @defgroup Hoversel Hoversel - * @ingroup Elementary - * - * A hoversel is a button that pops up a list of items (automatically - * choosing the direction to display) that have a lable and/or an icon to - * select from. It is a convenience widget to avoid the need to do all the - * piecing together yourself. It is intended for a small number of items in - * the hoversel menu (no more than 8), though is capable of many more. - * - * Signals that you can add callbacks for are: - * - * "clicked" - the user clicked the hoversel button and popped up the sel - * "selected" - an item in the hoversel list is selected. event_info is the item - * "dismissed" - the hover is dismissed - */ typedef struct _Widget_Data Widget_Data; struct _Widget_Data @@ -288,14 +272,6 @@ _elm_hoversel_label_get(const Evas_Object *obj, const char *item) return elm_object_text_get(wd->btn); } -/** - * Add a new Hoversel object - * - * @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) { @@ -336,17 +312,6 @@ elm_hoversel_add(Evas_Object *parent) return obj; } -/** - * Set the Hover parent - * - * Sets the hover parent object. Should probably be the window that the hoversel - * is in. See Hover objects for more information. - * - * @param obj The hoversel object - * @param parent The parent to use - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) { @@ -362,17 +327,6 @@ elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) _parent_del, obj); } -/** - * Get the Hover parent - * - * Gets the hover parent object. Should probably be the window that the hoversel - * is in. See Hover objects for more information. - * - * @param obj The hoversel object - * @return The used parent - * - * @ingroup Hoversel - */ EAPI Evas_Object * elm_hoversel_hover_parent_get(const Evas_Object *obj) { @@ -382,46 +336,18 @@ elm_hoversel_hover_parent_get(const Evas_Object *obj) return wd->hover_parent; } -/** - * Set the hoversel button label - * - * This sets the label of the button that is always visible (before it is - * clicked and expanded). Also see elm_object_text_set(). - * - * @param obj The hoversel object - * @param label The label text. - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) { _elm_hoversel_label_set(obj, NULL, label); } -/** - * Get the hoversel button label - * - * @param obj The hoversel object - * @return The label text. - * - * @ingroup Hoversel - */ EAPI const char * elm_hoversel_label_get(const Evas_Object *obj) { return _elm_hoversel_label_get(obj, NULL); } -/** - * This sets the hoversel to expand horizontally. The initial button - * will display horizontally regardless of this setting. - * - * @param obj The hoversel object - * @param horizontal If true, the hover will expand horizontally to the right. - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) { @@ -431,15 +357,6 @@ elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) wd->horizontal = !!horizontal; } - -/** - * This returns whether the hoversel is set to expand horizontally. - * - * @param obj The hoversel object - * @return If true, the hover will expand horizontally to the right. - * - * @ingroup Hoversel - */ EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) { @@ -449,20 +366,6 @@ elm_hoversel_horizontal_get(const Evas_Object *obj) return wd->horizontal; } -/** - * Set the icon of the hoversel button - * - * Sets the icon of the button that is always visible (before it is clicked - * and expanded). Also see elm_button_icon_set(). - * Once the icon object is set, a previously set one will be deleted - * If you want to keep that old content object, use the - * elm_hoversel_icon_unset() function. - * - * @param obj The hoversel object - * @param icon The icon object - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) { @@ -472,17 +375,6 @@ elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) elm_button_icon_set(wd->btn, icon); } -/** - * Get the icon of the hoversel button - * - * Get the icon of the button that is always visible (before it is clicked - * and expanded). Also see elm_button_icon_get(). - * - * @param obj The hoversel object - * @return The icon object - * - * @ingroup Hoversel - */ EAPI Evas_Object * elm_hoversel_icon_get(const Evas_Object *obj) { @@ -492,17 +384,6 @@ elm_hoversel_icon_get(const Evas_Object *obj) return elm_button_icon_get(wd->btn); } -/** - * Get the icon of the hoversel button - * - * Unparent and return the icon of the button that is always visible - * (before it is clicked and expanded). Also see elm_button_icon_unset(). - * - * @param obj The hoversel object - * @return The icon object that was being used - * - * @ingroup Hoversel - */ EAPI Evas_Object * elm_hoversel_icon_unset(Evas_Object *obj) { @@ -512,14 +393,6 @@ elm_hoversel_icon_unset(Evas_Object *obj) return elm_button_icon_unset(wd->btn); } -/** - * This triggers the hoversel popup from code, the same as though the - * user clicked the button. - * - * @param obj The hoversel object - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_hover_begin(Evas_Object *obj) { @@ -530,13 +403,6 @@ elm_hoversel_hover_begin(Evas_Object *obj) _activate(obj); } -/** - * This ends the hoversel popup as though the user clicked outside the hover. - * - * @param obj The hoversel object - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_hover_end(Evas_Object *obj) { @@ -550,15 +416,6 @@ elm_hoversel_hover_end(Evas_Object *obj) evas_object_smart_callback_call(obj, SIG_DISMISSED, NULL); } -/** - * Returns whether the hoversel is expanded. - * - * @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) { @@ -568,15 +425,6 @@ elm_hoversel_expanded_get(const Evas_Object *obj) return (wd->hover) ? EINA_TRUE : EINA_FALSE; } -/** - * This will remove all the children items from the hoversel. (should not be - * called while the hoversel is active; use elm_hoversel_expanded_get() - * to check first). - * - * @param obj The hoversel object - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_clear(Evas_Object *obj) { @@ -588,14 +436,6 @@ elm_hoversel_clear(Evas_Object *obj) EINA_LIST_FOREACH_SAFE(wd->items, l, ll, item) elm_hoversel_item_del(item); } -/** - * Get the list of items within the given hoversel. - * - * @param obj The hoversel object - * @return Returns a list of Elm_Hoversel_Item* - * - * @ingroup Hoversel - */ EAPI const Eina_List * elm_hoversel_items_get(const Evas_Object *obj) { @@ -605,24 +445,6 @@ elm_hoversel_items_get(const Evas_Object *obj) return wd->items; } -/** - * Add an item to the hoversel button - * - * This adds an item to the hoversel to show when it is clicked. Note: if you - * need to use an icon from an edje file then use elm_hoversel_item_icon_set() - * right after the this function, and set icon_file to NULL here. - * - * @param obj The hoversel object - * @param label The text label to use for the item (NULL if not desired) - * @param icon_file An image file path on disk to use for the icon or standard - * icon name (NULL if not desired) - * @param icon_type The icon type if relevant - * @param func Convenience function to call when this item is selected - * @param data Data to pass to item-related functions - * @return A handle to the item added. - * - * @ingroup Hoversel - */ EAPI Elm_Hoversel_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) { @@ -640,17 +462,6 @@ elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file return item; } -/** - * Delete an item from the hoversel - * - * This deletes the item from the hoversel (should not be called while the - * hoversel is active; use elm_hoversel_expanded_get() - * to check first). - * - * @param item The item to delete - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) { @@ -666,19 +477,6 @@ elm_hoversel_item_del(Elm_Hoversel_Item *item) elm_widget_item_del(item); } -/** - * Set the function called when an item within the hoversel - * is freed. That function will receive these parameters: - * - * void *item_data - * Evas_Object *the_item_object - * Elm_Hoversel_Item *the_object_struct - * - * @param item The item to set the callback on - * @param func The function called - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *item, Evas_Smart_Cb func) { @@ -686,15 +484,6 @@ elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *item, Evas_Smart_Cb func) elm_widget_item_del_cb_set(item, func); } -/** - * This returns the data pointer supplied with elm_hoversel_item_add() that - * will be passed to associated function callbacks. - * - * @param item The item to get the data from - * @return The data pointer set with elm_hoversel_item_add() - * - * @ingroup Hoversel - */ EAPI void * elm_hoversel_item_data_get(const Elm_Hoversel_Item *item) { @@ -702,14 +491,6 @@ elm_hoversel_item_data_get(const Elm_Hoversel_Item *item) return elm_widget_item_data_get(item); } -/** - * This returns the label text of the given hoversel item. - * - * @param item The item to get the label - * @return The label text of the hoversel item - * - * @ingroup Hoversel - */ EAPI const char * elm_hoversel_item_label_get(const Elm_Hoversel_Item *item) { @@ -717,19 +498,6 @@ elm_hoversel_item_label_get(const Elm_Hoversel_Item *item) return item->label; } -/** - * This sets the icon for the given hoversel item. The icon can be loaded from - * the standard set, from an image file, or from an edje file. - * - * @param item The item to set the icon - * @param icon_file An image file path on disk to use for the icon or standard - * icon name - * @param icon_group The edje group to use if @p icon_file is an edje file. Set this - * to NULL if the icon is not an edje file - * @param icon_type The icon type - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_item_icon_set(Elm_Hoversel_Item *item, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) { @@ -739,18 +507,6 @@ elm_hoversel_item_icon_set(Elm_Hoversel_Item *item, const char *icon_file, const item->icon_type = icon_type; } -/** - * Get the icon object of the hoversel item - * - * @param item The item to get the icon from - * @param icon_file The image file path on disk used for the icon or standard - * icon name - * @param icon_group The edje group used if @p icon_file is an edje file. NULL - * if the icon is not an edje file - * @param icon_type The icon type - * - * @ingroup Hoversel - */ EAPI void elm_hoversel_item_icon_get(const Elm_Hoversel_Item *item, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) {