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