ewk_context_menu_item.h File Reference

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

#include <Eina.h>

Go to the source code of this file.

Typedefs
typedef struct EwkObject	Ewk_Context_Menu
typedef struct EwkContextMenuItem	Ewk_Context_Menu_Item

Enumerations
enum	Ewk_Context_Menu_Item_Type { EWK_ACTION_TYPE, EWK_CHECKABLE_ACTION_TYPE, EWK_SEPARATOR_TYPE, EWK_SUBMENU_TYPE }
	Defines the types of the items for the context menu.
enum	Ewk_Context_Menu_Item_Action {   EWK_CONTEXT_MENU_ITEM_TAG_NO_ACTION, EWK_CONTEXT_MENU_ITEM_TAG_OPEN_LINK_IN_NEW_WINDOW, EWK_CONTEXT_MENU_ITEM_TAG_DOWNLOAD_LINK_TO_DISK, EWK_CONTEXT_MENU_ITEM_TAG_COPY_LINK_TO_CLIPBOARD,   EWK_CONTEXT_MENU_ITEM_TAG_OPEN_IMAGE_IN_NEW_WINDOW, EWK_CONTEXT_MENU_ITEM_TAG_DOWNLOAD_IMAGE_TO_DISK, EWK_CONTEXT_MENU_ITEM_TAG_COPY_IMAGE_TO_CLIPBOARD, EWK_CONTEXT_MENU_ITEM_TAG_COPY_IMAGE_URL_TO_CLIPBOARD,   EWK_CONTEXT_MENU_ITEM_TAG_OPEN_FRAME_IN_NEW_WINDOW, EWK_CONTEXT_MENU_ITEM_TAG_COPY, EWK_CONTEXT_MENU_ITEM_TAG_GO_BACK, EWK_CONTEXT_MENU_ITEM_TAG_GO_FORWARD,   EWK_CONTEXT_MENU_ITEM_TAG_STOP, EWK_CONTEXT_MENU_ITEM_TAG_RELOAD, EWK_CONTEXT_MENU_ITEM_TAG_CUT, EWK_CONTEXT_MENU_ITEM_TAG_PASTE,   EWK_CONTEXT_MENU_ITEM_TAG_SELECT_ALL, EWK_CONTEXT_MENU_ITEM_TAG_SPELLING_GUESS, EWK_CONTEXT_MENU_ITEM_TAG_NO_GUESSES_FOUND, EWK_CONTEXT_MENU_ITEM_TAG_IGNORE_SPELLING,   EWK_CONTEXT_MENU_ITEM_TAG_LEARN_SPELLING, EWK_CONTEXT_MENU_ITEM_TAG_OTHER, EWK_CONTEXT_MENU_ITEM_TAG_SEARCH_IN_SPOTLIGHT, EWK_CONTEXT_MENU_ITEM_TAG_SEARCH_WEB,   EWK_CONTEXT_MENU_ITEM_TAG_LOOK_UP_IN_DICTIONARY, EWK_CONTEXT_MENU_ITEM_TAG_OPEN_WITH_DEFAULT_APPLICATION, EWK_CONTEXT_MENU_ITEM_PDFACTUAL_SIZE, EWK_CONTEXT_MENU_ITEM_PDFZOOM_IN,   EWK_CONTEXT_MENU_ITEM_PDFZOOM_OUT, EWK_CONTEXT_MENU_ITEM_PDFAUTO_SIZE, EWK_CONTEXT_MENU_ITEM_PDFSINGLE_PAGE, EWK_CONTEXT_MENU_ITEM_PDFFACING_PAGES,   EWK_CONTEXT_MENU_ITEM_PDFCONTINUOUS, EWK_CONTEXT_MENU_ITEM_PDFNEXT_PAGE, EWK_CONTEXT_MENU_ITEM_PDFPREVIOUS_PAGE, EWK_CONTEXT_MENU_ITEM_TAG_OPEN_LINK = 2000,   EWK_CONTEXT_MENU_ITEM_TAG_IGNORE_GRAMMAR, EWK_CONTEXT_MENU_ITEM_TAG_SPELLING_MENU, EWK_CONTEXT_MENU_ITEM_TAG_SHOW_SPELLING_PANEL, EWK_CONTEXT_MENU_ITEM_TAG_CHECK_SPELLING,   EWK_CONTEXT_MENU_ITEM_TAG_CHECK_SPELLING_WHILE_TYPING, EWK_CONTEXT_MENU_ITEM_TAG_CHECK_GRAMMAR_WITH_SPELLING, EWK_CONTEXT_MENU_ITEM_TAG_FONT_MENU, EWK_CONTEXT_MENU_ITEM_TAG_SHOW_FONTS,   EWK_CONTEXT_MENU_ITEM_TAG_BOLD, EWK_CONTEXT_MENU_ITEM_TAG_ITALIC, EWK_CONTEXT_MENU_ITEM_TAG_UNDERLINE, EWK_CONTEXT_MENU_ITEM_TAG_OUTLINE,   EWK_CONTEXT_MENU_ITEM_TAG_STYLES, EWK_CONTEXT_MENU_ITEM_TAG_SHOW_COLORS, EWK_CONTEXT_MENU_ITEM_TAG_SPEECH_MENU, EWK_CONTEXT_MENU_ITEM_TAG_START_SPEAKING,   EWK_CONTEXT_MENU_ITEM_TAG_STOP_SPEAKING, EWK_CONTEXT_MENU_ITEM_TAG_WRITING_DIRECTION_MENU, EWK_CONTEXT_MENU_ITEM_TAG_DEFAULT_DIRECTION, EWK_CONTEXT_MENU_ITEM_TAG_LEFT_TO_RIGHT,   EWK_CONTEXT_MENU_ITEM_TAG_RIGHT_TO_LEFT, EWK_CONTEXT_MENU_ITEM_TAG_PDFSINGLE_PAGE_SCROLLING, EWK_CONTEXT_MENU_ITEM_TAG_PDFFACING_PAGES_SCROLLING, EWK_CONTEXT_MENU_ITEM_TAG_INSPECT_ELEMENT,   EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_MENU, EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_DEFAULT, EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_LEFT_TO_RIGHT, EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_RIGHT_TO_LEFT,   EWK_CONTEXT_MENU_ITEM_OPEN_MEDIA_IN_NEW_WINDOW, EWK_CONTEXT_MENU_ITEM_TAG_DOWNLOAD_MEDIA_TO_DISK, EWK_CONTEXT_MENU_ITEM_TAG_COPY_MEDIA_LINK_TO_CLIPBOARD, EWK_CONTEXT_MENU_ITEM_TAG_TOGGLE_MEDIA_CONTROLS,   EWK_CONTEXT_MENU_ITEM_TAG_TOGGLE_MEDIA_LOOP, EWK_CONTEXT_MENU_ITEM_TAG_ENTER_VIDEO_FULLSCREEN, EWK_CONTEXT_MENU_ITEM_TAG_MEDIA_PLAY_PAUSE, EWK_CONTEXT_MENU_ITEM_TAG_MEDIA_MUTE,   EWK_CONTEXT_MENU_ITEM_BASE_APPLICATION_TAG = 10000 }

