Next: , Previous: AtkHyperlink, Up: Top

9 AtkHypertext

The ATK interface which provides standard mechanism for manipulating hyperlinks.

9.1 Overview

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.

9.2 Usage

— Class: <atk-hypertext>

Derives from <ginterface>.

This class defines no direct slots.

— Signal on <atk-hypertext>: link-selected (arg0 <gint>)

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

— Function: atk-hypertext-get-link (self <atk-hypertext>) (link_index int) ⇒  (ret <atk-hyperlink>)
— Method: get-link

Gets the link in this hypertext document at index link-index

hypertext
an <atk-hypertext>
link-index
an integer specifying the desired link
ret
the link in this hypertext document at index link-index
— Function: atk-hypertext-get-n-links (self <atk-hypertext>) ⇒  (ret int)
— Method: get-n-links

Gets the number of links within this hypertext document.

hypertext
an <atk-hypertext>
ret
the number of links within this hypertext document
— Function: atk-hypertext-get-link-index (self <atk-hypertext>) (char_index int) ⇒  (ret int)
— Method: get-link-index

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

hypertext
an <atk-hypertext>
char-index
a character index
ret
an index into the array of hyperlinks in hypertext, or -1 if there is no hyperlink associated with this character.