WebKitHitTestResult: WebKitGTK Reference Manual

WebKitHitTestResult

WebKitHitTestResult — Result of a Hit Test

Functions

guint	webkit_hit_test_result_get_context ()
gboolean	webkit_hit_test_result_context_is_link ()
gboolean	webkit_hit_test_result_context_is_image ()
gboolean	webkit_hit_test_result_context_is_media ()
gboolean	webkit_hit_test_result_context_is_editable ()
gboolean	webkit_hit_test_result_context_is_selection ()
gboolean	webkit_hit_test_result_context_is_scrollbar ()
const gchar *	webkit_hit_test_result_get_link_uri ()
const gchar *	webkit_hit_test_result_get_link_title ()
const gchar *	webkit_hit_test_result_get_link_label ()
const gchar *	webkit_hit_test_result_get_image_uri ()
const gchar *	webkit_hit_test_result_get_media_uri ()

Properties

guint	context	Read / Write / Construct Only
char *	image-uri	Read / Write / Construct Only
char *	link-label	Read / Write / Construct Only
char *	link-title	Read / Write / Construct Only
char *	link-uri	Read / Write / Construct Only
char *	media-uri	Read / Write / Construct Only

Types and Values

struct	WebKitHitTestResult
enum	WebKitHitTestResultContext

Object Hierarchy

    GObject
    ╰── WebKitHitTestResult
        ╰── WebKitWebHitTestResult

Description

A Hit Test is an operation to get context information about a given point in a WebKitWebView. WebKitHitTestResult 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 webkit_hit_test_result_get_context() that returns a bitmask of WebKitHitTestResultContext flags. You can also use webkit_hit_test_result_context_is_link(), webkit_hit_test_result_context_is_image() and webkit_hit_test_result_context_is_media() 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 WebKitHitTestResultContext 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 “mouse-target-changed” signal is emitted with a WebKitHitTestResult.

Functions

webkit_hit_test_result_get_context ()

guint
webkit_hit_test_result_get_context (WebKitHitTestResult *hit_test_result);

Gets the value of the “context” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

a bitmask of WebKitHitTestResultContext flags

webkit_hit_test_result_context_is_link ()

gboolean
webkit_hit_test_result_context_is_link
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's a link element in the coordinates of the Hit Test, or FALSE otherwise

webkit_hit_test_result_context_is_image ()

gboolean
webkit_hit_test_result_context_is_image
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's an image element in the coordinates of the Hit Test, or FALSE otherwise

webkit_hit_test_result_context_is_media ()

gboolean
webkit_hit_test_result_context_is_media
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's a media element in the coordinates of the Hit Test, or FALSE otherwise

webkit_hit_test_result_context_is_editable ()

gboolean
webkit_hit_test_result_context_is_editable
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's an editable element at the coordinates of the hit_test_result , or FALSE otherwise

webkit_hit_test_result_context_is_selection ()

gboolean
webkit_hit_test_result_context_is_selection
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's a selected element at the coordinates of the hit_test_result , or FALSE otherwise

Since: 2.8

webkit_hit_test_result_context_is_scrollbar ()

gboolean
webkit_hit_test_result_context_is_scrollbar
                               (WebKitHitTestResult *hit_test_result);

Gets whether WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in “context”.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

TRUE if there's a scrollbar element at the coordinates of the hit_test_result , or FALSE otherwise

webkit_hit_test_result_get_link_uri ()

const gchar *
webkit_hit_test_result_get_link_uri (WebKitHitTestResult *hit_test_result);

Gets the value of the “link-uri” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

the URI of the link element in the coordinates of the Hit Test, or NULL if there isn't a link element in hit_test_result context

webkit_hit_test_result_get_link_title ()

const gchar *
webkit_hit_test_result_get_link_title (WebKitHitTestResult *hit_test_result);

Gets the value of the “link-title” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

the title of the link element in the coordinates of the Hit Test, or NULL if there isn't a link element in hit_test_result context or the link element doesn't have a title

webkit_hit_test_result_get_link_label ()

const gchar *
webkit_hit_test_result_get_link_label (WebKitHitTestResult *hit_test_result);

Gets the value of the “link-label” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

the label of the link element in the coordinates of the Hit Test, or NULL if there isn't a link element in hit_test_result context or the link element doesn't have a label

webkit_hit_test_result_get_image_uri ()

const gchar *
webkit_hit_test_result_get_image_uri (WebKitHitTestResult *hit_test_result);

Gets the value of the “image-uri” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

the URI of the image element in the coordinates of the Hit Test, or NULL if there isn't an image element in hit_test_result context

webkit_hit_test_result_get_media_uri ()

const gchar *
webkit_hit_test_result_get_media_uri (WebKitHitTestResult *hit_test_result);

Gets the value of the “media-uri” property.

Parameters

hit_test_result

a WebKitHitTestResult

Returns

the URI of the media element in the coordinates of the Hit Test, or NULL if there isn't a media element in hit_test_result context

Types and Values

struct WebKitHitTestResult

struct WebKitHitTestResult;

enum WebKitHitTestResultContext

Enum values with flags representing the context of a WebKitHitTestResult.

Members

WEBKIT_HIT_TEST_RESULT_CONTEXT_DOCUMENT	anywhere in the document.
WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK	a hyperlink element.
WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE	an image element.
WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA	a video or audio element.
WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE	an editable element
WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR	a scrollbar element.
WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION	a selected element. Since 2.8

Property Details