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_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 @startOffset:
  92 @endOffset:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @text:
 102 @offset:
 103 @boundary_type:
 104 @startOffset:
 105 @endOffset:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @text:
 115 @offset:
 116 @boundary_type:
 117 @startOffset:
 118 @endOffset:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @text:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @text:
 137 @offset:
 138 @x:
 139 @y:
 140 @length:
 141 @width:
 142 @coords:
 143
 144
 145 <!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @text:
 151 @offset:
 152 @start_offset:
 153 @end_offset:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @text:
 163 @Returns:
 164
 165
 166 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @text:
 172 @x:
 173 @y:
 174 @coords:
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @text:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @text:
 193 @selection_num:
 194 @start_offset:
 195 @end_offset:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @text:
 205 @start_offset:
 206 @end_offset:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @text:
 216 @selection_num:
 217 @Returns:
 218
 219
 220 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @text:
 226 @selection_num:
 227 @start_offset:
 228 @end_offset:
 229 @Returns:
 230
 231
 232 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @text:
 238 @offset:
 239 @Returns:
 240
 241