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 in a hypertext document.
  10 It implements the AtkAction interface.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### SECTION Stability_Level ##### -->
  19
  20
  21 <!-- ##### STRUCT AtkHyperlink ##### -->
  22 <para>
  23 The AtkHyperlink structure should not be accessed directly.
  24
  25 </para>
  26
  27
  28 <!-- ##### SIGNAL AtkHyperlink::link-activated ##### -->
  29 <para>
  30 The signal link-activated is emitted when a link is activated.
  31 </para>
  32
  33 @atkhyperlink: the object which received the signal.
  34
  35 <!-- ##### ARG AtkHyperlink:end-index ##### -->
  36 <para>
  37
  38 </para>
  39
  40 <!-- ##### ARG AtkHyperlink:number-of-anchors ##### -->
  41 <para>
  42
  43 </para>
  44
  45 <!-- ##### ARG AtkHyperlink:selected-link ##### -->
  46 <para>
  47
  48 </para>
  49
  50 <!-- ##### ARG AtkHyperlink:start-index ##### -->
  51 <para>
  52
  53 </para>
  54
  55 <!-- ##### ENUM AtkHyperlinkStateFlags ##### -->
  56 <para>
  57
  58 </para>
  59
  60 @ATK_HYPERLINK_IS_INLINE:
  61
  62 <!-- ##### FUNCTION atk_hyperlink_get_uri ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @link_:
  68 @i:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_hyperlink_get_object ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @link_:
  78 @i:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION atk_hyperlink_get_end_index ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @link_:
  88 @Returns:
  89
  90
  91 <!-- ##### FUNCTION atk_hyperlink_get_start_index ##### -->
  92 <para>
  93
  94 </para>
  95
  96 @link_:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION atk_hyperlink_is_valid ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @link_:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION atk_hyperlink_is_inline ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @link_:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION atk_hyperlink_get_n_anchors ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @link_:
 124 @Returns:
 125
 126
 127 <!-- ##### FUNCTION atk_hyperlink_is_selected_link ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @link_:
 133 @Returns:
 134
 135