4 * @image html img/widget/menu/preview-00.png
5 * @image latex img/widget/menu/preview-00.eps
7 * A menu is a list of items displayed above its parent. When the menu is
8 * showing its parent is darkened. Each item can have a sub-menu. The menu
9 * object can be used to display a menu on a right click event, in a toolbar,
12 * Signals that you can add callbacks for are:
13 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15 * Default contents parts of the menu items that you can use for are:
16 * @li "default" - A main content of the menu item
18 * Default text parts of the menu items that you can use for are:
19 * @li "default" - label in the menu item
21 * @see @ref tutorial_menu
26 * @brief Add a new menu to the parent
28 * @param parent The parent object.
29 * @return The new object or NULL if it cannot be created.
31 EAPI Evas_Object *elm_menu_add(Evas_Object *parent);
34 * @brief Set the parent for the given menu widget
36 * @param obj The menu object.
37 * @param parent The new parent.
39 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent);
42 * @brief Get the parent for the given menu widget
44 * @param obj The menu object.
47 * @see elm_menu_parent_set()
49 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj);
52 * @brief Move the menu to a new position
54 * @param obj The menu object.
55 * @param x The new position.
56 * @param y The new position.
58 * Sets the top-left position of the menu to (@p x,@p y).
60 * @note @p x and @p y coordinates are relative to parent.
62 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
65 * @brief Close a opened menu
67 * @param obj the menu object
70 * Hides the menu and all it's sub-menus.
72 EAPI void elm_menu_close(Evas_Object *obj);
75 * @brief Returns a list of @p item's items.
77 * @param obj The menu object
78 * @return An Eina_List* of @p item's items
80 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj);
83 * @brief Get the Evas_Object of an Elm_Object_Item
85 * @param it The menu item object.
86 * @return The edje object containing the swallowed content
88 * @warning Don't manipulate this object!
91 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Object_Item *it);
94 * @brief Add an item at the end of the given menu widget
96 * @param obj The menu object.
97 * @param parent The parent menu item (optional)
98 * @param icon An icon display on the item. The icon will be destryed by the menu.
99 * @param label The label of the item.
100 * @param func Function called when the user select the item.
101 * @param data Data sent by the callback.
102 * @return Returns the new item.
104 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);
107 * @brief Add an object swallowed in an item at the end of the given menu
110 * @param obj The menu object.
111 * @param parent The parent menu item (optional)
112 * @param subobj The object to swallow
113 * @param func Function called when the user select the item.
114 * @param data Data sent by the callback.
115 * @return Returns the new item.
117 * Add an evas object as an item to the menu.
119 EAPI Elm_Object_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data);
122 * @brief Set the icon of a menu item to the standard icon with name @p icon
124 * @param it The menu item object.
125 * @param icon The icon object to set for the content of @p item
127 * Once this icon is set, any previously set icon will be deleted.
129 EAPI void elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon);
132 * @brief Get the string representation from the icon of a menu item
134 * @param it The menu item object.
135 * @return The string representation of @p item's icon or NULL
137 * @see elm_menu_item_object_icon_name_set()
139 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it);
142 * @brief Set the selected state of @p item.
144 * @param it The menu item object.
145 * @param selected The selected/unselected state of the item
147 EAPI void elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
150 * @brief Get the selected state of @p item.
152 * @param it The menu item object.
153 * @return The selected/unselected state of the item
155 * @see elm_menu_item_selected_set()
157 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Object_Item *it);
160 * @brief Add a separator item to menu @p obj under @p parent.
162 * @param obj The menu object
163 * @param parent The item to add the separator under
164 * @return The created item or NULL on failure
166 * This is item is a @ref Separator.
168 EAPI Elm_Object_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent);
171 * @brief Returns whether @p item is a separator.
173 * @param it The item to check
174 * @return If true, @p item is a separator
176 * @see elm_menu_item_separator_add()
178 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Object_Item *it);
181 * @brief Deletes an item from the menu.
183 * @param it The item to delete.
185 * @see elm_menu_item_add()
187 EAPI void elm_menu_item_del(Elm_Object_Item *it);
190 * @brief Returns a list of @p item's subitems.
193 * @return An Eina_List* of @p item's subitems
195 * @see elm_menu_add()
197 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Object_Item *it);
200 * @brief Get the position of a menu item
202 * @param it The menu item
203 * @return The item's index
205 * This function returns the index position of a menu item in a menu.
206 * For a sub-menu, this number is relative to the first item in the sub-menu.
208 * @note Index values begin with 0
210 EAPI unsigned int elm_menu_item_index_get(const Elm_Object_Item *it);
213 * @brief @brief Return a menu item's owner menu
215 * @param it The menu item
216 * @return The menu object owning @p item, or NULL on failure
218 * Use this function to get the menu object owning an item.
220 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Object_Item *it);
223 * @brief Get the selected item in the menu
225 * @param obj The menu object
226 * @return The selected item, or NULL if none
228 * @see elm_menu_item_selected_get()
229 * @see elm_menu_item_selected_set()
231 EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object *obj);
234 * @brief Get the last item in the menu
236 * @param obj The menu object
237 * @return The last item, or NULL if none
239 EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object *obj);
242 * @brief Get the first item in the menu
244 * @param obj The menu object
245 * @return The first item, or NULL if none
247 EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object *obj);
250 * @brief Get the next item in the menu.
252 * @param it The menu item object.
253 * @return The item after it, or NULL if none
255 EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it);
258 * @brief Get the previous item in the menu.
260 * @param it The menu item object.
261 * @return The item before it, or NULL if none
263 EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it);