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