GI.WebKit2.Objects.NavigationPolicyDecision

No description available in the introspection data.

Exported types

newtype NavigationPolicyDecision

Memory-managed wrapper type.

Constructors

NavigationPolicyDecision (ManagedPtr NavigationPolicyDecision)

Instances

GObject NavigationPolicyDecision

Defined in GI.WebKit2.Objects.NavigationPolicyDecision

Methods

gobjectType :: IO GType

HasParentTypes NavigationPolicyDecision

Defined in GI.WebKit2.Objects.NavigationPolicyDecision

type ParentTypes NavigationPolicyDecision

Defined in GI.WebKit2.Objects.NavigationPolicyDecision

type ParentTypes NavigationPolicyDecision = PolicyDecision ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf NavigationPolicyDecision o) => IsNavigationPolicyDecision o

Type class for types which can be safely cast to NavigationPolicyDecision, for instance with toNavigationPolicyDecision.

Instances

(GObject o, IsDescendantOf NavigationPolicyDecision o) => IsNavigationPolicyDecision o

Defined in GI.WebKit2.Objects.NavigationPolicyDecision

toNavigationPolicyDecision :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationPolicyDecision

Cast to NavigationPolicyDecision, for types for which this is known to be safe. For general casts, use castTo.

noNavigationPolicyDecision :: Maybe NavigationPolicyDecision

A convenience alias for Nothing :: Maybe NavigationPolicyDecision.

Methods

getFrameName

navigationPolicyDecisionGetFrameName

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m (Maybe Text)

Returns: The name of the new frame this navigation action targets or Nothing

Gets the value of the NavigationPolicyDecision:frame-name property.

getModifiers

navigationPolicyDecisionGetModifiers

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m Word32

Returns: The modifiers active if this decision was triggered by a mouse event

Deprecated: (Since version 2.6)Use navigationPolicyDecisionGetNavigationAction instead.

Gets the value of the NavigationPolicyDecision:modifiers property.

getMouseButton

navigationPolicyDecisionGetMouseButton

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m Word32

Returns: The mouse button used if this decision was triggered by a mouse event or 0 otherwise

Deprecated: (Since version 2.6)Use navigationPolicyDecisionGetNavigationAction instead.

Gets the value of the NavigationPolicyDecision:mouse-button property.

getNavigationAction

navigationPolicyDecisionGetNavigationAction

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m NavigationAction

Returns: The NavigationAction triggering this policy decision.

Gets the value of the NavigationPolicyDecision:navigation-action property.

Since: 2.6

getNavigationType

navigationPolicyDecisionGetNavigationType

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m NavigationType

Returns: The type of navigation triggering this policy decision.

Deprecated: (Since version 2.6)Use navigationPolicyDecisionGetNavigationAction instead.

Gets the value of the NavigationPolicyDecision:navigation-type property.

getRequest

navigationPolicyDecisionGetRequest

Arguments

:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a)

=> a

decision: a NavigationPolicyDecision

-> m URIRequest

Returns: The URI request that is associated with this navigation

Deprecated: (Since version 2.6)Use navigationPolicyDecisionGetNavigationAction instead.

Gets the value of the NavigationPolicyDecision:request property.

Properties

frameName

If this navigation request targets a new frame, this property contains the name of that frame. For example if the decision was triggered by clicking a link with a target attribute equal to "_blank", this property will contain the value of that attribute. In all other cases, this value will be Nothing.

getNavigationPolicyDecisionFrameName :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m (Maybe Text)

Get the value of the “frame-name” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #frameName

modifiers

If the navigation associated with this policy decision was originally triggered by a mouse event, this property contains a bitmask of various ModifierType values describing the modifiers used for that click. If the navigation was not triggered by a mouse event or no modifiers were active, the value of this property will be zero.

getNavigationPolicyDecisionModifiers :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m Word32

Get the value of the “modifiers” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #modifiers

mouseButton

If the navigation associated with this policy decision was originally triggered by a mouse event, this property contains non-zero button number of the button triggering that event. The button numbers match those from GDK. If the navigation was not triggered by a mouse event, the value of this property will be 0.

getNavigationPolicyDecisionMouseButton :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m Word32

Get the value of the “mouse-button” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #mouseButton

navigationAction

The NavigationAction that triggered this policy decision.

Since: 2.6

getNavigationPolicyDecisionNavigationAction :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationAction

Get the value of the “navigation-action” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #navigationAction

navigationType

The type of navigation that triggered this policy decision. This is useful for enacting different policies depending on what type of user action caused the navigation.

getNavigationPolicyDecisionNavigationType :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationType

Get the value of the “navigation-type” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #navigationType

request

This property contains the URIRequest associated with this navigation.

getNavigationPolicyDecisionRequest :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m URIRequest

Get the value of the “request” property. When overloading is enabled, this is equivalent to

get navigationPolicyDecision #request