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 |
A policy decision for navigation actions.
WebKitNavigationPolicyDecision represents a policy decision for events associated with navigations. If the value of NavigationPolicyDecision:mouseButton is not 0, then the navigation was triggered by a mouse event.
Synopsis
- newtype NavigationPolicyDecision = NavigationPolicyDecision (ManagedPtr NavigationPolicyDecision)
- class (GObject o, IsDescendantOf NavigationPolicyDecision o) => IsNavigationPolicyDecision o
- toNavigationPolicyDecision :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationPolicyDecision
- navigationPolicyDecisionGetFrameName :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m (Maybe Text)
- navigationPolicyDecisionGetModifiers :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m Word32
- navigationPolicyDecisionGetMouseButton :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m Word32
- navigationPolicyDecisionGetNavigationAction :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m NavigationAction
- navigationPolicyDecisionGetNavigationType :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m NavigationType
- navigationPolicyDecisionGetRequest :: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) => a -> m URIRequest
- getNavigationPolicyDecisionFrameName :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m (Maybe Text)
- getNavigationPolicyDecisionModifiers :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m Word32
- getNavigationPolicyDecisionMouseButton :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m Word32
- getNavigationPolicyDecisionNavigationAction :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationAction
- getNavigationPolicyDecisionNavigationType :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationType
- getNavigationPolicyDecisionRequest :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m URIRequest
Exported types
newtype NavigationPolicyDecision Source #
Memory-managed wrapper type.
NavigationPolicyDecision (ManagedPtr NavigationPolicyDecision) |
Instances
class (GObject o, IsDescendantOf NavigationPolicyDecision o) => IsNavigationPolicyDecision o Source #
Type class for types which can be safely cast to NavigationPolicyDecision
, for instance with toNavigationPolicyDecision
.
Instances
toNavigationPolicyDecision :: (MonadIO m, IsNavigationPolicyDecision o) => o -> m NavigationPolicyDecision Source #
Cast to NavigationPolicyDecision
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, download, forceFloating, freezeNotify, getv, ignore, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, use, useWithPolicies, watchClosure.
Getters
getData, getFrameName, getModifiers, getMouseButton, getNavigationAction, getNavigationType, getProperty, getQdata, getRequest.
Setters
getFrameName
navigationPolicyDecisionGetFrameName Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> m (Maybe Text) | Returns: The name of the new frame this navigation action targets or |
Deprecated: (Since version 2.40)Use navigationPolicyDecisionGetNavigationAction
instead.
Gets the value of the NavigationPolicyDecision:frameName property.
getModifiers
navigationPolicyDecisionGetModifiers Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> 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:mouseButton property.
getNavigationAction
navigationPolicyDecisionGetNavigationAction Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> m NavigationAction | Returns: The |
Gets the value of the NavigationPolicyDecision:navigationAction property.
Since: 2.6
getNavigationType
navigationPolicyDecisionGetNavigationType Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> 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:navigationType property.
getRequest
navigationPolicyDecisionGetRequest Source #
:: (HasCallStack, MonadIO m, IsNavigationPolicyDecision a) | |
=> a |
|
-> 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) Source #
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 Source #
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 Source #
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 Source #
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 Source #
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 Source #
Get the value of the “request
” property.
When overloading is enabled, this is equivalent to
get
navigationPolicyDecision #request