diff options
Diffstat (limited to 'src/lib/elc_hoversel.h')
| -rw-r--r-- | src/lib/elc_hoversel.h | 205 |
1 files changed, 186 insertions, 19 deletions
diff --git a/src/lib/elc_hoversel.h b/src/lib/elc_hoversel.h index ef52aca45..8b91fab75 100644 --- a/src/lib/elc_hoversel.h +++ b/src/lib/elc_hoversel.h @@ -1,6 +1,7 @@ /** + * @internal * @defgroup Hoversel Hoversel - * @ingroup Elementary + * @ingroup elm_widget_group * * @image html hoversel_inheritance_tree.png * @image latex hoversel_inheritance_tree.eps @@ -19,22 +20,18 @@ * functions acting on it also work for hoversel objects. * * This widget emits the following signals, besides the ones sent from - * @ref Button: + * @ref Button : * - @c "clicked" - the user clicked the hoversel button and popped up * the sel * - @c "selected" - an item in the hoversel list is selected. event_info - * is the selected item + * is the item * - @c "dismissed" - the hover is dismissed - * - @c "expanded" - This is called on clicking hoversel and elm_hoversel_hover_begin(). - * - @c "language,changed" - the program's language changed (since 1.9) - * - @c "item,focused" - When the hoversel item has received focus. (since 1.10) - * - @c "item,unfocused" - When the hoversel item has lost focus. (since 1.10) * * Default content parts of the hoversel widget that you can use for are: * @li "icon" - An icon of the hoversel * * Default text parts of the hoversel widget that you can use for are: - * @li "default" - A label of the hoversel + * @li "default" - Label of the hoversel * * Supported elm_object common APIs. * @li @ref elm_object_disabled_set @@ -45,22 +42,192 @@ * @li @ref elm_object_part_content_unset * * Supported elm_object_item common APIs. - * @li elm_object_item_del * @li elm_object_item_part_text_get - * @li elm_object_item_signal_emit - this works only when the item is created. - * @li elm_object_item_style_set - this works only when the item is created. - * @li elm_object_item_style_get - this works only when the item is created. * - * See @ref tutorial_hoversel for an example. * @{ */ -#ifdef EFL_EO_API_SUPPORT -#include "elc_hoversel_eo.h" -#endif -#ifndef EFL_NOLEGACY_API_SUPPORT -#include "elc_hoversel_legacy.h" -#endif +/** + * @brief Add a new Hoversel object + * + * @param[in] 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); + +/** + * @brief This sets the hoversel to expand horizontally. + * + * @param[in] obj The hoversel object + * @param[in] horizontal If true, the hover will expand horizontally to the + * right. + * + * @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); + +/** + * @brief This returns whether the hoversel is set to expand horizontally. + * + * @param[in] obj The hoversel object + * @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); + +/** + * @brief Set the Hover parent + * + * @param[in] obj The hoversel object + * @param[in] parent The parent to use + * + * 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); + +/** + * @brief Get the Hover parent + * + * @param[in] obj The hoversel object + * @return The used parent + * + * 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); + +/** + * @brief This triggers the hoversel popup from code, the same as if the user + * had clicked the button. + * + * @param[in] obj The hoversel object + * + * @ingroup Hoversel + */ +EAPI void elm_hoversel_hover_begin(Evas_Object *obj); + +/** + * @brief This dismisses the hoversel popup as if the user had clicked + * outside the hover. + * + * @param[in] obj The hoversel object + * + * @ingroup Hoversel + */ +EAPI void elm_hoversel_hover_end(Evas_Object *obj); + +/** + * @brief Returns whether the hoversel is expanded. + * + * @param[in] 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); + +/** + * @brief This will remove all the children items from the hoversel. + * + * @param[in] obj The hoversel object + * + * @warning Should @b not be called while the hoversel is active; use + * elm_hoversel_expanded_get() to check first. + * + * @see elm_object_item_del() + * + * @ingroup Hoversel + */ +EAPI void elm_hoversel_clear(Evas_Object *obj); + +/** + * @brief Get the list of items within the given hoversel. + * + * @param[in] obj The hoversel object + * @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); + +/** + * @brief Add an item to the hoversel button + * + * @param[in] obj The hoversel object + * @param[in] label The text label to use for the item (NULL if not desired) + * @param[in] icon_file An image file path on disk to use for the icon or standard + * icon name (NULL if not desired) + * @param[in] icon_type The icon type if relevant + * @param[in] func Convenience function to call when this item is selected + * @param[in] data Data to pass to item-related functions + * @return A handle to the item added. + * + * 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 this function, and set + * icon_file to NULL here. + * + * 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); + +/** + * @brief This sets the icon for the given hoversel item. + * + * @param[in] it The item to set the icon + * @param[in] icon_file An image file path on disk to use for the icon or standard + * icon name + * @param[in] 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[in] icon_type The icon type + * + * The icon can be loaded from the standard set, from an image file, or from + * 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); + +/** + * @brief Get the icon object of the hoversel item + * + * @param[in] it The item to get the icon from + * @param[out] icon_file The image file path on disk used for the icon or standard + * icon name + * @param[out] icon_group The edje group used if @p icon_file is an edje file. NULL + * if the icon is not an edje file + * @param[out] icon_type The icon type + * + * @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); + /** * @} */ |