diff options
Diffstat (limited to 'src/lib/elm_menu.h')
| -rw-r--r-- | src/lib/elm_menu.h | 382 |
1 files changed, 7 insertions, 375 deletions
diff --git a/src/lib/elm_menu.h b/src/lib/elm_menu.h index 46a18f5bd..2a5350f72 100644 --- a/src/lib/elm_menu.h +++ b/src/lib/elm_menu.h @@ -34,381 +34,13 @@ * @{ */ -#define ELM_OBJ_MENU_CLASS elm_obj_menu_class_get() - -const Eo_Class *elm_obj_menu_class_get(void) EINA_CONST; - -extern EAPI Eo_Op ELM_OBJ_MENU_BASE_ID; - -enum -{ - ELM_OBJ_MENU_SUB_ID_MOVE, - ELM_OBJ_MENU_SUB_ID_CLOSE, - ELM_OBJ_MENU_SUB_ID_ITEM_ADD, - ELM_OBJ_MENU_SUB_ID_ITEM_SEPARATOR_ADD, - ELM_OBJ_MENU_SUB_ID_ITEMS_GET, - ELM_OBJ_MENU_SUB_ID_FIRST_ITEM_GET, - ELM_OBJ_MENU_SUB_ID_LAST_ITEM_GET, - ELM_OBJ_MENU_SUB_ID_SELECTED_ITEM_GET, - ELM_OBJ_MENU_SUB_ID_LAST -}; - -#define ELM_OBJ_MENU_ID(sub_id) (ELM_OBJ_MENU_BASE_ID + sub_id) - - -/** - * @def elm_obj_menu_move - * @since 1.8 - * - * @brief Move the menu to a new position - * - * @param[in] x - * @param[in] y - * - * @see elm_menu_move - */ -#define elm_obj_menu_move(x, y) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_MOVE), EO_TYPECHECK(Evas_Coord, x), EO_TYPECHECK(Evas_Coord, y) - -/** - * @def elm_obj_menu_close - * @since 1.8 - * - * @brief Close a opened menu - * - * - * @see elm_menu_close - */ -#define elm_obj_menu_close() ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_CLOSE) - -/** - * @def elm_obj_menu_item_add - * @since 1.8 - * - * @brief Add an item at the end of the given menu widget - * - * @param[in] parent - * @param[in] icon - * @param[in] label - * @param[in] func - * @param[in] data - * @param[out] ret - * - * @see elm_menu_item_add - */ -#define elm_obj_menu_item_add(parent, icon, label, func, data, ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_ITEM_ADD), EO_TYPECHECK(Elm_Object_Item *, parent), EO_TYPECHECK(const char *, icon), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret) - -/** - * @def elm_obj_menu_item_separator_add - * @since 1.8 - * - * @brief Add a separator item to menu obj under @p parent. - * - * @param[in] parent - * @param[out] ret - * - * @see elm_menu_item_separator_add - */ -#define elm_obj_menu_item_separator_add(parent, ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_ITEM_SEPARATOR_ADD), EO_TYPECHECK(Elm_Object_Item *, parent), EO_TYPECHECK(Elm_Object_Item **, ret) - -/** - * @def elm_obj_menu_items_get - * @since 1.8 - * - * @brief Returns a list of item's items. - * - * @param[out] ret - * - * @see elm_menu_items_get - */ -#define elm_obj_menu_items_get(ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_ITEMS_GET), EO_TYPECHECK(const Eina_List **, ret) - -/** - * @def elm_obj_menu_first_item_get - * @since 1.8 - * - * @brief Get the first item in the menu - * - * @param[out] ret - * - * @see elm_menu_first_item_get - */ -#define elm_obj_menu_first_item_get(ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_FIRST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret) - -/** - * @def elm_obj_menu_last_item_get - * @since 1.8 - * - * @brief Get the last item in the menu - * - * @param[out] ret - * - * @see elm_menu_last_item_get - */ -#define elm_obj_menu_last_item_get(ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_LAST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret) - -/** - * @def elm_obj_menu_selected_item_get - * @since 1.8 - * - * @brief Get the selected item in the menu - * - * @param[out] ret - * - * @see elm_menu_selected_item_get - */ -#define elm_obj_menu_selected_item_get(ret) ELM_OBJ_MENU_ID(ELM_OBJ_MENU_SUB_ID_SELECTED_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret) - -/** - * @brief Add a new menu to the parent - * - * @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); - -/** - * @brief Set the parent for the given menu widget - * - * @param obj The menu object. - * @param parent The new parent. - * - * @ingroup Menu - */ -EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent); - -/** - * @brief Get the parent for the given menu widget - * - * @param obj The menu object. - * @return The parent. - * - * @see elm_menu_parent_set() - * - * @ingroup Menu - */ -EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj); - -/** - * @brief Move the menu to a new position - * - * @param obj The menu object. - * @param x The new position. - * @param y The new position. - * - * 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); - -/** - * @brief Close a opened menu - * - * @param obj the menu object - * @return void - * - * Hides the menu and all it's sub-menus. - * - * @ingroup Menu - */ -EAPI void elm_menu_close(Evas_Object *obj); - -/** - * @brief Returns a list of @p item's items. - * - * @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); - -/** - * Get the real Evas(Edje) object created to implement the view of a given - * menu @p item. - * - * @param it The menu item. - * @return The base Edje object containing the swallowed content associated with - * @p it. - * - * @warning Don't manipulate this object! - * - * @ingroup Menu - */ -EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it); - -/** - * @brief Add an item at the end of the given menu widget - * - * @param obj The menu object. - * @param parent The parent menu item (optional) - * @param icon An icon display on the item. The icon will be destroyed by the menu. - * @param label The label of the item. - * @param func Function called when the user select the item. - * @param data Data sent by the callback. - * @return Returns the new item. - * - * @note This function does not accept relative icon path. - * - * @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); - -/** - * @brief Set the icon of a menu item to the standard icon with name @p icon - * - * @param it The menu item 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); - -/** - * @brief Get the string representation from the icon of a menu item - * - * @param it The menu item object. - * @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); - -/** - * @brief Set the selected state of @p item. - * - * @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); - -/** - * @brief Get the selected state of @p item. - * - * @param it The menu item object. - * @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); - -/** - * @brief Add a separator item to menu @p obj under @p parent. - * - * @param obj The menu object - * @param parent The item to add the separator under - * @return The created item or NULL on failure - * - * 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); - -/** - * @brief Returns whether @p item is a separator. - * - * @param it The item to check - * @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); - -/** - * @brief Returns a list of @p item's subitems. - * - * @param it The item - * @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); - -/** - * @brief Get the position of a menu item - * - * @param it The menu item - * @return The item's index - * - * This function returns the index position of a menu item in a menu. - * 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); - -/** - * @brief Get the selected item in the menu - * - * @param obj The menu object - * @return The selected item, or NULL if none - * - * @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); - -/** - * @brief Get the last item in the menu - * - * @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); - -/** - * @brief Get the first item in the menu - * - * @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); - -/** - * @brief Get the next item in the menu. - * - * @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); - -/** - * @brief Get the previous item in the menu. - * - * @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); - +#include "elm_menu_common.h" +#ifdef EFL_EO_API_SUPPORT +#include "elm_menu_eo.h" +#endif +#ifndef EFL_NOLEGACY_API_SUPPORT +#include "elm_menu_legacy.h" +#endif /** * @} */ |