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 <!-- ##### FUNCTION AccessibleText_ref ##### -->
  33 <para>
  34
  35 </para>
  36
  37 @obj:
  38 <!-- # Unused Parameters # -->
  39 @Returns:
  40
  41
  42 <!-- ##### FUNCTION AccessibleText_unref ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @obj:
  48 <!-- # Unused Parameters # -->
  49 @Returns:
  50
  51
  52 <!-- ##### FUNCTION AccessibleText_addSelection ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @obj:
  58 @Returns:
  59 <!-- # Unused Parameters # -->
  60 @startOffset:
  61 @endOffset:
  62
  63
  64 <!-- ##### FUNCTION AccessibleText_getAttributes ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @obj:
  70 @Returns:
  71 <!-- # Unused Parameters # -->
  72 @offset:
  73 @startOffset:
  74 @endOffset:
  75
  76
  77 <!-- ##### FUNCTION AccessibleText_getCaretOffset ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @obj:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION AccessibleText_getCharacterCount ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @obj:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION AccessibleText_getCharacterExtents ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @obj:
 101 <!-- # Unused Parameters # -->
 102 @offset:
 103 @x:
 104 @y:
 105 @width:
 106 @height:
 107 @type:
 108
 109
 110 <!-- ##### FUNCTION AccessibleText_getNSelections ##### -->
 111 <para>
 112
 113 </para>
 114
 115 @obj:
 116 @Returns:
 117
 118
 119 <!-- ##### FUNCTION AccessibleText_getOffsetAtPoint ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @obj:
 125 @Returns:
 126 <!-- # Unused Parameters # -->
 127 @x:
 128 @y:
 129 @type:
 130
 131
 132 <!-- ##### FUNCTION AccessibleText_getSelection ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @obj:
 138 <!-- # Unused Parameters # -->
 139 @selectionNum:
 140 @startOffset:
 141 @endOffset:
 142
 143
 144 <!-- ##### FUNCTION AccessibleText_getText ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @obj:
 150 @Returns:
 151 <!-- # Unused Parameters # -->
 152 @startOffset:
 153 @endOffset:
 154
 155
 156 <!-- ##### FUNCTION AccessibleText_getTextBeforeOffset ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @obj:
 162 @Returns:
 163 <!-- # Unused Parameters # -->
 164 @offset:
 165 @type:
 166 @startOffset:
 167 @endOffset:
 168
 169
 170 <!-- ##### FUNCTION AccessibleText_getTextAfterOffset ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @obj:
 176 @Returns:
 177 <!-- # Unused Parameters # -->
 178 @offset:
 179 @type:
 180 @startOffset:
 181 @endOffset:
 182
 183
 184 <!-- ##### FUNCTION AccessibleText_getTextAtOffset ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @obj:
 190 @Returns:
 191 <!-- # Unused Parameters # -->
 192 @offset:
 193 @type:
 194 @startOffset:
 195 @endOffset:
 196
 197
 198 <!-- ##### FUNCTION AccessibleText_removeSelection ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @obj:
 204 @Returns:
 205 <!-- # Unused Parameters # -->
 206 @selectionNum:
 207
 208
 209 <!-- ##### FUNCTION AccessibleText_setCaretOffset ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @obj:
 215 @Returns:
 216 <!-- # Unused Parameters # -->
 217 @newOffset:
 218
 219
 220 <!-- ##### FUNCTION AccessibleText_setSelection ##### -->
 221 <para>
 222
 223 </para>
 224
 225 @obj:
 226 @Returns:
 227 <!-- # Unused Parameters # -->
 228 @selectionNum:
 229 @startOffset:
 230 @endOffset:
 231
 232