GI.WebKit.Objects.WebNavigationAction

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.

Exported types

newtype WebNavigationAction

Constructors

WebNavigationAction (ManagedPtr WebNavigationAction)

Instances

GObject WebNavigationAction

Methods

gobjectType :: WebNavigationAction -> IO GType

IsObject WebNavigationAction

IsWebNavigationAction WebNavigationAction

class GObject o => IsWebNavigationAction o

Instances

(GObject a, UnknownAncestorError Constraint WebNavigationAction a) => IsWebNavigationAction a

IsWebNavigationAction WebNavigationAction

toWebNavigationAction :: (MonadIO m, IsWebNavigationAction o) => o -> m WebNavigationAction

noWebNavigationAction :: Maybe WebNavigationAction

Methods

getButton

webNavigationActionGetButton

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> m WebNavigationReason

Returns: a WebNavigationReason

Returns the reason why WebKit is requesting a navigation.

Since: 1.0.3

getTargetFrame

webNavigationActionGetTargetFrame

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> Text

originalUri: a URI

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsWebNavigationAction a)

=> a

navigationAction: a WebNavigationAction

-> WebNavigationReason

reason: 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)

getWebNavigationActionButton :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32

modifierState

constructWebNavigationActionModifierState :: IsWebNavigationAction o => Int32 -> IO (GValueConstruct o)

getWebNavigationActionModifierState :: (MonadIO m, IsWebNavigationAction o) => o -> m Int32

originalUri

constructWebNavigationActionOriginalUri :: IsWebNavigationAction o => Text -> IO (GValueConstruct o)

getWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> m Text

setWebNavigationActionOriginalUri :: (MonadIO m, IsWebNavigationAction o) => o -> Text -> m ()

reason

constructWebNavigationActionReason :: IsWebNavigationAction o => WebNavigationReason -> IO (GValueConstruct o)

getWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> m WebNavigationReason

setWebNavigationActionReason :: (MonadIO m, IsWebNavigationAction o) => o -> WebNavigationReason -> m ()

targetFrame

constructWebNavigationActionTargetFrame :: IsWebNavigationAction o => Text -> IO (GValueConstruct o)

getWebNavigationActionTargetFrame :: (MonadIO m, IsWebNavigationAction o) => o -> m Text