Functions
EAPI Ewk_Context_Menu_Item *	ewk_context_menu_item_new (Ewk_Context_Menu_Item_Type type, Ewk_Context_Menu_Item_Action action, const char *title, Eina_Bool checked, Eina_Bool enabled)
EAPI Ewk_Context_Menu_Item *	ewk_context_menu_item_new_with_submenu (Ewk_Context_Menu_Item_Action action, const char *title, Eina_Bool enabled, Ewk_Context_Menu *submenu)
EAPI Ewk_Context_Menu_Item_Type	ewk_context_menu_item_type_get (const Ewk_Context_Menu_Item *o)
EAPI Eina_Bool	ewk_context_menu_item_type_set (Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Item_Type type)
EAPI Ewk_Context_Menu_Item_Action	ewk_context_menu_item_action_get (const Ewk_Context_Menu_Item *o)
EAPI Eina_Bool	ewk_context_menu_item_action_set (Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Item_Action action)
EAPI const char *	ewk_context_menu_item_title_get (const Ewk_Context_Menu_Item *o)
EAPI Eina_Bool	ewk_context_menu_item_title_set (Ewk_Context_Menu_Item *o, const char *title)
EAPI Eina_Bool	ewk_context_menu_item_checked_get (const Ewk_Context_Menu_Item *o)
EAPI Eina_Bool	ewk_context_menu_item_checked_set (Ewk_Context_Menu_Item *o, Eina_Bool checked)
EAPI Eina_Bool	ewk_context_menu_item_enabled_get (const Ewk_Context_Menu_Item *o)
EAPI Eina_Bool	ewk_context_menu_item_enabled_set (Ewk_Context_Menu_Item *o, Eina_Bool enabled)
EAPI Ewk_Context_Menu *	ewk_context_menu_item_parent_menu_get (const Ewk_Context_Menu_Item *o)
EAPI Ewk_Context_Menu *	ewk_context_menu_item_submenu_get (const Ewk_Context_Menu_Item *o)

