Menu Example

This example shows how to create a menu with regular items, object items, submenus and how to delete items from a menu. The full source for this example is menu_example_01.c.

We'll start looking at the menu creation and how to create a very simple item:

menu = elm_menu_add(win);
elm_menu_item_add(menu, NULL, NULL, "first item", NULL, NULL);

For our next item we are going to add an icon:

menu_it = elm_menu_item_add(menu, NULL, "mail-reply-all", "second item", NULL, NULL);

Now we are going to add more items, but these icons are going to have a parent, which will put them in a sub-menu. First just another item with an icon:

elm_menu_item_add(menu, menu_it, "object-rotate-left", "menu 1", NULL, NULL);

Next we are going to add a button to our menu(any elm widget can be added to a menu):

button = elm_button_add(win);
elm_object_text_set(button, "button - delete items");
menu_it1 = elm_menu_item_add(menu, menu_it, NULL, NULL, NULL, NULL);
elm_button_add
Evas_Object * elm_button_add(Evas_Object *parent)
Add a new button to the parent's canvas.
Definition: efl_ui_button.c:459

We are also going to have the button delete the first item of our sub-menu when clicked:

elm_object_item_content_set(menu_it1, button);
evas_object_smart_callback_add(button, "clicked", _del_it, menu);
evas_object_smart_callback_add
EVAS_API void evas_object_smart_callback_add(Evas_Object *eo_obj, const char *event, Evas_Smart_Cb func, const void *data)
Add (register) a callback function to the smart event specified by event on the smart object obj.
Definition: evas_object_smart.c:1040
static void
_del_it(void *data, Evas_Object *obj EINA_UNUSED, void *event_info EINA_UNUSED)
{
const Eina_List *l;
Elm_Object_Item *menu_it = elm_menu_first_item_get(data);
menu_it = elm_menu_item_next_get(menu_it);
l = elm_menu_item_subitems_get(menu_it);
elm_object_item_del(eina_list_data_get(l));
}
eina_list_data_get
static void * eina_list_data_get(const Eina_List *list)
Gets the list node data member.
EINA_UNUSED
#define EINA_UNUSED
Used to indicate that a function parameter is purposely unused.
Definition: eina_types.h:339
Elm_Object_Item
Eo Elm_Object_Item
An Elementary Object item handle.
Definition: elm_object_item.h:6
elm_object_item_del
void elm_object_item_del(Eo *obj)
Delete the given item.
Definition: elm_main.c:2017
Evas_Object
Efl_Canvas_Object Evas_Object
An Evas Object handle.
Definition: Evas_Common.h:185
_Eina_List
Type for a generic double linked list.
Definition: eina_list.h:318

We now add a separator and three more regular items:

