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 <!-- ##### STRUCT AtkAttribute ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @name:
  67 @value:
  68
  69 <!-- ##### TYPEDEF AtkAttributeSet ##### -->
  70 <para>
  71
  72 </para>
  73
  74
  75 <!-- ##### FUNCTION atk_text_get_text ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @text:
  81 @start_offset:
  82 @end_offset:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @text:
  92 @offset:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atk_text_get_text_after_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_at_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_text_before_offset ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @text:
 128 @offset:
 129 @boundary_type:
 130 @startOffset:
 131 @endOffset:
 132 @Returns:
 133
 134
 135 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @text:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @text:
 150 @offset:
 151 @x:
 152 @y:
 153 @length:
 154 @width:
 155 @coords:
 156
 157
 158 <!-- ##### FUNCTION atk_text_ref_run_attributes ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @text:
 164 @offset:
 165 @start_offset:
 166 @end_offset:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @text:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @text:
 185 @x:
 186 @y:
 187 @coords:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @text:
 197 @Returns:
 198
 199
 200 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @text:
 206 @selection_num:
 207 @start_offset:
 208 @end_offset:
 209 @Returns:
 210
 211
 212 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @text:
 218 @start_offset:
 219 @end_offset:
 220 @Returns:
 221
 222
 223 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @text:
 229 @selection_num:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @text:
 239 @selection_num:
 240 @start_offset:
 241 @end_offset:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @text:
 251 @offset:
 252 @Returns:
 253
 254
 255 <!-- ##### MACRO ATK_ATTRIBUTE_LEFT_MARGIN ##### -->
 256 <para>
 257
 258 </para>
 259
 260
 261
 262 <!-- ##### MACRO ATK_ATTRIBUTE_RIGHT_MARGIN ##### -->
 263 <para>
 264
 265 </para>
 266
 267
 268
 269 <!-- ##### MACRO ATK_ATTRIBUTE_INDENT ##### -->
 270 <para>
 271
 272 </para>
 273
 274
 275
 276 <!-- ##### MACRO ATK_ATTRIBUTE_INVISIBLE ##### -->
 277 <para>
 278
 279 </para>
 280
 281
 282
 283 <!-- ##### MACRO ATK_ATTRIBUTE_EDITABLE ##### -->
 284 <para>
 285
 286 </para>
 287
 288
 289
 290 <!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_ABOVE_LINES ##### -->
 291 <para>
 292
 293 </para>
 294
 295
 296
 297 <!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_BELOW_LINES ##### -->
 298 <para>
 299
 300 </para>
 301
 302
 303
 304 <!-- ##### MACRO ATK_ATTRIBUTE_PIXELS_INSIDE_WRAP ##### -->
 305 <para>
 306
 307 </para>
 308
 309
 310
 311 <!-- ##### MACRO ATK_ATTRIBUTE_BG_FULL_HEIGHT ##### -->
 312 <para>
 313
 314 </para>
 315
 316
 317
 318 <!-- ##### MACRO ATK_ATTRIBUTE_RISE ##### -->
 319 <para>
 320
 321 </para>
 322
 323
 324
 325 <!-- ##### MACRO ATK_ATTRIBUTE_UNDERLINE ##### -->
 326 <para>
 327
 328 </para>
 329
 330
 331
 332 <!-- ##### MACRO ATK_ATTRIBUTE_STRIKETHROUGH ##### -->
 333 <para>
 334
 335 </para>
 336
 337
 338
 339 <!-- ##### MACRO ATK_ATTRIBUTE_SIZE ##### -->
 340 <para>
 341
 342 </para>
 343
 344
 345
 346 <!-- ##### MACRO ATK_ATTRIBUTE_SCALE ##### -->
 347 <para>
 348
 349 </para>
 350
 351
 352
 353 <!-- ##### MACRO ATK_ATTRIBUTE_WEIGHT ##### -->
 354 <para>
 355
 356 </para>
 357
 358
 359
 360 <!-- ##### MACRO ATK_ATTRIBUTE_LANGUAGE ##### -->
 361 <para>
 362
 363 </para>
 364
 365
 366
 367 <!-- ##### MACRO ATK_ATTRIBUTE_FAMILY_NAME ##### -->
 368 <para>
 369
 370 </para>
 371
 372
 373
 374 <!-- ##### MACRO ATK_ATTRIBUTE_BG_COLOR ##### -->
 375 <para>
 376
 377 </para>
 378
 379
 380
 381 <!-- ##### MACRO ATK_ATTRIBUTE_FG_COLOR ##### -->
 382 <para>
 383
 384 </para>
 385
 386
 387
 388 <!-- ##### MACRO ATK_ATTRIBUTE_BG_STIPPLE ##### -->
 389 <para>
 390
 391 </para>
 392
 393
 394
 395 <!-- ##### MACRO ATK_ATTRIBUTE_FG_STIPPLE ##### -->
 396 <para>
 397
 398 </para>
 399
 400
 401
 402 <!-- ##### MACRO ATK_ATTRIBUTE_WRAP_MODE ##### -->
 403 <para>
 404
 405 </para>
 406
 407
 408
 409 <!-- ##### MACRO ATK_ATTRIBUTE_DIRECTION ##### -->
 410 <para>
 411
 412 </para>
 413
 414
 415
 416 <!-- ##### MACRO ATK_ATTRIBUTE_JUSTIFICATION ##### -->
 417 <para>
 418
 419 </para>
 420
 421
 422
 423 <!-- ##### MACRO ATK_ATTRIBUTE_STRETCH ##### -->
 424 <para>
 425
 426 </para>
 427
 428
 429
 430 <!-- ##### MACRO ATK_ATTRIBUTE_VARIANT ##### -->
 431 <para>
 432
 433 </para>
 434
 435
 436
 437 <!-- ##### MACRO ATK_ATTRIBUTE_STYLE ##### -->
 438 <para>
 439
 440 </para>
 441
 442
 443