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