menu Module

Widget 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:

• clicked - the user clicked the empty space in the menu to dismiss.
• dismissed - the user clicked the empty space in the menu to dismiss (since 1.8)

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

• “default” - A main content of the menu item

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

• “default” - label in the menu item

class efl.elementary.menu.Menu

Bases: efl.elementary.object.Object

This is the class that actually implements the widget.

callback_clicked_add()

The user clicked the empty space in the menu to dismiss.

callback_dismissed_add()

the user clicked the empty space in the menu to dismiss

New in version 1.8.

close()

Close a opened menu

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

first_item

The first item in the menu

Type :MenuItem

item_add(parent = None, label = None, icon = None, callback = None, *args, **kwargs) → MenuItem

Add an item at the end of the given menu widget

Parameters:

• parent (Object) – The parent menu item (optional)
• icon (string) – An icon display on the item. The icon will be destroyed by the menu.
• label (string) – The label of the item.
• callback (function) – Function called when the user select the item.

Returns:

Returns the new item.

Return type:

MenuItem

item_separator_add(parent = None) → MenuSeparatorItem

Add a separator item to menu under parent.

This item is a Separator.

Parameters:parent (Object) – The item to add the separator under Returns:The created item or None on failure Return type:MenuSeparatorItem

items

Returns a list of item‘s.

Type :tuple of MenuItem

last_item

The last item in the menu

Type :MenuItem

move(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:

• x (Evas_Coord (int)) – The new position.
• y (Evas_Coord (int)) – The new position.

parent

The parent for the given menu widget.

Type :Object

selected_item

The selected item in the menu

See also

MenuItem.selected

Type :MenuItem

class efl.elementary.menu.MenuItem

Bases: efl.elementary.object_item.ObjectItem

An item for the Menu widget.

icon_name

The standard icon name of a menu item

Once this icon is set, any previously set icon will be deleted.

Type :string

index

Get the position of a menu item

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

Type :int

is_separator

Returns whether the item is a separator.

See also

Menu.item_separator_add()

Type :bool

next

Get the next item in the menu.

Type :MenuItem

object

Get the Evas_Object of an Elm_Object_Item

Warning

Don’t manipulate this object!

Returns:The edje object containing the swallowed content

prev

Get the previous item in the menu.

Type :MenuItem

selected

The selected state of the item.

Type :bool

subitems

A list of item’s subitems.

Type :tuple of MenuItem

New in version 1.8: Calling del on this property clears the subitems

class efl.elementary.menu.MenuSeparatorItem

Bases: efl.elementary.object_item.ObjectItem

A separator type menu item.

is_separator

Returns whether the item is a separator.

Type :bool

next

Get the next item in the menu.

Type :MenuItem

next_get()

Get the next item in the menu.

Returns:The item after it, or None Return type:MenuItem

prev

Get the previous item in the menu.

Type :MenuItem

prev_get()

Get the previous item in the menu.

Returns:The item before it, or None Return type:MenuItem