WebKit2.NavigationAction

Fields

None

Methods

copy ()

free ()

get_frame_name ()

get_modifiers ()

get_mouse_button ()

get_navigation_type ()

get_request ()

is_redirect ()

is_user_gesture ()

Details

class WebKit2.NavigationAction

Provides details about interaction resulting in a resource load.

copy()
Returns:

A copy of passed in WebKit2.NavigationAction

Return type:

WebKit2.NavigationAction

Make a copy of self.

Added in version 2.6.

free()

Free the WebKit2.NavigationAction

Added in version 2.6.

get_frame_name()
Returns:

The name of the new frame this navigation action targets or None

Return type:

str or None

Gets the self target frame name. For example if navigation was triggered by clicking a link with a target attribute equal to “_blank”, this will return the value of that attribute. In all other cases this function will return None.

Added in version 2.40.

get_modifiers()
Returns:

the modifier keys

Return type:

int

Return the modifier keys.

Return a bitmask of Gdk.ModifierType values describing the modifier keys that were in effect when the navigation was requested

Added in version 2.6.

get_mouse_button()
Returns:

the mouse button number or 0

Return type:

int

Return the number of the mouse button that triggered the navigation.

Return the number of the mouse button that triggered the navigation, or 0 if the navigation was not started by a mouse event.

Added in version 2.6.

get_navigation_type()
Returns:

a WebKit2.NavigationType

Return type:

WebKit2.NavigationType

Return the type of action that triggered the navigation.

Added in version 2.6.

get_request()
Returns:

a WebKit2.URIRequest

Return type:

WebKit2.URIRequest

Return the WebKit2.URIRequest associated with the navigation action.

Modifications to the returned object are not taken into account when the request is sent over the network, and is intended only to aid in evaluating whether a navigation action should be taken or not. To modify requests before they are sent over the network the #WebKitPage::send-request signal can be used instead.

Added in version 2.6.

is_redirect()
Returns:

True if the original navigation was redirected, False otherwise.

Return type:

bool

Returns whether the self was redirected.

Added in version 2.20.

is_user_gesture()
Returns:

whether navigation action is a user gesture

Return type:

bool

Return whether the navigation was triggered by a user gesture like a mouse click.

Added in version 2.6.