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 @text_selection_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 <!-- ##### ENUM AtkTextAttribute ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @ATK_TEXT_ATTR_INVALID:
  83 @ATK_TEXT_ATTR_LEFT_MARGIN:
  84 @ATK_TEXT_ATTR_RIGHT_MARGIN:
  85 @ATK_TEXT_ATTR_INDENT:
  86 @ATK_TEXT_ATTR_INVISIBLE:
  87 @ATK_TEXT_ATTR_EDITABLE:
  88 @ATK_TEXT_ATTR_PIXELS_ABOVE_LINES:
  89 @ATK_TEXT_ATTR_PIXELS_BELOW_LINES:
  90 @ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP:
  91 @ATK_TEXT_ATTR_BG_FULL_HEIGHT:
  92 @ATK_TEXT_ATTR_RISE:
  93 @ATK_TEXT_ATTR_UNDERLINE:
  94 @ATK_TEXT_ATTR_STRIKETHROUGH:
  95 @ATK_TEXT_ATTR_SIZE:
  96 @ATK_TEXT_ATTR_SCALE:
  97 @ATK_TEXT_ATTR_WEIGHT:
  98 @ATK_TEXT_ATTR_LANGUAGE:
  99 @ATK_TEXT_ATTR_FAMILY_NAME:
 100 @ATK_TEXT_ATTR_BG_COLOR:
 101 @ATK_TEXT_ATTR_FG_COLOR:
 102 @ATK_TEXT_ATTR_BG_STIPPLE:
 103 @ATK_TEXT_ATTR_FG_STIPPLE:
 104 @ATK_TEXT_ATTR_WRAP_MODE:
 105 @ATK_TEXT_ATTR_DIRECTION:
 106 @ATK_TEXT_ATTR_JUSTIFICATION:
 107 @ATK_TEXT_ATTR_STRETCH:
 108 @ATK_TEXT_ATTR_VARIANT:
 109 @ATK_TEXT_ATTR_STYLE:
 110 @ATK_TEXT_ATTR_LAST_DEFINED:
 111
 112 <!-- ##### FUNCTION atk_text_get_text ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @text:
 118 @start_offset:
 119 @end_offset:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION atk_text_get_character_at_offset ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @text:
 129 @offset:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION atk_text_get_text_after_offset ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @text:
 139 @offset:
 140 @boundary_type:
 141 @start_offset:
 142 @end_offset:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @text:
 152 @offset:
 153 @boundary_type:
 154 @start_offset:
 155 @end_offset:
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @text:
 165 @offset:
 166 @boundary_type:
 167 @start_offset:
 168 @end_offset:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @text:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @text:
 187 @offset:
 188 @x:
 189 @y:
 190 @width:
 191 @height:
 192 @coords:
 193 <!-- # Unused Parameters # -->
 194 @length:
 195
 196
 197 <!-- ##### FUNCTION atk_text_get_run_attributes ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @text:
 203 @offset:
 204 @start_offset:
 205 @end_offset:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION atk_text_get_default_attributes ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @text:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @text:
 224 @Returns:
 225
 226
 227 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @text:
 233 @x:
 234 @y:
 235 @coords:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @text:
 245 @Returns:
 246
 247
 248 <!-- ##### FUNCTION atk_text_get_selection ##### -->
 249 <para>
 250
 251 </para>
 252
 253 @text:
 254 @selection_num:
 255 @start_offset:
 256 @end_offset:
 257 @Returns:
 258
 259
 260 <!-- ##### FUNCTION atk_text_add_selection ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @text:
 266 @start_offset:
 267 @end_offset:
 268 @Returns:
 269
 270
 271 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @text:
 277 @selection_num:
 278 @Returns:
 279
 280
 281 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 282 <para>
 283
 284 </para>
 285
 286 @text:
 287 @selection_num:
 288 @start_offset:
 289 @end_offset:
 290 @Returns:
 291
 292
 293 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @text:
 299 @offset:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION atk_attribute_set_free ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @attrib_set:
 309
 310
 311 <!-- ##### FUNCTION atk_attribute_register ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @name:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION atk_attribute_get_name ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @attr:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION atk_attribute_for_name ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @name:
 335 @Returns:
 336
 337
 338 <!-- ##### FUNCTION atk_attribute_get_value ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @attr:
 344 @index:
 345 @Returns:
 346
 347