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
 143
 144 <!-- ##### FUNCTION atk_text_get_text_at_offset ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @text:
 150 @offset:
 151 @boundary_type:
 152 @start_offset:
 153 @end_offset:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION atk_text_get_text_before_offset ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @text:
 163 @offset:
 164 @boundary_type:
 165 @start_offset:
 166 @end_offset:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION atk_text_get_caret_offset ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @text:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION atk_text_get_character_extents ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @text:
 185 @offset:
 186 @x:
 187 @y:
 188 @width:
 189 @height:
 190 @coords:
 191
 192
 193 <!-- ##### FUNCTION atk_text_get_run_attributes ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @text:
 199 @offset:
 200 @start_offset:
 201 @end_offset:
 202 @Returns:
 203
 204
 205 <!-- ##### FUNCTION atk_text_get_default_attributes ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @text:
 211 @Returns:
 212
 213
 214 <!-- ##### FUNCTION atk_text_get_character_count ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @text:
 220 @Returns:
 221
 222
 223 <!-- ##### FUNCTION atk_text_get_offset_at_point ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @text:
 229 @x:
 230 @y:
 231 @coords:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION atk_text_get_n_selections ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @text:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION atk_text_get_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_add_selection ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @text:
 262 @start_offset:
 263 @end_offset:
 264 @Returns:
 265
 266
 267 <!-- ##### FUNCTION atk_text_remove_selection ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @text:
 273 @selection_num:
 274 @Returns:
 275
 276
 277 <!-- ##### FUNCTION atk_text_set_selection ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @text:
 283 @selection_num:
 284 @start_offset:
 285 @end_offset:
 286 @Returns:
 287
 288
 289 <!-- ##### FUNCTION atk_text_set_caret_offset ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @text:
 295 @offset:
 296 @Returns:
 297
 298
 299 <!-- ##### FUNCTION atk_attribute_set_free ##### -->
 300 <para>
 301
 302 </para>
 303
 304 @attrib_set:
 305
 306
 307 <!-- ##### FUNCTION atk_attribute_get_name ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @attr:
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION atk_attribute_get_value ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @attr:
 322 @index:
 323 @Returns:
 324
 325