docs/tmpl/atkhypertext.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkHypertext
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface which provides standard mechanism for manipulating hyperlinks.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An interface used for objects which implement linking between multiple
  10 resource or content locations, or multiple 'markers' within a single
  11 document.  A Hypertext instance is associated with one or more Hyperlinks,
  12 which are associated with particular offsets within the Hypertext's included
  13 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.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18 AtkHyperlink
  19 </para>
  20
  21 <!-- ##### SECTION Stability_Level ##### -->
  22
  23
  24 <!-- ##### STRUCT AtkHypertext ##### -->
  25 <para>
  26 The AtkHypertext structure does not contain any fields.
  27 </para>
  28
  29
  30 <!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
  31 <para>
  32 The "link-selected" signal is emitted by an AtkHyperText object when one of
  33 the hyperlinks associated with the object is selected.
  34 </para>
  35
  36 @atkhypertext: the object which received the signal.
  37 @arg1: the index of the hyperlink which is selected
  38
  39 <!-- ##### FUNCTION atk_hypertext_get_link ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @hypertext:
  45 @link_index:
  46 @Returns:
  47
  48
  49 <!-- ##### FUNCTION atk_hypertext_get_n_links ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @hypertext:
  55 @Returns:
  56
  57
  58 <!-- ##### FUNCTION atk_hypertext_get_link_index ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @hypertext:
  64 @char_index:
  65 @Returns:
  66
  67