Atspi.Hyperlink

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	get_end_index ()
	get_index_range ()
	get_n_anchors ()
	get_object (i)
	get_start_index ()
	get_uri (i)
	is_valid ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	Atspi.Object	r

Class Details

class Atspi.Hyperlink(**kwargs)

Bases:

Atspi.Object

Abstract:

No

Structure:

Atspi.HyperlinkClass

Instances of atspi-hyperlink are the means by which end users and clients interact with linked content.

Instances of atspi-hyperlink are returned by atspi-hypertext objects, and are the means by which end users and clients interact with linked, and in some cases embedded, content. These instances may have multiple “anchors”, where an anchor corresponds to a reference to a particular resource with a corresponding resource identified (URI).

get_end_index()

Raises:

GLib.Error

Return type:

int

Gets the ending character offset of the text range associated with an Atspi.Hyperlink, in its originating Atspi.Hypertext.

get_index_range()

Raises:

GLib.Error

Return type:

Atspi.Range

Gets the starting and ending character offsets of the text range associated with an Atspi.Hyperlink, in its originating Atspi.Hypertext.

get_n_anchors()

Raises:

GLib.Error

Returns:

a int indicating the number of anchors in this hyperlink.

Return type:

int

Gets the total number of anchors which an Atspi.Hyperlink implementor has. Though typical hyperlinks have only one anchor, client-side image maps and other hypertext objects may potentially activate or refer to multiple URIs. For each anchor there is a corresponding URI and object.

see: Atspi.Hyperlink.get_uri and Atspi.Hyperlink.get_object.

get_object(i)

Parameters:

i (int) – a (zero-index) int indicating which hyperlink anchor to query.

Raises:

GLib.Error

Returns:

an Atspi.Accessible that represents the object associated with the ith anchor of the specified Atspi.Hyperlink.

Return type:

Atspi.Accessible

Gets the object associated with a particular hyperlink anchor, as an Atspi.Accessible.

get_start_index()

Raises:

GLib.Error

Return type:

int

Gets the starting character offset of the text range associated with an Atspi.Hyperlink, in its originating Atspi.Hypertext.

get_uri(i)

Parameters:

i (int) – a (zero-index) integer indicating which hyperlink anchor to query.

Raises:

GLib.Error

Returns:

a UTF-8 string giving the URI of the ith hyperlink anchor.

Return type:

str

Gets the URI associated with a particular hyperlink anchor.

is_valid()

Raises:

GLib.Error

Returns:

True if the specified Atspi.Hyperlink is still valid with respect to its originating Atspi.Hypertext object, False otherwise.

Return type:

bool

Tells whether an Atspi.Hyperlink object is still valid with respect to its originating hypertext object.