docs/tmpl/atktext.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkText
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 accessibility interface for text widgets
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 AtkText provides an accessibility interface for text widgets
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### STRUCT AtkText ##### -->
  18 <para>
  19
  20 </para>
  21
  22
  23 <!-- ##### STRUCT AtkTextIface ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @parent:
  29 @get_text:
  30 @get_text_after_offset:
  31 @get_text_at_offset:
  32 @get_character_at_offset:
  33 @get_text_before_offset:
  34 @get_caret_offset:
  35 @get_range_attributes:
  36 @get_character_extents:
  37 @get_character_count:
  38 @get_offset_at_point:
  39 @get_n_selections:
  40 @get_selection:
  41 @add_selection:
  42 @remove_selection:
  43 @set_selection:
  44 @set_caret_offset:
  45 @text_changed:
  46 @caret_changed:
  47
  48 <!-- ##### ENUM AtkTextBoundary ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @ATK_TEXT_BOUNDARY_CHAR:
  54 @ATK_TEXT_BOUNDARY_CURSOR_POS:
  55 @ATK_TEXT_BOUNDARY_WORD_START:
  56 @ATK_TEXT_BOUNDARY_WORD_END:
  57 @ATK_TEXT_BOUNDARY_SENTENCE_START:
  58 @ATK_TEXT_BOUNDARY_SENTENCE_END:
  59 @ATK_TEXT_BOUNDARY_LINE_START:
  60 @ATK_TEXT_BOUNDARY_LINE_END:
  61
  62 <!-- ##### FUNCTION atk_text_get_text ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @text:
  68 @start_offset:
  69 @end_offset:
  70 @Returns:
  71
  72
  73 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  74 <para>
  75
  76 </para>
  77
  78 @text:
  79 @offset:
  80 @Returns:
  81
  82
  83 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
  84 <para>
  85
  86 </para>
  87
  88 @text:
  89 @offset:
  90 @boundary_type:
  91 @Returns:
  92 <!-- # Unused Parameters # -->
  93 @startOffset:
  94 @endOffset:
  95
  96
  97 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @text:
 103 @offset:
 104 @boundary_type:
 105 @Returns:
 106 <!-- # Unused Parameters # -->
 107 @startOffset:
 108 @endOffset:
 109
 110
 111 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @text:
 117 @offset:
 118 @boundary_type:
 119 @Returns:
 120 <!-- # Unused Parameters # -->
 121 @startOffset:
 122 @endOffset:
 123
 124
 125 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @text:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @text:
 140 @offset:
 141 @x:
 142 @y:
 143 @length:
 144 @width:
 145 <!-- # Unused Parameters # -->
 146 @coords:
 147
 148
 149 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @text:
 155 @Returns:
 156
 157
 158 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @text:
 164 @x:
 165 @y:
 166 @Returns:
 167 <!-- # Unused Parameters # -->
 168 @coords:
 169
 170
 171 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 172 <para>
 173
 174 </para>
 175
 176 @text:
 177 @Returns:
 178
 179
 180 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @text:
 186 @selection_num:
 187 @start_offset:
 188 @end_offset:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @text:
 198 @start_offset:
 199 @end_offset:
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @text:
 209 @selection_num:
 210 @Returns:
 211
 212
 213 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 214 <para>
 215
 216 </para>
 217
 218 @text:
 219 @selection_num:
 220 @start_offset:
 221 @end_offset:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @text:
 231 @offset:
 232 @Returns:
 233
 234