Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
WebNavigationAction
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.
- newtype WebNavigationAction = WebNavigationAction (ManagedPtr WebNavigationAction)
- class GObject o => IsWebNavigationAction o
- toWebNavigationAction :: IsWebNavigationAction o => o -> IO WebNavigationAction
- noWebNavigationAction :: Maybe WebNavigationAction
- data WebNavigationActionGetButtonMethodInfo
- webNavigationActionGetButton :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> m Int32
- data WebNavigationActionGetModifierStateMethodInfo
- webNavigationActionGetModifierState :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> m Int32
- data WebNavigationActionGetOriginalUriMethodInfo
- webNavigationActionGetOriginalUri :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> m Text
- data WebNavigationActionGetReasonMethodInfo
- webNavigationActionGetReason :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> m WebNavigationReason
- data WebNavigationActionGetTargetFrameMethodInfo
- webNavigationActionGetTargetFrame :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> m Text
- data WebNavigationActionSetOriginalUriMethodInfo
- webNavigationActionSetOriginalUri :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> Text -> m ()
- data WebNavigationActionSetReasonMethodInfo
- webNavigationActionSetReason :: (HasCallStack, MonadIO m, IsWebNavigationAction a) => a -> WebNavigationReason -> m ()
- data WebNavigationActionButtonPropertyInfo
- constructWebNavigationActionButton :: IsWebNavigationAction o => Int32 -> IO (GValueConstruct o)
- getWebNavigationActionButton :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32
- webNavigationActionButton :: AttrLabelProxy "button"
- data WebNavigationActionModifierStatePropertyInfo
- constructWebNavigationActionModifierState :: IsWebNavigationAction o => Int32 -> IO (GValueConstruct o)
- getWebNavigationActionModifierState :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32
- webNavigationActionModifierState :: AttrLabelProxy "modifierState"
- data WebNavigationActionOriginalUriPropertyInfo
- constructWebNavigationActionOriginalUri :: IsWebNavigationAction o => Text -> IO (GValueConstruct o)
- getWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> m Text
- setWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> Text -> m ()
- webNavigationActionOriginalUri :: AttrLabelProxy "originalUri"
- data WebNavigationActionReasonPropertyInfo
- constructWebNavigationActionReason :: IsWebNavigationAction o => WebNavigationReason -> IO (GValueConstruct o)
- getWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> m WebNavigationReason
- setWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> WebNavigationReason -> m ()
- webNavigationActionReason :: AttrLabelProxy "reason"
- data WebNavigationActionTargetFramePropertyInfo
- constructWebNavigationActionTargetFrame :: IsWebNavigationAction o => Text -> IO (GValueConstruct o)
- getWebNavigationActionTargetFrame :: (MonadIO m, IsWebNavigationAction o) => o -> m Text
- webNavigationActionTargetFrame :: AttrLabelProxy "targetFrame"
Exported types
class GObject o => IsWebNavigationAction o Source #
toWebNavigationAction :: IsWebNavigationAction o => o -> IO WebNavigationAction Source #
Methods
getButton
webNavigationActionGetButton Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> m Int32 | Returns: the mouse button used to click |
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.
Since: 1.0.3
getModifierState
webNavigationActionGetModifierState Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> m Int32 | Returns: a bitmask with the state of the modifier keys |
Returns a bitmask with the the state of the modifier keys.
Since: 1.0.3
getOriginalUri
webNavigationActionGetOriginalUri Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> m Text | Returns: the originally requested URI |
Returns the URI that was originally requested. This may differ from the navigation target, for instance because of a redirect.
Since: 1.0.3
getReason
webNavigationActionGetReason Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> m WebNavigationReason | Returns: a |
Returns the reason why WebKit is requesting a navigation.
Since: 1.0.3
getTargetFrame
webNavigationActionGetTargetFrame Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> m Text | Returns: the target frame of the action or NULL if there is no target. |
Returns the target frame of the action.
Since: 1.1.13
setOriginalUri
webNavigationActionSetOriginalUri Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the URI that was originally requested. This may differ from the navigation target, for instance because of a redirect.
Since: 1.0.3
setReason
webNavigationActionSetReason Source #
:: (HasCallStack, MonadIO m, IsWebNavigationAction a) | |
=> a |
|
-> WebNavigationReason |
|
-> m () |
Sets the reason why WebKit is requesting a navigation.
Since: 1.0.3
Properties
button
constructWebNavigationActionButton :: IsWebNavigationAction o => Int32 -> IO (GValueConstruct o) Source #
getWebNavigationActionButton :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32 Source #
webNavigationActionButton :: AttrLabelProxy "button" Source #
modifierState
constructWebNavigationActionModifierState :: IsWebNavigationAction o => Int32 -> IO (GValueConstruct o) Source #
getWebNavigationActionModifierState :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32 Source #
webNavigationActionModifierState :: AttrLabelProxy "modifierState" Source #
originalUri
constructWebNavigationActionOriginalUri :: IsWebNavigationAction o => Text -> IO (GValueConstruct o) Source #
getWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> m Text Source #
setWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> Text -> m () Source #
webNavigationActionOriginalUri :: AttrLabelProxy "originalUri" Source #
reason
constructWebNavigationActionReason :: IsWebNavigationAction o => WebNavigationReason -> IO (GValueConstruct o) Source #
getWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> m WebNavigationReason Source #
setWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> WebNavigationReason -> m () Source #
webNavigationActionReason :: AttrLabelProxy "reason" Source #
targetFrame
constructWebNavigationActionTargetFrame :: IsWebNavigationAction o => Text -> IO (GValueConstruct o) Source #
getWebNavigationActionTargetFrame :: (MonadIO m, IsWebNavigationAction o) => o -> m Text Source #
webNavigationActionTargetFrame :: AttrLabelProxy "targetFrame" Source #