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.WebKitWebProcessExtension.Objects.WebHitTestResult

Contents

Exported types
Methods

Description

Result of a Hit Test (Web Process Extensions).

WebKitWebHitTestResult extends HitTestResult to provide information about the WebKitDOMNode in the coordinates of the Hit Test.

Since: 2.8

Synopsis

newtype WebHitTestResult = WebHitTestResult (ManagedPtr WebHitTestResult)
class (GObject o, IsDescendantOf WebHitTestResult o) => IsWebHitTestResult o
toWebHitTestResult :: (MonadIO m, IsWebHitTestResult o) => o -> m WebHitTestResult
webHitTestResultContextIsEditable :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultContextIsImage :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultContextIsLink :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultContextIsMedia :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultContextIsScrollbar :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultContextIsSelection :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Bool
webHitTestResultGetContext :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Word32
webHitTestResultGetImageUri :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Text
webHitTestResultGetJsNode :: (HasCallStack, MonadIO m, IsWebHitTestResult a, IsScriptWorld b) => a -> Maybe b -> m (Maybe Value)
webHitTestResultGetLinkLabel :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Text
webHitTestResultGetLinkTitle :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Text
webHitTestResultGetLinkUri :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Text
webHitTestResultGetMediaUri :: (HasCallStack, MonadIO m, IsWebHitTestResult a) => a -> m Text

Exported types

newtype WebHitTestResult Source #

Memory-managed wrapper type.

Constructors

WebHitTestResult (ManagedPtr WebHitTestResult)

Instances

Instances details

Eq WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult Methods (==) :: WebHitTestResult -> WebHitTestResult -> Bool # (/=) :: WebHitTestResult -> WebHitTestResult -> Bool #
GObject WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult
ManagedPtrNewtype WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult Methods toManagedPtr :: WebHitTestResult -> ManagedPtr WebHitTestResult
TypedObject WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult Methods glibType :: IO GType
HasParentTypes WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult
IsGValue (Maybe WebHitTestResult) Source #	Convert `WebHitTestResult` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe WebHitTestResult -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe WebHitTestResult)
type ParentTypes WebHitTestResult Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult type ParentTypes WebHitTestResult = '[Object]

class (GObject o, IsDescendantOf WebHitTestResult o) => IsWebHitTestResult o Source #

Type class for types which can be safely cast to WebHitTestResult, for instance with toWebHitTestResult.

Instances

Instances details

(GObject o, IsDescendantOf WebHitTestResult o) => IsWebHitTestResult o Source #
Instance details Defined in GI.WebKitWebProcessExtension.Objects.WebHitTestResult

toWebHitTestResult :: (MonadIO m, IsWebHitTestResult o) => o -> m WebHitTestResult Source #

Cast to WebHitTestResult, 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

Expand

contextIsEditable

webHitTestResultContextIsEditable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers an editable element or `False` otherwise.

Check whether there is an editable element at the hit test position.

Checks whether HitTestResultContextEditable flag is present in the context flags.

contextIsImage

webHitTestResultContextIsImage Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers an image element or `False` otherwise.

Check whether there is an image element at the hit test position.

Checks whether HitTestResultContextImage flag is present in the context flags.

contextIsLink

webHitTestResultContextIsLink Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers a link element or `False` otherwise.

Check whether there is a link element at the hit test position.

Checks whether HitTestResultContextLink flag is present in the context flags.

contextIsMedia

webHitTestResultContextIsMedia Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers a media element or `False` otherwise.

Check whether there is a media element at the hit test position.

Checks whether HitTestResultContextMedia flag is present in the context flags.

contextIsScrollbar

webHitTestResultContextIsScrollbar Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers a scrollbar or `False` otherwise.

Check whether there is a scrollbar at the hit test position.

Checks whether HitTestResultContextScrollbar flag is present in the context flags.

contextIsSelection

webHitTestResultContextIsSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Bool	Returns: `True` if the hit test covers a selected element or `False` otherwise.

Check whether there is a selected element at the hit test position.

Checks whether HitTestResultContextSelection flag is present in the context flags.

getContext

webHitTestResultGetContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebHitTestResult`
-> m Word32	Returns: a bitmask of `HitTestResultContext` flags

Gets the the context flags for the hit test result.

getImageUri

webHitTestResultGetImageUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Text	Returns: the URI of the image element, or `Nothing` if the hit test does not cover an image element.

Obtains the URI associated with the image element at the hit test position.

getJsNode

webHitTestResultGetJsNode Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a, IsScriptWorld b)
=> a	`webHitTestResult`: a `WebHitTestResult`
-> Maybe b	`world`: a `ScriptWorld`, or `Nothing` to use the default
-> m (Maybe Value)	Returns: a `Value` for the DOM node, or `Nothing`

Get the Value for the DOM node in world at the coordinates of the Hit Test.

Since: 2.40

getLinkLabel

webHitTestResultGetLinkLabel Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Text	Returns: the label of the link element, or `Nothing` if the hit test does not cover a link element or the link element does not have a label.

Obtains the label associated with the link element at the hit test position.

getLinkTitle

webHitTestResultGetLinkTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Text	Returns: the title of the link element, or `Nothing` if the hit test does not cover a link element or the link element does not have a title.

Obtains the title associated with the link element at the hit test position.

getLinkUri

webHitTestResultGetLinkUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Text	Returns: the URI of the link element, or `Nothing` if the hit test does not cover a link element.

Obtains the URI associated with the link element at the hit test position.

getMediaUri

webHitTestResultGetMediaUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsWebHitTestResult a)
=> a	`webHitTestResult`: a `WebWebKitHitTestResult`
-> m Text	Returns: the URI of the media element, or `Nothing` if the hit test does not cover a media element.

Obtains the URI associated with the media element at the hit test position.

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

contextIsEditable

contextIsImage

contextIsLink

contextIsMedia

contextIsScrollbar

contextIsSelection

getContext

getImageUri

getJsNode

getLinkLabel

getLinkTitle

getLinkUri

getMediaUri