ewk_navigation_policy_decision.h File Reference

Describes the Ewk navigation policy decision API. More...

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

Go to the source code of this file.

Typedefs
typedef struct EwkObject	Ewk_Navigation_Policy_Decision

Enumerations
enum	Ewk_Navigation_Type {   EWK_NAVIGATION_TYPE_LINK_ACTIVATED, EWK_NAVIGATION_TYPE_FORM_SUBMITTED, EWK_NAVIGATION_TYPE_BACK_FORWARD, EWK_NAVIGATION_TYPE_RELOAD,   EWK_NAVIGATION_TYPE_FORM_RESUBMITTED, EWK_NAVIGATION_TYPE_OTHER }
	Enum containing navigation types.
enum	Ewk_Event_Mouse_Button { EWK_EVENT_MOUSE_BUTTON_NONE = -1, EWK_EVENT_MOUSE_BUTTON_LEFT = 0, EWK_EVENT_MOUSE_BUTTON_MIDDLE = 1, EWK_EVENT_MOUSE_BUTTON_RIGHT = 2 }
	Enum containing button types.
enum	Ewk_Event_Modifiers {   EWK_EVENT_MODIFIER_NONE = 0, EWK_EVENT_MODIFIER_SHIFT = 1 << 0, EWK_EVENT_MODIFIER_CTRL = 1 << 1, EWK_EVENT_MODIFIER_ALT = 1 << 2,   EWK_EVENT_MODIFIER_META = 1 << 3 }
	Enum containing modifier key.

Functions
EAPI Ewk_Navigation_Type	ewk_navigation_policy_navigation_type_get (const Ewk_Navigation_Policy_Decision *decision)
EAPI Ewk_Event_Mouse_Button	ewk_navigation_policy_mouse_button_get (const Ewk_Navigation_Policy_Decision *decision)
EAPI Ewk_Event_Modifiers	ewk_navigation_policy_modifiers_get (const Ewk_Navigation_Policy_Decision *decision)
EAPI const char *	ewk_navigation_policy_frame_name_get (const Ewk_Navigation_Policy_Decision *decision)
EAPI Ewk_Url_Request *	ewk_navigation_policy_request_get (const Ewk_Navigation_Policy_Decision *decision)
EAPI void	ewk_navigation_policy_decision_accept (Ewk_Navigation_Policy_Decision *decision)
EAPI void	ewk_navigation_policy_decision_reject (Ewk_Navigation_Policy_Decision *decision)
EAPI void	ewk_navigation_policy_decision_download (Ewk_Navigation_Policy_Decision *decision)

Detailed Description

Describes the Ewk navigation policy decision API.

Typedef Documentation

typedef struct EwkObject Ewk_Navigation_Policy_Decision

Declare Ewk_Navigation_Policy_Decision as Ewk_Object.

See also

Ewk_Object

Function Documentation

EAPI void ewk_navigation_policy_decision_accept

(

Ewk_Navigation_Policy_Decision *

decision

)

Accepts the navigation request.

The navigation will be accepted by default.

Parameters

decision

navigation policy decision object to query.

EAPI void ewk_navigation_policy_decision_download

(

Ewk_Navigation_Policy_Decision *

decision

)

Triggers a download instead of navigating to the url.

Parameters

decision

navigation policy decision object to query.

EAPI void ewk_navigation_policy_decision_reject

(

Ewk_Navigation_Policy_Decision *

decision

)

Rejects the navigation request.

Parameters

decision

navigation policy decision object to query.

EAPI const char* ewk_navigation_policy_frame_name_get

(

const Ewk_Navigation_Policy_Decision *

decision

)

Query frame name for this navigation policy decision.

The frame name is non-null for new window policy decisions only.

Parameters

decision

navigation policy decision object to query.

Returns

the frame name pointer, that may be NULL. 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_Event_Modifiers ewk_navigation_policy_modifiers_get

(

const Ewk_Navigation_Policy_Decision *

decision

)

Query modifier keys for this navigation policy decision.

Parameters

decision

navigation policy decision object to query.

Returns

the modifier keys used when triggering the navigation.

EAPI Ewk_Event_Mouse_Button ewk_navigation_policy_mouse_button_get

(

const Ewk_Navigation_Policy_Decision *

decision

)

Query mouse button for this navigation policy decision.

Parameters

decision

navigation policy decision object to query.

Returns

the mouse button clicked to trigger the navigation.

EAPI Ewk_Navigation_Type ewk_navigation_policy_navigation_type_get

(

const Ewk_Navigation_Policy_Decision *

decision

)

Query type for this navigation policy decision.

Parameters

decision

navigation policy decision object to query.

Returns

the type of navigation.

EAPI Ewk_Url_Request* ewk_navigation_policy_request_get

(

const Ewk_Navigation_Policy_Decision *

decision

)

Query URL request for this navigation policy decision.

Parameters

decision

navigation policy decision object to query.

Returns

The URL request pointer or NULL in case of error.