Detailed Description

Describes the Ewk Context Menu Item API.

Typedef Documentation

typedef struct EwkObject Ewk_Context_Menu

Declare Ewk_Context_Menu as Ewk_Object.

See also

Ewk_Object

typedef struct EwkContextMenuItem Ewk_Context_Menu_Item

Creates a type name for Ewk_Context_Menu_Item

Enumeration Type Documentation

enum Ewk_Context_Menu_Item_Action

Enumerator
EWK_CONTEXT_MENU_ITEM_TAG_SPELLING_MENU	spelling or spelling/grammar sub-menu
EWK_CONTEXT_MENU_ITEM_TAG_FONT_MENU	font sub-menu
EWK_CONTEXT_MENU_ITEM_TAG_SPEECH_MENU	speech sub-menu
EWK_CONTEXT_MENU_ITEM_TAG_WRITING_DIRECTION_MENU	writing direction sub-menu
EWK_CONTEXT_MENU_ITEM_TAG_TEXT_DIRECTION_MENU	text direction sub-menu

Function Documentation

EAPI Ewk_Context_Menu_Item_Action ewk_context_menu_item_action_get

(

const Ewk_Context_Menu_Item *

o

)

Gets an action of the item.

Parameters

o	the item to get the action

Returns

an action of the item on success or EWK_CONTEXT_MENU_ITEM_TAG_NO_ACTION on failure

See also

ewk_context_menu_item_action_set

EAPI Eina_Bool ewk_context_menu_item_action_set	(	Ewk_Context_Menu_Item *	o,
		Ewk_Context_Menu_Item_Action	action
	)

Sets an action of the item.

Parameters

o	the item to set the action
action	a new action for the item object

Returns

EINA_TRUE on success, or EINA_FALSE on failure

See also

ewk_context_menu_item_action_get

EAPI Eina_Bool ewk_context_menu_item_checked_get

(

const Ewk_Context_Menu_Item *

o

)

Queries if the item is toggled.

Parameters

o	the item to query if the item is toggled

Returns

EINA_TRUE if the item is toggled or EINA_FALSE if not or on failure

EAPI Eina_Bool ewk_context_menu_item_checked_set	(	Ewk_Context_Menu_Item *	o,
		Eina_Bool	checked
	)

Sets if the item should be toggled.

Parameters

o	the item to be toggled
checked	EINA_TRUE if the item should be toggled or EINA_FALSE if not

Returns

