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