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