ewk_popup_menu_item.h File Reference

Describes the Ewk Popup Menu Item API. More...

#include "ewk_view.h"
#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkPopupMenuItem	Ewk_Popup_Menu_Item

Enumerations
enum	Ewk_Popup_Menu_Item_Type { EWK_POPUP_MENU_SEPARATOR, EWK_POPUP_MENU_ITEM, EWK_POPUP_MENU_UNKNOWN = -1 }

Functions
EAPI Ewk_Popup_Menu_Item_Type	ewk_popup_menu_item_type_get (const Ewk_Popup_Menu_Item *item)
EAPI const char *	ewk_popup_menu_item_text_get (const Ewk_Popup_Menu_Item *item)
EAPI Ewk_Text_Direction	ewk_popup_menu_item_text_direction_get (const Ewk_Popup_Menu_Item *item)
EAPI Eina_Bool	ewk_popup_menu_item_text_direction_override_get (const Ewk_Popup_Menu_Item *item)
EAPI const char *	ewk_popup_menu_item_tooltip_get (const Ewk_Popup_Menu_Item *item)
EAPI const char *	ewk_popup_menu_item_accessibility_text_get (const Ewk_Popup_Menu_Item *item)
EAPI Eina_Bool	ewk_popup_menu_item_enabled_get (const Ewk_Popup_Menu_Item *item)
EAPI Eina_Bool	ewk_popup_menu_item_is_label_get (const Ewk_Popup_Menu_Item *item)
EAPI Eina_Bool	ewk_popup_menu_item_selected_get (const Ewk_Popup_Menu_Item *item)

Detailed Description

Describes the Ewk Popup Menu Item API.

Typedef Documentation

typedef struct EwkPopupMenuItem Ewk_Popup_Menu_Item

Creates a type name for Ewk_Popup_Menu_Item

Enumeration Type Documentation

enum Ewk_Popup_Menu_Item_Type

Enum values containing type of popup menu item.

Function Documentation

EAPI const char* ewk_popup_menu_item_accessibility_text_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns accessibility text of the popup menu item.

Parameters

item	the popup menu item instance

Returns

the accessibility text of the item or NULL in case of error. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()

EAPI Eina_Bool ewk_popup_menu_item_enabled_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns whether the popup menu item is enabled or not.

Parameters

item	the popup menu item instance

Returns

EINA_TRUE if ther popup menu item is enabled, EINA_FALSE otherwise.

EAPI Eina_Bool ewk_popup_menu_item_is_label_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns whether the popup menu item is label or not.

Parameters

item	the popup menu item instance

Returns

EINA_TRUE if the popup menu item is label, EINA_FALSE otherwise.

EAPI Eina_Bool ewk_popup_menu_item_selected_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns whether the popup menu item is selected or not.

Parameters

item	the popup menu item instance

Returns

EINA_TRUE if the popup menu item is selected, EINA_FALSE otherwise.

EAPI Ewk_Text_Direction ewk_popup_menu_item_text_direction_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns text direction of the popup menu item.

Parameters

item	the popup menu item instance

Returns

the text direction of the item.

EAPI Eina_Bool ewk_popup_menu_item_text_direction_override_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns whether the popup menu item has text direction override.

Parameters

item	the popup menu item instance

Returns

EINA_TRUE if the popup menu item has text direction override, EINA_FALSE otherwise.

EAPI const char* ewk_popup_menu_item_text_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns text of the popup menu item.

Parameters

item	the popup menu item instance

Returns

the text of the item or NULL in case of error. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()

EAPI const char* ewk_popup_menu_item_tooltip_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns tooltip of the popup menu item.

Parameters

item	the popup menu item instance

Returns

the tooltip of the item or NULL in case of error. This pointer is guaranteed to be eina_stringshare, so whenever possible save yourself some cpu cycles and use eina_stringshare_ref() instead of eina_stringshare_add() or strdup()

EAPI Ewk_Popup_Menu_Item_Type ewk_popup_menu_item_type_get

(

const Ewk_Popup_Menu_Item *

item

)

Returns type of the popup menu item.

Parameters

item	the popup menu item instance

Returns

the type of the item or EWK_POPUP_MENU_UNKNOWN in case of error.