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 @ref_run_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_WORD_START:
  55 @ATK_TEXT_BOUNDARY_WORD_END:
  56 @ATK_TEXT_BOUNDARY_SENTENCE_START:
  57 @ATK_TEXT_BOUNDARY_SENTENCE_END:
  58 @ATK_TEXT_BOUNDARY_LINE_START:
  59 @ATK_TEXT_BOUNDARY_LINE_END:
  60
  61 <!-- ##### FUNCTION atk_text_get_text ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @text:
  67 @start_offset:
  68 @end_offset:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @text:
  78 @offset:
  79 @Returns:
  80
  81
  82 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @text:
  88 @offset:
  89 @boundary_type:
  90 @startOffset:
  91 @endOffset:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @text:
 101 @offset:
 102 @boundary_type:
 103 @startOffset:
 104 @endOffset:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @text:
 114 @offset:
 115 @boundary_type:
 116 @startOffset:
 117 @endOffset:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @text:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @text:
 136 @offset:
 137 @x:
 138 @y:
 139 @length:
 140 @width:
 141 @coords:
 142
 143
 144 <!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @text:
 150 @offset:
 151 @start_offset:
 152 @end_offset:
 153 @Returns:
 154
 155
 156 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @text:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @text:
 171 @x:
 172 @y:
 173 @coords:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @text:
 183 @Returns:
 184
 185
 186 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @text:
 192 @selection_num:
 193 @start_offset:
 194 @end_offset:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @text:
 204 @start_offset:
 205 @end_offset:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @text:
 215 @selection_num:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @text:
 225 @selection_num:
 226 @start_offset:
 227 @end_offset:
 228 @Returns:
 229
 230
 231 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 232 <para>
 233
 234 </para>
 235
 236 @text:
 237 @offset:
 238 @Returns:
 239
 240