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