Module: Atk::Hypertext

Defined in:
(unknown)

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.

Instance Method Summary collapse

Instance Method Details

index link_index

Parameters:

  • hypertext (Atk::Hypertext) —

    an Atk::Hypertext

  • link_index (Integer) —

    an integer specifying the desired link

Returns:

#get_link_index(hypertext, char_index) ⇒ Integer

or -1 if there is no hyperlink associated with this character.

Parameters:

  • hypertext (Atk::Hypertext) —

    an Atk::Hypertext

  • char_index (Integer) —

    a character index

Returns:

  • (Integer) —

    an index into the array of hyperlinks in hypertext,

#get_n_links(hypertext) ⇒ Integer

Returns the number of links within this hypertext document.

Parameters:

Returns:

  • (Integer) —

    the number of links within this hypertext document

#link_selected(hypertext, link_index) ⇒ nil

Parameters:

Returns:

  • (nil)

#n_links ⇒ Integer

Gets the number of links within this hypertext document.

Returns:

  • (Integer) —

    the number of links within this hypertext document