GI.WebKit2WebExtension.Objects.HitTestResult

Result of a Hit Test.

A Hit Test is an operation to get context information about a given point in a WebKitWebView. HitTestResult represents the result of a Hit Test. It provides context information about what is at the coordinates of the Hit Test, such as if there's a link, an image or a media.

You can get the context of the HitTestResult with hitTestResultGetContext that returns a bitmask of HitTestResultContext flags. You can also use hitTestResultContextIsLink, hitTestResultContextIsImage and hitTestResultContextIsMedia to determine whether there's a link, image or a media element at the coordinates of the Hit Test. Note that it's possible that several HitTestResultContext flags are active at the same time, for example if there's a link containing an image.

When the mouse is moved over a WebKitWebView a Hit Test is performed for the mouse coordinates and WebKitWebView::mouse-target-changed signal is emitted with a HitTestResult.

Exported types

newtype HitTestResult

Memory-managed wrapper type.

Constructors

HitTestResult (ManagedPtr HitTestResult)

Instances

Eq HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

Methods

(==) :: HitTestResult -> HitTestResult -> Bool

(/=) :: HitTestResult -> HitTestResult -> Bool

GObject HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

ManagedPtrNewtype HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

Methods

toManagedPtr :: HitTestResult -> ManagedPtr HitTestResult

TypedObject HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

Methods

glibType :: IO GType

HasParentTypes HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

IsGValue (Maybe HitTestResult)

Convert HitTestResult to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe HitTestResult -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe HitTestResult)

type ParentTypes HitTestResult

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

type ParentTypes HitTestResult = '[Object]

class (GObject o, IsDescendantOf HitTestResult o) => IsHitTestResult o

Type class for types which can be safely cast to HitTestResult, for instance with toHitTestResult.

Instances

(GObject o, IsDescendantOf HitTestResult o) => IsHitTestResult o

Defined in GI.WebKit2WebExtension.Objects.HitTestResult

toHitTestResult :: (MonadIO m, IsHitTestResult o) => o -> m HitTestResult

Cast to HitTestResult, 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, contextIsEditable, contextIsImage, contextIsLink, contextIsMedia, contextIsScrollbar, contextIsSelection, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getContext, getData, getImageUri, getLinkLabel, getLinkTitle, getLinkUri, getMediaUri, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

contextIsEditable

hitTestResultContextIsEditable

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's an editable element at the coordinates of the hitTestResult, or False otherwise

Gets whether HitTestResultContextEditable flag is present in HitTestResult:context.

contextIsImage

hitTestResultContextIsImage

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's an image element in the coordinates of the Hit Test, or False otherwise

Gets whether HitTestResultContextImage flag is present in HitTestResult:context.

contextIsLink

hitTestResultContextIsLink

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's a link element in the coordinates of the Hit Test, or False otherwise

Gets whether HitTestResultContextLink flag is present in HitTestResult:context.

contextIsMedia

hitTestResultContextIsMedia

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's a media element in the coordinates of the Hit Test, or False otherwise

Gets whether HitTestResultContextMedia flag is present in HitTestResult:context.

contextIsScrollbar

hitTestResultContextIsScrollbar

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's a scrollbar element at the coordinates of the hitTestResult, or False otherwise

Gets whether HitTestResultContextScrollbar flag is present in HitTestResult:context.

contextIsSelection

hitTestResultContextIsSelection

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Bool

Returns: True if there's a selected element at the coordinates of the hitTestResult, or False otherwise

Gets whether HitTestResultContextSelection flag is present in HitTestResult:context.

Since: 2.8

getContext

hitTestResultGetContext

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Word32

Returns: a bitmask of HitTestResultContext flags

Gets the value of the HitTestResult:context property.

getImageUri

hitTestResultGetImageUri

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Text

Returns: the URI of the image element in the coordinates of the Hit Test, or Nothing if there isn't an image element in hitTestResult context

Gets the value of the HitTestResult:imageUri property.

getLinkLabel

hitTestResultGetLinkLabel

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Text

Returns: the label of the link element in the coordinates of the Hit Test, or Nothing if there isn't a link element in hitTestResult context or the link element doesn't have a label

Gets the value of the HitTestResult:linkLabel property.

getLinkTitle

hitTestResultGetLinkTitle

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Text

Returns: the title of the link element in the coordinates of the Hit Test, or Nothing if there isn't a link element in hitTestResult context or the link element doesn't have a title

Gets the value of the HitTestResult:linkTitle property.

getLinkUri

hitTestResultGetLinkUri

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Text

Returns: the URI of the link element in the coordinates of the Hit Test, or Nothing if there isn't a link element in hitTestResult context

Gets the value of the HitTestResult:linkUri property.

getMediaUri

hitTestResultGetMediaUri

Arguments

:: (HasCallStack, MonadIO m, IsHitTestResult a)

=> a

hitTestResult: a HitTestResult

-> m Text

Returns: the URI of the media element in the coordinates of the Hit Test, or Nothing if there isn't a media element in hitTestResult context

Gets the value of the HitTestResult:mediaUri property.

Properties

context

Bitmask of HitTestResultContext flags representing the context of the HitTestResult.

constructHitTestResultContext :: (IsHitTestResult o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “context” property. This is rarely needed directly, but it is used by new.

getHitTestResultContext :: (MonadIO m, IsHitTestResult o) => o -> m Word32

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

get hitTestResult #context

imageUri

The URI of the image if flag HitTestResultContextImage is present in HitTestResult:context

constructHitTestResultImageUri :: (IsHitTestResult o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “image-uri” property. This is rarely needed directly, but it is used by new.

getHitTestResultImageUri :: (MonadIO m, IsHitTestResult o) => o -> m Text

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

get hitTestResult #imageUri

linkLabel

The label of the link if flag HitTestResultContextLink is present in HitTestResult:context

constructHitTestResultLinkLabel :: (IsHitTestResult o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “link-label” property. This is rarely needed directly, but it is used by new.

getHitTestResultLinkLabel :: (MonadIO m, IsHitTestResult o) => o -> m Text

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

get hitTestResult #linkLabel

linkTitle

The title of the link if flag HitTestResultContextLink is present in HitTestResult:context

constructHitTestResultLinkTitle :: (IsHitTestResult o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “link-title” property. This is rarely needed directly, but it is used by new.

getHitTestResultLinkTitle :: (MonadIO m, IsHitTestResult o) => o -> m Text

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

get hitTestResult #linkTitle

linkUri

The URI of the link if flag HitTestResultContextLink is present in HitTestResult:context

constructHitTestResultLinkUri :: (IsHitTestResult o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “link-uri” property. This is rarely needed directly, but it is used by new.

getHitTestResultLinkUri :: (MonadIO m, IsHitTestResult o) => o -> m Text

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

get hitTestResult #linkUri

mediaUri

The URI of the media if flag HitTestResultContextMedia is present in HitTestResult:context

constructHitTestResultMediaUri :: (IsHitTestResult o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “media-uri” property. This is rarely needed directly, but it is used by new.

getHitTestResultMediaUri :: (MonadIO m, IsHitTestResult o) => o -> m Text

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

get hitTestResult #mediaUri