Menu

Functions
EOAPI Elm_Object_Item *	elm_obj_menu_selected_item_get (void)
	Get the selected item in the menu. More...
EOAPI const Eina_List *	elm_obj_menu_items_get (void)
	Returns a list of item's items. More...
EOAPI Elm_Object_Item *	elm_obj_menu_first_item_get (void)
	Get the first item in the menu. More...
EOAPI Elm_Object_Item *	elm_obj_menu_last_item_get (void)
	Get the last item in the menu. More...
EOAPI void	elm_obj_menu_move (Evas_Coord x, Evas_Coord y)
	Move the menu to a new position. More...
EOAPI Elm_Object_Item *	elm_obj_menu_item_add (Elm_Object_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_close (void)
	Close a opened menu. More...
EOAPI Elm_Object_Item *	elm_obj_menu_item_separator_add (Elm_Object_Item *parent)
	Add a separator item to menu obj under parent. More...
void	elm_menu::move (Evas_Coord x_, Evas_Coord y_) const
	Move the menu to a new position. More...
Elm_Object_Item *	elm_menu::item_add (Elm_Object_Item *parent_, std::string icon_, std::string label_, Evas_Smart_Cb func_, const void *data_) const
	Add an item at the end of the given menu widget. More...
void	elm_menu::close () const
	Close a opened menu. More...
Elm_Object_Item *	elm_menu::item_separator_add (Elm_Object_Item *parent_) const
	Add a separator item to menu obj under parent. More...
Elm_Object_Item *	elm_menu::selected_item_get () const
	Get the selected item in the menu. More...
const Eina_List *	elm_menu::items_get () const
	Returns a list of item's items. More...
Elm_Object_Item *	elm_menu::first_item_get () const
	Get the first item in the menu. More...
Elm_Object_Item *	elm_menu::last_item_get () const
	Get the last item in the menu. More...
Elm_Object_Item *	elm_menu_selected_item_get (const Elm_Menu *obj)
	Get the selected item in the menu. More...
const Eina_List *	elm_menu_items_get (const Elm_Menu *obj)
	Returns a list of item's items. More...
Elm_Object_Item *	elm_menu_first_item_get (const Elm_Menu *obj)
	Get the first item in the menu. More...
Elm_Object_Item *	elm_menu_last_item_get (const Elm_Menu *obj)
	Get the last item in the menu. More...
void	elm_menu_move (Elm_Menu *obj, Evas_Coord x, Evas_Coord y)
	Move the menu to a new position. More...
Elm_Object_Item *	elm_menu_item_add (Elm_Menu *obj, Elm_Object_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...
void	elm_menu_close (Elm_Menu *obj)
	Close a opened menu. More...
Elm_Object_Item *	elm_menu_item_separator_add (Elm_Menu *obj, Elm_Object_Item *parent)
	Add a separator item to menu obj under parent. More...
Evas_Object *	elm_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_Object *	elm_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:

• "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)
• "language,changed" - the program's language changed (since 1.9)

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" - A label in the menu item

Supported elm_object_item common APIs.

• elm_object_item_del
• elm_object_item_part_text_set
• elm_object_item_part_text_get
• elm_object_item_part_content_set
• elm_object_item_part_content_get
• elm_object_item_disabled_set
• elm_object_item_disabled_get
• elm_object_item_signal_emit (since 1.12)

See also

Menu Example

Function Documentation

void elm_menu::close ( ) const

inline

Close a opened menu.

Returns

void

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

References elm_obj_menu_close().

Evas_Object* elm_menu_add

(

Evas_Object *

parent

)

Add a new menu to the parent.

Parameters

parent

The parent object.

Returns

The new object or NULL if it cannot be created.

void elm_menu_close

(

Elm_Menu *

obj

)

Close a opened menu.

Returns

void

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

References elm_obj_menu_close().

Elm_Object_Item* elm_menu_first_item_get

(

const Elm_Menu *

obj

)

Get the first item in the menu.

Returns

The first item, or NULL if none

References elm_obj_menu_first_item_get().

Elm_Object_Item* elm_menu_item_add	(	Elm_Menu *	obj,
		Elm_Object_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.

Returns

Returns the new item.

Note

This function does not accept relative icon path.

Parameters

[in]	parent	The parent menu item (optional)
[in]	icon	An icon display on the item. The icon will be destroyed by the menu.
[in]	label	The label of the item.
[in]	func	Function called when the user select the item.
[in]	data	Data sent by the callback.

References elm_obj_menu_item_add().

Elm_Object_Item* elm_menu_item_separator_add	(	Elm_Menu *	obj,
		Elm_Object_Item *	parent
	)

Add a separator item to menu obj under parent.

Returns

The created item or NULL on failure

This is item is a Separator.

Parameters

[in]

parent

The item to add the separator under

References elm_obj_menu_item_separator_add().

const Eina_List* elm_menu_items_get

(

const Elm_Menu *

obj

)

Returns a list of item's items.

Returns

An list* of item's items

References elm_obj_menu_items_get().

Elm_Object_Item* elm_menu_last_item_get

(

const Elm_Menu *

obj

)

Get the last item in the menu.

Returns

The last item, or NULL if none

References elm_obj_menu_last_item_get().

void elm_menu_move	(	Elm_Menu *	obj,
		Evas_Coord	x,
		Evas_Coord	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]	x	The new position.
[in]	y	The new position.

References elm_obj_menu_move().

Evas_Object* elm_menu_parent_get

(

const Evas_Object *

obj

)

Get the parent for the given menu widget.

Parameters

obj	The menu object.

Returns

The parent.

See also

elm_menu_parent_set()

void elm_menu_parent_set	(	Evas_Object *	obj,
		Evas_Object *	parent
	)

Set the parent for the given menu widget.

Parameters

obj	The menu object.
parent	The new parent.

Elm_Object_Item* elm_menu_selected_item_get

(

const Elm_Menu *

obj

)

Get the selected item in the menu.

Returns

The selected item, or NULL if none

See also

elm_menu_item_selected_get()

elm_menu_item_selected_set()

References elm_obj_menu_selected_item_get().

EOAPI void elm_obj_menu_close

(

void

)

Close a opened menu.

Returns

void

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

Referenced by elm_menu::close(), and elm_menu_close().

EOAPI Elm_Object_Item* elm_obj_menu_first_item_get

(

void

)

Get the first item in the menu.

Returns

The first item, or NULL if none

Referenced by elm_menu_first_item_get(), and elm_menu::first_item_get().

EOAPI Elm_Object_Item* elm_obj_menu_item_add	(	Elm_Object_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.

Returns

Returns the new item.

Note

This function does not accept relative icon path.

Parameters

[in]	parent	The parent menu item (optional)
[in]	icon	An icon display on the item. The icon will be destroyed by the menu.
[in]	label	The label of the item.
[in]	func	Function called when the user select the item.
[in]	data	Data sent by the callback.

Referenced by elm_menu_item_add(), and elm_menu::item_add().

EOAPI Elm_Object_Item* elm_obj_menu_item_separator_add

(

Elm_Object_Item *

parent

)

Add a separator item to menu obj under parent.

Returns

The created item or NULL on failure

This is item is a Separator.

Parameters

[in]

parent

The item to add the separator under

Referenced by elm_menu_item_separator_add(), and elm_menu::item_separator_add().

EOAPI const Eina_List* elm_obj_menu_items_get

(

void

)

Returns a list of item's items.

Returns

An list* of item's items

Referenced by elm_menu_items_get(), and elm_menu::items_get().

EOAPI Elm_Object_Item* elm_obj_menu_last_item_get

(

void

)

Get the last item in the menu.

Returns

The last item, or NULL if none

Referenced by elm_menu_last_item_get(), and elm_menu::last_item_get().

EOAPI void elm_obj_menu_move	(	Evas_Coord	x,
		Evas_Coord	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]	x	The new position.
[in]	y	The new position.

Referenced by elm_menu_move(), and elm_menu::move().

EOAPI Elm_Object_Item* elm_obj_menu_selected_item_get

(

void

)

Get the selected item in the menu.

Returns

The selected item, or NULL if none

See also

elm_menu_item_selected_get()

elm_menu_item_selected_set()

Referenced by elm_menu_selected_item_get(), and elm_menu::selected_item_get().

Elm_Object_Item* elm_menu::first_item_get ( ) const

inline

Get the first item in the menu.

Returns

The first item, or NULL if none

References elm_obj_menu_first_item_get().

Elm_Object_Item* elm_menu::item_add ( Elm_Object_Item *  parent_, std::string  icon_, std::string  label_, Evas_Smart_Cb  func_, const void *  data_  ) const

inline

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

Returns

Returns the new item.

Note

This function does not accept relative icon path.

Parameters

parent	The parent menu item (optional)
icon	An icon display on the item. The icon will be destroyed by the menu.
label	The label of the item.
func	Function called when the user select the item.
data	Data sent by the callback.

References elm_obj_menu_item_add().

Elm_Object_Item* elm_menu::item_separator_add ( Elm_Object_Item *  parent_ ) const

inline

Add a separator item to menu obj under parent.

Returns

The created item or NULL on failure

This is item is a Separator.

Parameters

parent

The item to add the separator under

References elm_obj_menu_item_separator_add().

const Eina_List* elm_menu::items_get ( ) const

inline

Returns a list of item's items.

Returns

An Eina_List* of item's items

References elm_obj_menu_items_get().

Elm_Object_Item* elm_menu::last_item_get ( ) const

inline

Get the last item in the menu.

Returns

The last item, or NULL if none

References elm_obj_menu_last_item_get().

void elm_menu::move ( Evas_Coord  x_, Evas_Coord  y_  ) const

inline

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	The new position.
y	The new position.

References elm_obj_menu_move().

Elm_Object_Item* elm_menu::selected_item_get ( ) const

inline

Get the selected item in the menu.

Returns

The selected item, or NULL if none

See also

elm_menu_item_selected_get()

elm_menu_item_selected_set()

References elm_obj_menu_selected_item_get().