| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.WebKit2.Structs.NavigationAction
Description
No description available in the introspection data.
Synopsis
- newtype NavigationAction = NavigationAction (ManagedPtr NavigationAction)
- navigationActionCopy :: (HasCallStack, MonadIO m) => NavigationAction -> m NavigationAction
- navigationActionFree :: (HasCallStack, MonadIO m) => NavigationAction -> m ()
- navigationActionGetModifiers :: (HasCallStack, MonadIO m) => NavigationAction -> m Word32
- navigationActionGetMouseButton :: (HasCallStack, MonadIO m) => NavigationAction -> m Word32
- navigationActionGetNavigationType :: (HasCallStack, MonadIO m) => NavigationAction -> m NavigationType
- navigationActionGetRequest :: (HasCallStack, MonadIO m) => NavigationAction -> m URIRequest
- navigationActionIsRedirect :: (HasCallStack, MonadIO m) => NavigationAction -> m Bool
- navigationActionIsUserGesture :: (HasCallStack, MonadIO m) => NavigationAction -> m Bool
Exported types
newtype NavigationAction Source #
Memory-managed wrapper type.
Constructors
| NavigationAction (ManagedPtr NavigationAction) |
Instances
Methods
Click to display all available methods, including inherited ones
Methods
copy, free, isRedirect, isUserGesture.
Getters
getModifiers, getMouseButton, getNavigationType, getRequest.
Setters
None.
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m NavigationAction | Returns: A copy of passed in |
Make a copy of navigation.
Since: 2.6
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m () |
Free the NavigationAction
Since: 2.6
getModifiers
navigationActionGetModifiers Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m Word32 | Returns: the modifier keys |
Return a bitmask of ModifierType values describing the modifier keys that were in effect
when the navigation was requested
Since: 2.6
getMouseButton
navigationActionGetMouseButton Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m Word32 | Returns: the mouse button number or 0 |
Return the number of the mouse button that triggered the navigation, or 0 if the navigation was not started by a mouse event.
Since: 2.6
getNavigationType
navigationActionGetNavigationType Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m NavigationType | Returns: a |
Return the type of action that triggered the navigation.
Since: 2.6
getRequest
navigationActionGetRequest Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m URIRequest | Returns: a |
Return the URIRequest associated with the navigation action.
Modifications to the returned object are <emphasis>not</emphasis> 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.
Since: 2.6
isRedirect
navigationActionIsRedirect Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m Bool | Returns: |
Returns whether the navigation was redirected.
Since: 2.20
isUserGesture
navigationActionIsUserGesture Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => NavigationAction |
|
| -> m Bool | Returns: whether navigation action is a user gesture |
Return whether the navigation was triggered by a user gesture like a mouse click.
Since: 2.6