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 @set_run_attributes:
  46 @text_changed:
  47 @caret_changed:
  48
  49 <!-- ##### ENUM AtkTextBoundary ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @ATK_TEXT_BOUNDARY_CHAR:
  55 @ATK_TEXT_BOUNDARY_CURSOR_POS:
  56 @ATK_TEXT_BOUNDARY_WORD_START:
  57 @ATK_TEXT_BOUNDARY_WORD_END:
  58 @ATK_TEXT_BOUNDARY_SENTENCE_START:
  59 @ATK_TEXT_BOUNDARY_SENTENCE_END:
  60 @ATK_TEXT_BOUNDARY_LINE_START:
  61 @ATK_TEXT_BOUNDARY_LINE_END:
  62
  63 <!-- ##### FUNCTION atk_text_get_text ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @text:
  69 @start_offset:
  70 @end_offset:
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @text:
  80 @offset:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @text:
  90 @offset:
  91 @boundary_type:
  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 @Returns:
 104
 105
 106 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @text:
 112 @offset:
 113 @boundary_type:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @text:
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @text:
 132 @offset:
 133 @x:
 134 @y:
 135 @length:
 136 @width:
 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 @Returns:
 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