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