WebKitWebNavigationAction

WebKitWebNavigationAction — Object used to report details of navigation actions

Synopsis

                    WebKitWebNavigationAction;
enum                WebKitWebNavigationReason;
gint                webkit_web_navigation_action_get_button
                                                        (WebKitWebNavigationAction *navigationAction);
gint                webkit_web_navigation_action_get_modifier_state
                                                        (WebKitWebNavigationAction *navigationAction);
const gchar *       webkit_web_navigation_action_get_original_uri
                                                        (WebKitWebNavigationAction *navigationAction);
WebKitWebNavigationReason  webkit_web_navigation_action_get_reason
                                                        (WebKitWebNavigationAction *navigationAction);
const gchar *       webkit_web_navigation_action_get_target_frame
                                                        (WebKitWebNavigationAction *navigationAction);
GType               webkit_web_navigation_action_get_type
                                                        (void);
void                webkit_web_navigation_action_set_original_uri
                                                        (WebKitWebNavigationAction *navigationAction,
                                                         const gchar *originalUri);
void                webkit_web_navigation_action_set_reason
                                                        (WebKitWebNavigationAction *navigationAction,
                                                         WebKitWebNavigationReason reason);
GType               webkit_web_navigation_reason_get_type
                                                        (void);

Description

WebKitWebNavigationAction is used in signals to provide details about what led the navigation to happen. This includes, for instance, if the user clicked a link to start that navigation, and what mouse button was used.

Details

WebKitWebNavigationAction

typedef struct {
    GObject parent_instance;
} WebKitWebNavigationAction;


enum WebKitWebNavigationReason

typedef enum {
    WEBKIT_WEB_NAVIGATION_REASON_LINK_CLICKED,
    WEBKIT_WEB_NAVIGATION_REASON_FORM_SUBMITTED,
    WEBKIT_WEB_NAVIGATION_REASON_BACK_FORWARD,
    WEBKIT_WEB_NAVIGATION_REASON_RELOAD,
    WEBKIT_WEB_NAVIGATION_REASON_FORM_RESUBMITTED,
    WEBKIT_WEB_NAVIGATION_REASON_OTHER,
} WebKitWebNavigationReason;


webkit_web_navigation_action_get_button ()

gint                webkit_web_navigation_action_get_button
                                                        (WebKitWebNavigationAction *navigationAction);

Returns the DOM identifier for the mouse button used to click. DOM button values are 0, 1 and 2 for left, middle and right buttons. If the action was not initiated by a mouse click, returns -1.

navigationAction :

a WebKitWebNavigationAction

Returns :

the mouse button used to click

Since 1.0.3


webkit_web_navigation_action_get_modifier_state ()

gint                webkit_web_navigation_action_get_modifier_state
                                                        (WebKitWebNavigationAction *navigationAction);

Returns a bitmask with the the state of the modifier keys.

navigationAction :

a WebKitWebNavigationAction

Returns :

a bitmask with the state of the modifier keys

Since 1.0.3


webkit_web_navigation_action_get_original_uri ()

const gchar *       webkit_web_navigation_action_get_original_uri
                                                        (WebKitWebNavigationAction *navigationAction);

Returns the URI that was originally requested. This may differ from the navigation target, for instance because of a redirect.

navigationAction :

a WebKitWebNavigationAction

Returns :

the originally requested URI

Since 1.0.3


webkit_web_navigation_action_get_reason ()

WebKitWebNavigationReason  webkit_web_navigation_action_get_reason
                                                        (WebKitWebNavigationAction *navigationAction);

Returns the reason why WebKit is requesting a navigation.

navigationAction :

a WebKitWebNavigationAction

Returns :

a WebKitWebNavigationReason

Since 1.0.3


webkit_web_navigation_action_get_target_frame ()

const gchar *       webkit_web_navigation_action_get_target_frame
                                                        (WebKitWebNavigationAction *navigationAction);

Returns the target frame of the action.

navigationAction :

a WebKitWebNavigationAction

Returns :

the target frame of the action or NULL if there is no target.

Since 1.1.13


webkit_web_navigation_action_get_type ()

GType               webkit_web_navigation_action_get_type
                                                        (void);

Returns :


webkit_web_navigation_action_set_original_uri ()

void                webkit_web_navigation_action_set_original_uri
                                                        (WebKitWebNavigationAction *navigationAction,
                                                         const gchar *originalUri);

Sets the URI that was originally requested. This may differ from the navigation target, for instance because of a redirect.

navigationAction :

a WebKitWebNavigationAction

originalUri :

a URI

Since 1.0.3


webkit_web_navigation_action_set_reason ()

void                webkit_web_navigation_action_set_reason
                                                        (WebKitWebNavigationAction *navigationAction,
                                                         WebKitWebNavigationReason reason);

Sets the reason why WebKit is requesting a navigation.

navigationAction :

a WebKitWebNavigationAction

reason :

a WebKitWebNavigationReason

Since 1.0.3


webkit_web_navigation_reason_get_type ()

GType               webkit_web_navigation_reason_get_type
                                                        (void);

Returns :