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