docs/reference/cspi/tmpl/spi_text.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AccessibleText Interface
   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 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### ENUM AccessibleTextBoundaryType ##### -->
  21 <para>
  22
  23 </para>
  24
  25 @SPI_TEXT_BOUNDARY_CHAR:
  26 @SPI_TEXT_BOUNDARY_CURSOR_POS:
  27 @SPI_TEXT_BOUNDARY_WORD_START:
  28 @SPI_TEXT_BOUNDARY_WORD_END:
  29 @SPI_TEXT_BOUNDARY_SENTENCE_START:
  30 @SPI_TEXT_BOUNDARY_SENTENCE_END:
  31 @SPI_TEXT_BOUNDARY_LINE_START:
  32 @SPI_TEXT_BOUNDARY_LINE_END:
  33 @SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
  34
  35 <!-- ##### ENUM AccessibleTextClipType ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @SPI_TEXT_CLIP_NONE:
  41 @SPI_TEXT_CLIP_MIN:
  42 @SPI_TEXT_CLIP_MAX:
  43 @SPI_TEXT_CLIP_BOTH:
  44
  45 <!-- ##### FUNCTION AccessibleText_ref ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @obj:
  51
  52
  53 <!-- ##### FUNCTION AccessibleText_unref ##### -->
  54 <para>
  55
  56 </para>
  57
  58 @obj:
  59
  60
  61 <!-- ##### FUNCTION AccessibleText_addSelection ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @obj:
  67 @startOffset:
  68 @endOffset:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION AccessibleText_getAttributes ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @obj:
  78 @offset:
  79 @startOffset:
  80 @endOffset:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION AccessibleText_getBoundedRanges ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @obj:
  90 @x:
  91 @y:
  92 @width:
  93 @height:
  94 @type:
  95 @clipTypeX:
  96 @clipTypeY:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION AccessibleText_getCaretOffset ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @obj:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION AccessibleText_getCharacterCount ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @obj:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION AccessibleText_getCharacterExtents ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @obj:
 124 @offset:
 125 @x:
 126 @y:
 127 @width:
 128 @height:
 129 @type:
 130
 131
 132 <!-- ##### FUNCTION AccessibleText_getNSelections ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @obj:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION AccessibleText_getOffsetAtPoint ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @obj:
 147 @x:
 148 @y:
 149 @type:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION AccessibleText_getRangeExtents ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @obj:
 159 @startOffset:
 160 @endOffset:
 161 @x:
 162 @y:
 163 @width:
 164 @height:
 165 @type:
 166
 167
 168 <!-- ##### FUNCTION AccessibleText_getSelection ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @obj:
 174 @selectionNum:
 175 @startOffset:
 176 @endOffset:
 177
 178
 179 <!-- ##### FUNCTION AccessibleText_getText ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @obj:
 185 @startOffset:
 186 @endOffset:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION AccessibleText_getTextBeforeOffset ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @obj:
 196 @offset:
 197 @type:
 198 @startOffset:
 199 @endOffset:
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION AccessibleText_getTextAfterOffset ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @obj:
 209 @offset:
 210 @type:
 211 @startOffset:
 212 @endOffset:
 213 @Returns:
 214
 215
 216 <!-- ##### FUNCTION AccessibleText_getTextAtOffset ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @obj:
 222 @offset:
 223 @type:
 224 @startOffset:
 225 @endOffset:
 226 @Returns:
 227
 228
 229 <!-- ##### FUNCTION AccessibleText_removeSelection ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @obj:
 235 @selectionNum:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION AccessibleText_setCaretOffset ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @obj:
 245 @newOffset:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION AccessibleText_setSelection ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @obj:
 255 @selectionNum:
 256 @startOffset:
 257 @endOffset:
 258 @Returns:
 259
 260
 261 <!-- ##### FUNCTION AccessibleText_getCharacterAtOffset ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @obj:
 267 @offset:
 268 @Returns:
 269
 270
 271 <!-- ##### FUNCTION AccessibleText_getDefaultAttributes ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @obj:
 277 @Returns:
 278
 279
 280 <!-- ##### FUNCTION AccessibleText_getAttributeRun ##### -->
 281 <para>
 282
 283 </para>
 284
 285 @obj:
 286 @offset:
 287 @startOffset:
 288 @endOffset:
 289 @includeDefaults:
 290 @Returns:
 291
 292
 293 <!-- ##### FUNCTION AccessibleText_getDefaultAttributeSet ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @obj:
 299 @Returns:
 300
 301
 302 <!-- ##### FUNCTION AccessibleTextRange_freeRanges ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @ranges:
 308
 309