doc/libatspi/tmpl/atspi-text.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 atspi-text
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An interface implemented by objects which place textual
   6 information onscreen.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 The text interface should be implemented by objects which place textual
  11 information onscreen as character strings or glyphs. The text interface
  12 allows access to textual content including display attributes and
  13 semantic hints associated with runs of text, and to bounding boc
  14 information for glyphs and substrings. It also alows portions of text to
  15 be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT.
  16 </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19 <para>
  20
  21 </para>
  22
  23 <!-- ##### SECTION Stability_Level ##### -->
  24
  25
  26 <!-- ##### SECTION Image ##### -->
  27
  28
  29 <!-- ##### STRUCT AtspiRange ##### -->
  30 <para>
  31
  32 </para>
  33
  34
  35 <!-- ##### MACRO ATSPI_TYPE_RANGE ##### -->
  36 <para>
  37
  38 </para>
  39
  40
  41
  42 <!-- ##### FUNCTION atspi_range_copy ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @src:
  48 @Returns:
  49
  50
  51 <!-- ##### STRUCT AtspiTextRange ##### -->
  52 <para>
  53
  54 </para>
  55
  56
  57 <!-- ##### MACRO ATSPI_TYPE_TEXT_RANGE ##### -->
  58 <para>
  59
  60 </para>
  61
  62
  63
  64 <!-- ##### FUNCTION atspi_text_get_type ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @Returns:
  70
  71
  72 <!-- ##### STRUCT AtspiText ##### -->
  73 <para>
  74
  75 </para>
  76
  77
  78 <!-- ##### FUNCTION atspi_text_range_get_type ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION atspi_text_get_character_count ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @obj:
  92 @error:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION atspi_text_get_text ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @obj:
 102 @start_offset:
 103 @end_offset:
 104 @error:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION atspi_text_get_caret_offset ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @obj:
 114 @error:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION atspi_text_get_attributes ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @obj:
 124 @offset:
 125 @start_offset:
 126 @end_offset:
 127 @error:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION atspi_text_get_attribute_run ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @obj:
 137 @offset:
 138 @include_defaults:
 139 @start_offset:
 140 @end_offset:
 141 @error:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION atspi_text_get_attribute_value ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @obj:
 151 @offset:
 152 @attribute_name:
 153 @error:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION atspi_text_get_default_attributes ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @obj:
 163 @error:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION atspi_text_set_caret_offset ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @obj:
 173 @new_offset:
 174 @error:
 175 @Returns:
 176
 177
 178 <!-- ##### FUNCTION atspi_text_get_text_before_offset ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @obj:
 184 @offset:
 185 @type:
 186 @error:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION atspi_text_get_text_at_offset ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @obj:
 196 @offset:
 197 @type:
 198 @error:
 199 @Returns:
 200
 201
 202 <!-- ##### FUNCTION atspi_text_get_text_after_offset ##### -->
 203 <para>
 204
 205 </para>
 206
 207 @obj:
 208 @offset:
 209 @type:
 210 @error:
 211 @Returns:
 212
 213
 214 <!-- ##### FUNCTION atspi_text_get_character_at_offset ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @obj:
 220 @offset:
 221 @error:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION atspi_text_get_character_extents ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @obj:
 231 @offset:
 232 @type:
 233 @error:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION atspi_text_get_offset_at_point ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @obj:
 243 @x:
 244 @y:
 245 @type:
 246 @error:
 247 @Returns:
 248
 249
 250 <!-- ##### FUNCTION atspi_text_get_range_extents ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @obj:
 256 @start_offset:
 257 @end_offset:
 258 @type:
 259 @error:
 260 @Returns:
 261
 262
 263 <!-- ##### FUNCTION atspi_text_get_bounded_ranges ##### -->
 264 <para>
 265
 266 </para>
 267
 268 @obj:
 269 @x:
 270 @y:
 271 @width:
 272 @height:
 273 @type:
 274 @clipTypeX:
 275 @clipTypeY:
 276 @error:
 277 @Returns:
 278
 279
 280 <!-- ##### FUNCTION atspi_text_get_n_selections ##### -->
 281 <para>
 282
 283 </para>
 284
 285 @obj:
 286 @error:
 287 @Returns:
 288
 289
 290 <!-- ##### FUNCTION atspi_text_get_selection ##### -->
 291 <para>
 292
 293 </para>
 294
 295 @obj:
 296 @selection_num:
 297 @error:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION atspi_text_add_selection ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @obj:
 307 @start_offset:
 308 @end_offset:
 309 @error:
 310 @Returns:
 311
 312
 313 <!-- ##### FUNCTION atspi_text_remove_selection ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @obj:
 319 @selection_num:
 320 @error:
 321 @Returns:
 322
 323
 324 <!-- ##### FUNCTION atspi_text_set_selection ##### -->
 325 <para>
 326
 327 </para>
 328
 329 @obj:
 330 @selection_num:
 331 @start_offset:
 332 @end_offset:
 333 @error:
 334 @Returns:
 335
 336