docs/tmpl/atktext.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkText
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 ATK Interface provided by components with text content.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #AtkText should be implemented by #AtkObjects on behalf of widgets that
  10 have text content which is either attributed or otherwise non-trivial.
  11 #AtkObjects whose text content is simple, unattributed, and very brief
  12 may expose that content via #atk_object_get_name instead; however if the
  13 text is editable, multi-line, typically longer than three or four words,
  14 attributed, selectable, or if the object already uses the 'name' ATK
  15 property for other information, the #AtkText interface should be used
  16 to expose the text content.  In the case of editable text content,
  17 #AtkEditableText (a subtype of the #AtkText interface) should be
  18 implemented instead.
  19 </para>
  20 <para>
  21 #AtkText provides not only traversal facilities and change notification
  22 for text content, but also caret tracking and glyph bounding box
  23 calculations.  Note that the text strings are exposed as UTF-8, and are
  24 therefore potentially multi-byte, and caret-to-byte offset mapping makes
  25 no assumptions about the character length; also bounding box
  26 glyph-to-offset mapping may be complex for languages which use ligatures.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31
  32 </para>
  33
  34 <!-- ##### STRUCT AtkText ##### -->
  35 <para>
  36
  37 </para>
  38
  39
  40 <!-- ##### STRUCT AtkTextIface ##### -->
  41 <para>
  42
  43 </para>
  44
  45 @parent:
  46 @get_text:
  47 @get_text_after_offset:
  48 @get_text_at_offset:
  49 @get_character_at_offset:
  50 @get_text_before_offset:
  51 @get_caret_offset:
  52 @get_run_attributes:
  53 @get_default_attributes:
  54 @get_character_extents:
  55 @get_character_count:
  56 @get_offset_at_point:
  57 @get_n_selections:
  58 @get_selection:
  59 @add_selection:
  60 @remove_selection:
  61 @set_selection:
  62 @set_caret_offset:
  63 @text_changed:
  64 @text_caret_moved:
  65 @text_selection_changed:
  66
  67 <!-- ##### ENUM AtkTextBoundary ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @ATK_TEXT_BOUNDARY_CHAR:
  73 @ATK_TEXT_BOUNDARY_WORD_START:
  74 @ATK_TEXT_BOUNDARY_WORD_END:
  75 @ATK_TEXT_BOUNDARY_SENTENCE_START:
  76 @ATK_TEXT_BOUNDARY_SENTENCE_END:
  77 @ATK_TEXT_BOUNDARY_LINE_START:
  78 @ATK_TEXT_BOUNDARY_LINE_END:
  79
  80 <!-- ##### STRUCT AtkAttribute ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @name:
  86 @value:
  87
  88 <!-- ##### TYPEDEF AtkAttributeSet ##### -->
  89 <para>
  90
  91 </para>
  92
  93
  94 <!-- ##### ENUM AtkTextAttribute ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @ATK_TEXT_ATTR_INVALID:
 100 @ATK_TEXT_ATTR_LEFT_MARGIN:
 101 @ATK_TEXT_ATTR_RIGHT_MARGIN:
 102 @ATK_TEXT_ATTR_INDENT:
 103 @ATK_TEXT_ATTR_INVISIBLE:
 104 @ATK_TEXT_ATTR_EDITABLE:
 105 @ATK_TEXT_ATTR_PIXELS_ABOVE_LINES:
 106 @ATK_TEXT_ATTR_PIXELS_BELOW_LINES:
 107 @ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP:
 108 @ATK_TEXT_ATTR_BG_FULL_HEIGHT:
 109 @ATK_TEXT_ATTR_RISE:
 110 @ATK_TEXT_ATTR_UNDERLINE:
 111 @ATK_TEXT_ATTR_STRIKETHROUGH:
 112 @ATK_TEXT_ATTR_SIZE:
 113 @ATK_TEXT_ATTR_SCALE:
 114 @ATK_TEXT_ATTR_WEIGHT:
 115 @ATK_TEXT_ATTR_LANGUAGE:
 116 @ATK_TEXT_ATTR_FAMILY_NAME:
 117 @ATK_TEXT_ATTR_BG_COLOR:
 118 @ATK_TEXT_ATTR_FG_COLOR:
 119 @ATK_TEXT_ATTR_BG_STIPPLE:
 120 @ATK_TEXT_ATTR_FG_STIPPLE:
 121 @ATK_TEXT_ATTR_WRAP_MODE:
 122 @ATK_TEXT_ATTR_DIRECTION:
 123 @ATK_TEXT_ATTR_JUSTIFICATION:
 124 @ATK_TEXT_ATTR_STRETCH:
 125 @ATK_TEXT_ATTR_VARIANT:
 126 @ATK_TEXT_ATTR_STYLE:
 127 @ATK_TEXT_ATTR_LAST_DEFINED:
 128
 129 <!-- ##### FUNCTION atk_text_get_text ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @text:
 135 @start_offset:
 136 @end_offset:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @text:
 146 @offset:
 147 @Returns:
 148
 149
 150 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @text:
 156 @offset:
 157 @boundary_type:
 158 @start_offset:
 159 @end_offset:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @text:
 169 @offset:
 170 @boundary_type:
 171 @start_offset:
 172 @end_offset:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @text:
 182 @offset:
 183 @boundary_type:
 184 @start_offset:
 185 @end_offset:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @text:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @text:
 204 @offset:
 205 @x:
 206 @y:
 207 @width:
 208 @height:
 209 @coords:
 210 <!-- # Unused Parameters # -->
 211 @length:
 212
 213
 214 <!-- ##### FUNCTION atk_text_get_run_attributes ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @text:
 220 @offset:
 221 @start_offset:
 222 @end_offset:
 223 @Returns:
 224
 225
 226 <!-- ##### FUNCTION atk_text_get_default_attributes ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @text:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @text:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @text:
 250 @x:
 251 @y:
 252 @coords:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @text:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @text:
 271 @selection_num:
 272 @start_offset:
 273 @end_offset:
 274 @Returns:
 275
 276
 277 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @text:
 283 @start_offset:
 284 @end_offset:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @text:
 294 @selection_num:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @text:
 304 @selection_num:
 305 @start_offset:
 306 @end_offset:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @text:
 316 @offset:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION atk_attribute_set_free ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @attrib_set:
 326
 327
 328 <!-- ##### FUNCTION atk_text_attribute_register ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @name:
 334 @Returns:
 335
 336
 337 <!-- ##### FUNCTION atk_text_attribute_get_name ##### -->
 338 <para>
 339
 340 </para>
 341
 342 @attr:
 343 @Returns:
 344
 345
 346 <!-- ##### FUNCTION atk_text_attribute_for_name ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @name:
 352 @Returns:
 353
 354
 355 <!-- ##### FUNCTION atk_text_attribute_get_value ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @attr:
 361 @index:
 362 @Returns:
 363
 364