Macros | Functions

Macros

#define ELM_MENU_CLASS   elm_menu_class_get()
 Elementary menu class.
 
#define ELM_MENU_EVENT_DISMISSED   (&(_ELM_MENU_EVENT_DISMISSED))
 Called when menu widget was dismissed.
 
#define ELM_MENU_EVENT_ELM_ACTION_BLOCK_MENU   (&(_ELM_MENU_EVENT_ELM_ACTION_BLOCK_MENU))
 Called when menu blocking have been enabled.
 
#define ELM_MENU_EVENT_ELM_ACTION_UNBLOCK_MENU   (&(_ELM_MENU_EVENT_ELM_ACTION_UNBLOCK_MENU))
 Called when menu blocking has been disabled.
 

Functions

EOAPI Elm_Widget_Itemelm_obj_menu_selected_item_get (const Eo *obj)
 Get the selected item in the widget. More...
 
EOAPI Elm_Widget_Itemelm_obj_menu_first_item_get (const Eo *obj)
 Get the first item in the widget. More...
 
EOAPI Elm_Widget_Itemelm_obj_menu_last_item_get (const Eo *obj)
 Get the last item in the widget. More...
 
EOAPI const Eina_Listelm_obj_menu_items_get (const Eo *obj)
 Returns a list of the widget item. More...
 
EOAPI void elm_obj_menu_relative_move (Eo *obj, int x, int y)
 Move the menu to a new position. More...
 
EOAPI Elm_Widget_Itemelm_obj_menu_item_add (Eo *obj, Elm_Widget_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data)
 Add an item at the end of the given menu widget. More...
 
EOAPI void elm_obj_menu_open (Eo *obj)
 Open a closed menu. More...
 
EOAPI void elm_obj_menu_close (Eo *obj)
 Close a opened menu. More...
 
EOAPI Elm_Widget_Itemelm_obj_menu_item_separator_add (Eo *obj, Elm_Widget_Item *parent)
 Add a separator item to menu obj under parent. More...
 
Evas_Objectelm_menu_add (Evas_Object *parent)
 Add a new menu to the parent. More...
 
void elm_menu_parent_set (Evas_Object *obj, Evas_Object *parent)
 Set the parent for the given menu widget. More...
 
Evas_Objectelm_menu_parent_get (const Evas_Object *obj)
 Get the parent for the given menu widget. More...
 

Detailed Description

A menu is a list of items displayed above its parent. When the menu is showing its parent is darkened. Each item can have a sub-menu. The menu object can be used to display a menu on a right click event, in a toolbar, anywhere.

Signals that you can add callbacks for are:

Default content parts of the menu items that you can use for are:

Default text parts of the menu items that you can use for are:

Supported elm_object_item common APIs.

See also
Menu Example

Function Documentation

◆ elm_obj_menu_selected_item_get()

EOAPI Elm_Widget_Item * elm_obj_menu_selected_item_get ( const Eo *  obj)

Get the selected item in the widget.

Parameters
[in]objThe object.
Returns
The selected item or null.

◆ elm_obj_menu_first_item_get()

EOAPI Elm_Widget_Item * elm_obj_menu_first_item_get ( const Eo *  obj)

Get the first item in the widget.

Parameters
[in]objThe object.
Returns
The first item or null.

◆ elm_obj_menu_last_item_get()

EOAPI Elm_Widget_Item * elm_obj_menu_last_item_get ( const Eo *  obj)

Get the last item in the widget.

Parameters
[in]objThe object.
Returns
The last item or null.

◆ elm_obj_menu_items_get()

EOAPI const Eina_List * elm_obj_menu_items_get ( const Eo *  obj)

Returns a list of the widget item.

Parameters
[in]objThe object.
Returns
const list to widget items

◆ elm_obj_menu_relative_move()

EOAPI void elm_obj_menu_relative_move ( Eo *  obj,
int  x,
int  y 
)

Move the menu to a new position.

Sets the top-left position of the menu to ($x, y).

Note
x and y coordinates are relative to parent.
Parameters
[in]objThe object.
[in]xThe new X coordinate
[in]yThe new Y coordinate

◆ elm_obj_menu_item_add()

EOAPI Elm_Widget_Item * elm_obj_menu_item_add ( Eo *  obj,
Elm_Widget_Item parent,
const char *  icon,
const char *  label,
Evas_Smart_Cb  func,
const void *  data 
)

Add an item at the end of the given menu widget.

Note
This function does not accept relative icon path.
Parameters
[in]objThe object.
[in]parentThe parent menu item (optional).
[in]iconAn icon display on the item. The icon will be destroyed by the menu.
[in]labelThe label of the item.
[in]funcFunction called when the user select the item.
[in]dataData sent by the callback.
Returns
The new menu item.

◆ elm_obj_menu_open()

EOAPI void elm_obj_menu_open ( Eo *  obj)

Open a closed menu.

Show the menu with no child sub-menus expanded..

Parameters
[in]objThe object.

◆ elm_obj_menu_close()

EOAPI void elm_obj_menu_close ( Eo *  obj)

Close a opened menu.

Hides the menu and all it's sub-menus.

Parameters
[in]objThe object.

◆ elm_obj_menu_item_separator_add()

EOAPI Elm_Widget_Item * elm_obj_menu_item_separator_add ( Eo *  obj,
Elm_Widget_Item parent 
)

Add a separator item to menu obj under parent.

Parameters
[in]objThe object.
[in]parentThe item to add the separator under.
Returns
The created item or null.

◆ elm_menu_add()

Evas_Object * elm_menu_add ( Evas_Object parent)

Add a new menu to the parent.

Parameters
parentThe parent object.
Returns
The new object or NULL if it cannot be created.

References EINA_SAFETY_ON_NULL_RETURN_VAL.

Referenced by elm_win_main_menu_get().

◆ elm_menu_parent_set()

void elm_menu_parent_set ( Evas_Object obj,
Evas_Object parent 
)

Set the parent for the given menu widget.

Parameters
objThe menu object.
parentThe new parent.

◆ elm_menu_parent_get()

Evas_Object * elm_menu_parent_get ( const Evas_Object obj)

Get the parent for the given menu widget.

Parameters
objThe menu object.
Returns
The parent.
See also
elm_menu_parent_set()