Atk.Hypertext¶

Implementations:: Atk.NoOpObject

Methods¶

	`get_link` (link_index)
	`get_link_index` (char_index)
	`get_n_links` ()

Virtual Methods¶

	`do_get_link` (link_index)
	`do_get_link_index` (char_index)
	`do_get_n_links` ()
	`do_link_selected` (link_index)

Properties¶

None

Signals¶

Name	Short Description
`link-selected`	The “link-selected” signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.

Fields¶

None

Class Details¶

class Atk.Hypertext¶

Bases:: GObject.GInterface
Structure:: Atk.HypertextIface

The ATK interface which provides standard mechanism for manipulating hyperlinks.

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 included content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.

get_link(link_index)[source]¶

Parameters:: link_index (int) – an integer specifying the desired link
Returns:: the link in this hypertext document at index link_index
Return type:: Atk.Hyperlink

Gets the link in this hypertext document at index link_index

get_link_index(char_index)[source]¶

Parameters:: char_index (int) – a character index
Returns:: an index into the array of hyperlinks in self, or -1 if there is no hyperlink associated with this character.
Return type:: int

Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

get_n_links()[source]¶

Returns:: the number of links within this hypertext document
Return type:: int

Gets the number of links within this hypertext document.

do_get_link(link_index) virtual¶

Parameters:: link_index (int) – an integer specifying the desired link
Returns:: the link in this hypertext document at index link_index
Return type:: Atk.Hyperlink

Gets the link in this hypertext document at index link_index

do_get_link_index(char_index) virtual¶

Parameters:: char_index (int) – a character index
Returns:: an index into the array of hyperlinks in hypertext, or -1 if there is no hyperlink associated with this character.
Return type:: int

Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

do_get_n_links() virtual¶

Returns:: the number of links within this hypertext document
Return type:: int

Gets the number of links within this hypertext document.

do_link_selected(link_index) virtual¶

Parameters:: link_index (int) –

Signal Details¶

Atk.Hypertext.signals.link_selected(hypertext, arg1)¶

Signal Name:

link-selected

Flags:

RUN_LAST

Parameters:

hypertext (Atk.Hypertext) – The object which received the signal
arg1 (int) – the index of the hyperlink which is selected

The “link-selected” signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.