Interface

AtkHypertext

Description [src]

interface Atk.Hypertext : GObject.Object

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.

Prerequisite

In order to implement Hypertext, your type must inherit from GObject.

Instance methods

atk_hypertext_get_link

Gets the link in this hypertext document at index link_index.

atk_hypertext_get_link_index

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

atk_hypertext_get_n_links

Gets the number of links within this hypertext document.

Signals

Atk.Hypertext::link-selected

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

Interface structure

struct AtkHypertextIface {
  GTypeInterface parent;
  AtkHyperlink* (* get_link) (
    AtkHypertext* hypertext,
    gint link_index
  );
  gint (* get_n_links) (
    AtkHypertext* hypertext
  );
  gint (* get_link_index) (
    AtkHypertext* hypertext,
    gint char_index
  );
  void (* link_selected) (
    AtkHypertext* hypertext,
    gint link_index
  );
  
}
Interface members
parent
GTypeInterface
 No description available.
get_link
AtkHyperlink* (* get_link) (
    AtkHypertext* hypertext,
    gint link_index
  )
 No description available.
get_n_links
gint (* get_n_links) (
    AtkHypertext* hypertext
  )
 No description available.
get_link_index
gint (* get_link_index) (
    AtkHypertext* hypertext,
    gint char_index
  )
 No description available.
link_selected
void (* link_selected) (
    AtkHypertext* hypertext,
    gint link_index
  )
 No description available.

Virtual methods

Gets the link in this hypertext document at index link_index.

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

Gets the number of links within this hypertext document.

No description available.