static void
_show(void *data, Evas *e EINA_UNUSED, Evas_Object *obj EINA_UNUSED, void *event_info)
{
Evas_Event_Mouse_Down *ev = event_info;
elm_menu_move(data, ev->canvas.x, ev->canvas.y);
evas_object_show(data);
}
EAPI_MAIN int
elm_main(int argc EINA_UNUSED, char **argv EINA_UNUSED)
{
Evas_Object *win, *menu, *button, *rect;
Elm_Object_Item *menu_it, *menu_it1;
win = elm_win_util_standard_add("menu", "Menu");
elm_win_autodel_set(win, EINA_TRUE);
elm_policy_set(ELM_POLICY_QUIT, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED);
rect = evas_object_rectangle_add(evas_object_evas_get(win));
elm_win_resize_object_add(win, rect);
evas_object_size_hint_min_set(rect, 0, 0);
evas_object_color_set(rect, 0, 0, 0, 0);
evas_object_show(rect);
menu = elm_menu_add(win);
elm_menu_item_add(menu, NULL, NULL, "first item", NULL, NULL);
EINA_TRUE
#define EINA_TRUE
boolean value TRUE (numerical value 1)
Definition: eina_types.h:539
elm_policy_set
Eina_Bool elm_policy_set(unsigned int policy, int value)
Set a new policy's value (for a given policy group/identifier).
Definition: elm_main.c:1380
ELM_POLICY_QUIT_LAST_WINDOW_CLOSED
@ ELM_POLICY_QUIT_LAST_WINDOW_CLOSED
quit when the application's last window is closed
Definition: elm_general.h:248
ELM_POLICY_QUIT
@ ELM_POLICY_QUIT
under which circumstances the application should quit automatically.
Definition: elm_general.h:227
elm_win_resize_object_add
void elm_win_resize_object_add(Eo *obj, Evas_Object *subobj)
Add subobj as a resize object of window obj.
Definition: efl_ui_win.c:8992
elm_win_autodel_set
void elm_win_autodel_set(Eo *obj, Eina_Bool autodel)
Set the window's autodel state.
Definition: efl_ui_win.c:6189
elm_win_util_standard_add
Evas_Object * elm_win_util_standard_add(const char *name, const char *title)
Adds a window object with standard setup.
Definition: efl_ui_win.c:9576
Evas
Eo Evas
An opaque handle to an Evas canvas.
Definition: Evas_Common.h:163
evas_object_show
EVAS_API void evas_object_show(Evas_Object *eo_obj)
Makes the given Evas object visible.
Definition: evas_object_main.c:1814
evas_object_color_set
EVAS_API void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a)
Sets the general/main color of the given Evas object to the given one.
Definition: evas_object_main.c:2024
evas_object_evas_get
EVAS_API Evas * evas_object_evas_get(const Eo *eo_obj)
Get the Evas to which this object belongs to.
Definition: evas_object_main.c:2662
evas_object_size_hint_min_set
EVAS_API void evas_object_size_hint_min_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
Sets the hints for an object's minimum size.
Definition: evas_object_main.c:2611
evas_object_rectangle_add
EVAS_API Evas_Object * evas_object_rectangle_add(Evas *e)
Adds a rectangle to the given evas.
Definition: evas_object_rectangle.c:78
_Evas_Coord_Point::y
Evas_Coord y
y co-ordinate
Definition: Evas_Common.h:212
_Evas_Coord_Point::x
Evas_Coord x
x co-ordinate
Definition: Evas_Common.h:211
_Evas_Event_Mouse_Down
Mouse button press event.
Definition: Evas_Legacy.h:160
_Evas_Event_Mouse_Down::canvas
Evas_Coord_Point canvas
The X/Y location of the cursor.
Definition: Evas_Legacy.h:164
menu_it = elm_menu_item_add(menu, NULL, "mail-reply-all", "second item", NULL, NULL);
elm_menu_item_add(menu, menu_it, "object-rotate-left", "menu 1", NULL, NULL);

We now add another item, however this time it won't go the sub-menu and it'll be disabled:

button = elm_button_add(win);
elm_object_text_set(button, "button - delete items");
menu_it1 = elm_menu_item_add(menu, menu_it, NULL, NULL, NULL, NULL);
elm_object_item_content_set(menu_it1, button);
evas_object_smart_callback_add(button, "clicked", _del_it, menu);
elm_menu_item_separator_add(menu, menu_it);
elm_menu_item_add(menu, menu_it, NULL, "third item", NULL, NULL);
elm_menu_item_add(menu, menu_it, NULL, "fourth item", NULL, NULL);
elm_menu_item_add(menu, menu_it, "window-new", "sub menu", NULL, NULL);
menu_it = elm_menu_item_add(menu, NULL, NULL, "third item", NULL, NULL);
elm_object_item_disabled_set(menu_it, EINA_TRUE);
elm_object_item_disabled_set
void elm_object_item_disabled_set(Elm_Widget_Item *obj, Eina_Bool disable)
Control the disabled state of a widget item.
Definition: elm_widget_item_eo.legacy.c:111

To make sure that our menu is shown whenever the window is clicked(and where clicked) we use the following callback:

static void
_del_it(void *data, Evas_Object *obj EINA_UNUSED, void *event_info EINA_UNUSED)
{
const Eina_List *l;
Elm_Object_Item *menu_it = elm_menu_first_item_get(data);
menu_it = elm_menu_item_next_get(menu_it);
l = elm_menu_item_subitems_get(menu_it);
elm_object_item_del(eina_list_data_get(l));
}

Our example will look like this: