ewk_popup_menu.h File Reference

Describes the Ewk Popup Menu API. More...

#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkPopupMenu	Ewk_Popup_Menu

Functions
EAPI Eina_Bool	ewk_popup_menu_selected_index_set (Ewk_Popup_Menu *popup_menu, unsigned index)
EAPI unsigned	ewk_popup_menu_selected_index_get (const Ewk_Popup_Menu *popup_menu)
EAPI Eina_Bool	ewk_popup_menu_close (Ewk_Popup_Menu *popup_menu)
EAPI const Eina_List *	ewk_popup_menu_items_get (const Ewk_Popup_Menu *popup_menu)

Detailed Description

Describes the Ewk Popup Menu API.

Typedef Documentation

typedef struct EwkPopupMenu Ewk_Popup_Menu

Creates a type name for Ewk_Popup_Menu

Function Documentation

EAPI Eina_Bool ewk_popup_menu_close

(

Ewk_Popup_Menu *

popup_menu

)

Closes current popup menu.

The Ewk_Popup_Menu object becomes invalid after calling this function.

Parameters

popup_menu

popup menu object

Returns

EINA_TRUE on success, EINA_FALSE on failure

EAPI const Eina_List* ewk_popup_menu_items_get

(

const Ewk_Popup_Menu *

popup_menu

)

Retrieve the popup menu items

Parameters

popup_menu

popup menu object

Returns

list of popup menu items on success, NULL otherwise

EAPI unsigned ewk_popup_menu_selected_index_get

(

const Ewk_Popup_Menu *

popup_menu

)

Returns the index of the currently selected item in the popup menu.

Parameters

popup_menu

popup menu object

Returns

index of the currently selected popup item on success, 0 otherwise

EAPI Eina_Bool ewk_popup_menu_selected_index_set	(	Ewk_Popup_Menu *	popup_menu,
		unsigned	index
	)

Selects index of current popup menu.

Parameters

popup_menu	popup menu object
index	index of item to select

Returns

EINA_TRUE on success, EINA_FALSE on failure (e.g. the index is out of range)