docs/tmpl/atkhyperlink.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkHyperlink
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An ATK object which encapsulates a link or set of links in a hypertext document.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An ATK object which encapsulates a link or set of links
  10 (for instance in the case of client-side image maps) in a hypertext document.
  11 It may implement the AtkAction interface.  AtkHyperlink may also be used
  12 to refer to inline embedded content, since it allows specification of a start
  13 and end offset within the host AtkHypertext object.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### SECTION Stability_Level ##### -->
  22
  23
  24 <!-- ##### STRUCT AtkHyperlink ##### -->
  25 <para>
  26 The AtkHyperlink structure should not be accessed directly.
  27
  28 </para>
  29
  30
  31 <!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
  32 <para>
  33 The signal link-activated is emitted when a link is activated.
  34 </para>
  35
  36 @atkhyperlink: the object which received the signal.
  37
  38 <!-- ##### ARG AtkHyperlink:end-index ##### -->
  39 <para>
  40
  41 </para>
  42
  43 <!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
  44 <para>
  45
  46 </para>
  47
  48 <!-- ##### ARG AtkHyperlink:selected-link ##### -->
  49 <para>
  50
  51 </para>
  52
  53 <!-- ##### ARG AtkHyperlink:start-index ##### -->
  54 <para>
  55
  56 </para>
  57
  58 <!-- ##### ENUM AtkHyperlinkStateFlags ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @ATK_HYPERLINK_IS_INLINE:
  64
  65 <!-- ##### FUNCTION atk_hyperlink_get_uri ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @link_:
  71 @i:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION atk_hyperlink_get_object ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @link_:
  81 @i:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION atk_hyperlink_get_end_index ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @link_:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION atk_hyperlink_get_start_index ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @link_:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION atk_hyperlink_is_valid ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @link_:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION atk_hyperlink_is_inline ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @link_:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION atk_hyperlink_get_n_anchors ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @link_:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION atk_hyperlink_is_selected_link ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @link_:
 136 @Returns:
 137
 138