EINA_TRUE on success or EINA_FALSE on failure

EAPI Eina_Bool ewk_context_menu_item_enabled_get

(

const Ewk_Context_Menu_Item *

o

)

Gets if the item is enabled.

Parameters

o	the item to get enabled state

Returns

EINA_TRUE if it's enabled, EINA_FALSE if not or on failure

See also

ewk_context_menu_item_enabled_set

EAPI Eina_Bool ewk_context_menu_item_enabled_set	(	Ewk_Context_Menu_Item *	o,
		Eina_Bool	enabled
	)

Enables/disables the item.

Parameters

o	the item to enable/disable
enabled	EINA_TRUE to enable the item or EINA_FALSE to disable

Returns

EINA_TRUE on success, or EINA_FALSE on failure

See also

ewk_context_menu_item_enabled_get

EAPI Ewk_Context_Menu_Item* ewk_context_menu_item_new	(	Ewk_Context_Menu_Item_Type	type,
		Ewk_Context_Menu_Item_Action	action,
		const char *	title,
		Eina_Bool	checked,
		Eina_Bool	enabled
	)

Creates a new item of the context menu.

Parameters

type	specifies a type of the item
action	specifies a action of the item
title	specifies a title of the item
checked	EINA_TRUE if the item should be toggled or EINA_FALSE if not
enabled	EINA_TRUE to enable the item or EINA_FALSE to disable

Returns

the pointer to the new item

See also

ewk_context_menu_item_new_with_submenu

EAPI Ewk_Context_Menu_Item* ewk_context_menu_item_new_with_submenu	(	Ewk_Context_Menu_Item_Action	action,
		const char *	title,
		Eina_Bool	enabled,
		Ewk_Context_Menu *	submenu
	)

Creates a new sub menu type item of the context menu.

Parameters

action	specifies a action of the item
title	specifies a title of the item
enabled	EINA_TRUE to enable the item or EINA_FALSE to disable
submenu	specifies a submenu of the item

Returns

the pointer to the new item

See also

ewk_context_menu_item_new

EAPI Ewk_Context_Menu* ewk_context_menu_item_parent_menu_get

(

const Ewk_Context_Menu_Item *

o

)

Gets the parent menu for the item.

Parameters

o	item to get the parent

Returns

the pointer to parent menu on success or NULL on failure

EAPI Ewk_Context_Menu* ewk_context_menu_item_submenu_get

(

const Ewk_Context_Menu_Item *

o

)

Gets the submenu for the item.

Parameters

o	item to get the submenu

Returns

the pointer to submenu on success or NULL on failure

EAPI const char* ewk_context_menu_item_title_get

(

const Ewk_Context_Menu_Item *

o

)

Gets a title of the item.

Parameters

o	the item to get the title

Returns

a title of the item on success, or NULL on failure

See also

ewk_context_menu_item_title_set

EAPI Eina_Bool ewk_context_menu_item_title_set	(	Ewk_Context_Menu_Item *	o,
		const char *	title
	)

Sets a title of the item.

Parameters

o	the item to set the title
title	a new title for the item object

Returns

EINA_TRUE on success, or EINA_FALSE on failure

See also

ewk_context_menu_item_title_get

EAPI Ewk_Context_Menu_Item_Type ewk_context_menu_item_type_get

(

const Ewk_Context_Menu_Item *

o

)

Gets type of the item.

Parameters

o	the item to get the type

Returns

type of the item on success or EWK_ACTION_TYPE on failure

See also

ewk_context_menu_item_type_set

EAPI Eina_Bool ewk_context_menu_item_type_set	(	Ewk_Context_Menu_Item *	o,
		Ewk_Context_Menu_Item_Type	type
	)

Sets the type of item.

Parameters

o	the item to set the type
type	a new type for the item object

Returns

EINA_TRUE on success, or EINA_FALSE on failure

See also

ewk_context_menu_item_type_get