docs/tmpl/atktext.sgml

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