Atspi.Hypertext

Implementations:

Atspi.Accessible

Methods

	get_link (link_index)
	get_link_index (character_offset)
	get_n_links ()

Virtual Methods

None

Properties

None

Signals

None

Fields

None

Class Details

class Atspi.Hypertext

Bases:

GObject.GInterface

An interface used for objects which implement linking between multiple resource locations.

An interface used for objects which implement linking between multiple resource or content locations, or multiple ‘markers’ within a single document. A hypertext instance is associated with one or more hyperlinks which are associated with particular offsets within the hypertext’s content.

get_link(link_index)

Parameters:

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

Raises:

GLib.Error

Returns:

the Atspi.Hyperlink object specified by link_index.

Return type:

Atspi.Hyperlink or None

Gets the Atspi.Hyperlink object at a specified index.

get_link_index(character_offset)

Parameters:

character_offset (int) – a int specifying the character offset to query.

Raises:

GLib.Error

Returns:

the linkIndex of the Atspi.Hyperlink active at character offset character_offset, or -1 if there is no hyperlink at the specified character offset.

Return type:

int

Gets the index of the Atspi.Hyperlink object at a specified character offset.

get_n_links()

Raises:

GLib.Error

Returns:

a int indicating the number of Atspi.Hyperlink objects of the Atspi.Hypertext implementor, or -1 if the number cannot be determined (for example, if the Atspi.Hypertext object is so large that it is not all currently in the memory cache).

Return type:

int

Gets the total number of Atspi.Hyperlink objects that an Atspi.Hypertext implementor has.