![]() |
![]() |
![]() |
WebKitGTK+ Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
WebKitWebNavigationActionWebKitWebNavigationAction — Object used to report details of navigation actions |
struct 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
); void webkit_web_navigation_action_set_original_uri (WebKitWebNavigationAction *navigationAction
,const gchar *originalUri
); void webkit_web_navigation_action_set_reason (WebKitWebNavigationAction *navigationAction
,WebKitWebNavigationReason reason
);
"button" gint : Read / Write / Construct Only "modifier-state" gint : Read / Write / Construct Only "original-uri" gchar* : Read / Write / Construct "reason" WebKitWebNavigationReason : Read / Write / Construct "target-frame" gchar* : Read / Write / Construct Only
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.
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;
Enum values used to denote the various navigation reasons.
The navigation was triggered by clicking a link. | |
The navigation was triggered by submitting a form. | |
The navigation was triggered by navigating forward or backward. | |
The navigation was triggered by reloading. | |
The navigation was triggered by resubmitting a form. | |
The navigation was triggered by some other action. |
gint webkit_web_navigation_action_get_button
(WebKitWebNavigationAction *navigationAction
);
The GTK+ identifier for the mouse button used to click. Notice that GTK+ button values are 1, 2 and 3 for left, middle and right buttons, so they are DOM button values +1. If the action was not initiated by a mouse click the value will be -1.
|
a WebKitWebNavigationAction |
Returns : |
the mouse button used to click |
Since 1.0.3
gint webkit_web_navigation_action_get_modifier_state
(WebKitWebNavigationAction *navigationAction
);
Returns a bitmask with the the state of the modifier keys.
|
a WebKitWebNavigationAction |
Returns : |
a bitmask with the state of the modifier keys |
Since 1.0.3
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.
|
a WebKitWebNavigationAction |
Returns : |
the originally requested URI |
Since 1.0.3
WebKitWebNavigationReason webkit_web_navigation_action_get_reason
(WebKitWebNavigationAction *navigationAction
);
Returns the reason why WebKit is requesting a navigation.
|
a WebKitWebNavigationAction |
Returns : |
a WebKitWebNavigationReason |
Since 1.0.3
const gchar * webkit_web_navigation_action_get_target_frame
(WebKitWebNavigationAction *navigationAction
);
Returns the target frame of the action.
|
a WebKitWebNavigationAction |
Returns : |
the target frame of the action or NULL if there is no target. |
Since 1.1.13
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.
|
a WebKitWebNavigationAction |
|
a URI |
Since 1.0.3
void webkit_web_navigation_action_set_reason (WebKitWebNavigationAction *navigationAction
,WebKitWebNavigationReason reason
);
Sets the reason why WebKit is requesting a navigation.
|
a WebKitWebNavigationAction |
|
a WebKitWebNavigationReason |
Since 1.0.3
"button"
property"button" gint : Read / Write / Construct Only
The GTK+ identifier for the mouse button used to click. Notice that GTK+ button values are 1, 2 and 3 for left, middle and right buttons, so they are DOM button values +1. If the action was not initiated by a mouse click the value will be -1.
Allowed values: >= -1
Default value: -1
Since 1.0.3
"modifier-state"
property"modifier-state" gint : Read / Write / Construct Only
The state of the modifier keys when the action was requested.
Allowed values: >= 0
Default value: 0
Since 1.0.3
"original-uri"
property"original-uri" gchar* : Read / Write / Construct
The URI that was requested as the target for the navigation.
Default value: ""
Since 1.0.3
"reason"
property"reason" WebKitWebNavigationReason : Read / Write / Construct
The reason why this navigation is occuring.
Default value: WEBKIT_WEB_NAVIGATION_REASON_OTHER
Since 1.0.3
"target-frame"
property"target-frame" gchar* : Read / Write / Construct Only
The target frame for the navigation.
Default value: NULL
Since 1.1.13