docs/reference/cspi/at-spi-cspi-sections.txt

   1 <SECTION>
   2 <FILE>spi_main</FILE>
   3 <TITLE>SPI main loop and initialization</TITLE>
   4 SPI_init
   5 SPI_event_main
   6 SPI_event_quit
   7 SPI_eventIsReady
   8 SPI_nextEvent
   9 SPI_exit
  10 <SUBSECTION Utility Functions>
  11 SPI_freeString
  12 SPIAccessibleException_getSource
  13 SPIException_getDescription
  14 SPIException_getExceptionCode
  15 SPIException_getSourceType
  16 SPIException
  17 SPIExceptionCode
  18 SPIExceptionType
  19 SPIBoolean
  20 SPIRect
  21 SPI_freeRect
  22 SPI_dupString
  23 SPI_exceptionHandlerPush
  24 SPI_exceptionHandlerPop
  25 </SECTION>
  26
  27 <SECTION>
  28 <FILE>spi_event</FILE>
  29 <TITLE>Event Listener Support</TITLE>
  30 AccessibleEvent
  31 AccessibleEventListenerCB
  32 AccessibleEvent_getSourceApplication
  33 AccessibleEvent_getSourceDetails
  34 AccessibleEvent_getSourceName
  35 AccessibleEvent_getSourceRole
  36 AccessibleEvent_ref
  37 AccessibleEvent_unref
  38 SPI_createAccessibleEventListener
  39 AccessibleEventListener_unref
  40 AccessibleEventListener_addCallback
  41 AccessibleEventListener_removeCallback
  42 <SUBSECTION Specific Event Support>
  43 AccessibleActiveDescendantChangedEvent_getActiveDescendant
  44 AccessibleChildChangedEvent_getChildAccessible
  45 AccessibleDescriptionChangedEvent_getDescriptionString
  46 AccessibleNameChangedEvent_getNameString
  47 AccessibleParentChangedEvent_getParentAccessible
  48 AccessibleBoundsChangedEvent_getNewBounds
  49 AccessibleTableCaptionChangedEvent_getCaptionString
  50 AccessibleTableColumnDescriptionChangedEvent_getDescriptionString
  51 AccessibleTableHeaderChangedEvent_getHeaderAccessible
  52 AccessibleTableRowDescriptionChangedEvent_getDescriptionString
  53 AccessibleTableSummaryChangedEvent_getSummaryAccessible
  54 AccessibleTextChangedEvent_getChangeString
  55 AccessibleTextSelectionChangedEvent_getSelectionString
  56 AccessibleWindowEvent_getTitleString
  57 </SECTION>
  58
  59 <SECTION>
  60 <FILE>spi_registry</FILE>
  61 <TITLE>Registry queries</TITLE>
  62 AccessibleKeySynthType
  63 SPI_getDesktopCount
  64 SPI_getDesktop
  65 SPI_getDesktopList
  66 SPI_freeDesktopList
  67 <SUBSECTION Event Registration>
  68 AccessibleKeystrokeListenerCB
  69 AccessibleKeyEventMask
  70 AccessibleModifierMaskType
  71 AccessibleKeyMaskType
  72 AccessibleKeyEventType
  73 AccessibleKeyListenerSyncType
  74 AccessibleKeystroke
  75 SPI_createAccessibleKeySet
  76 SPI_freeAccessibleKeySet
  77 SPI_createAccessibleKeystrokeListener
  78 SPI_registerGlobalEventListener
  79 SPI_deregisterGlobalEventListener
  80 SPI_deregisterGlobalEventListenerAll
  81 SPI_registerAccessibleKeystrokeListener
  82 SPI_deregisterAccessibleKeystrokeListener
  83 AccessibleKeystrokeListener_unref
  84 AccessibleKeystrokeListener_removeCallback
  85 AccessibleKeystrokeListener_addCallback
  86 SPI_generateKeyboardEvent
  87 SPI_generateMouseEvent
  88 AccessibleDeviceEvent
  89 AccessibleDeviceEventMask
  90 AccessibleDeviceEventType
  91 AccessibleDeviceListenerCB
  92 SPI_createAccessibleDeviceListener
  93 SPI_registerDeviceEventListener
  94 SPI_deregisterDeviceEventListener
  95 AccessibleDeviceListener_addCallback
  96 AccessibleDeviceListener_removeCallback
  97 AccessibleDeviceListener_unref
  98 <SUBSECTION Private>
  99 SPI_KEYSET_ALL_KEYS
 100 </SECTION>
 101
 102 <SECTION>
 103 <FILE>spi_accessible</FILE>
 104 <TITLE>Accessible Objects</TITLE>
 105 Accessible
 106 Accessible_ref
 107 Accessible_unref
 108 Accessible_getName
 109 Accessible_getDescription
 110 Accessible_getParent
 111 Accessible_getChildCount
 112 Accessible_getChildAtIndex
 113 Accessible_getIndexInParent
 114 Accessible_getRelationSet
 115 Accessible_getRole
 116 Accessible_getRoleName
 117 Accessible_getStateSet
 118 Accessible_getAttributes
 119 Accessible_getHostApplication
 120 Accessible_getLocalizedRoleName
 121 <SUBSECTION Interface Queries>
 122 Accessible_isAction
 123 Accessible_isApplication
 124 Accessible_isComponent
 125 Accessible_isEditableText
 126 Accessible_isHypertext
 127 Accessible_isImage
 128 Accessible_isSelection
 129 Accessible_isStreamableContent
 130 Accessible_isTable
 131 Accessible_isText
 132 Accessible_isValue
 133 Accessible_getAction
 134 Accessible_getApplication
 135 Accessible_getComponent
 136 Accessible_getEditableText
 137 Accessible_getHypertext
 138 Accessible_getImage
 139 Accessible_getSelection
 140 Accessible_getStreamableContent
 141 Accessible_getTable
 142 Accessible_getText
 143 Accessible_getValue
 144 Accessible_queryInterface
 145 <SUBSECTION Auxiliary types>
 146 AccessibleRole
 147 AccessibleRole_getName
 148 <SUBSECTION Private>
 149 InternalEvent
 150 SPI_INTERNAL_EVENT_MAGIC
 151 CSPI_OBJREF
 152 cspi_ev
 153 cspi_exception
 154 cspi_registry
 155 cspi_object_add
 156 cspi_object_ref
 157 cspi_object_unref
 158 cspi_object_borrow
 159 cspi_object_take
 160 cspi_object_return
 161 cspi_accessible_is_a
 162 cspi_return_if_fail
 163 cspi_return_val_if_fail
 164 cspi_return_if_ev
 165 cspi_return_val_if_ev
 166 cspi_check_ev
 167 cspi_dup_ref
 168 cspi_release_unref
 169 cspi_exception_get_text
 170 cspi_init
 171 cspi_ping
 172 cspi_main
 173 cspi_main_quit
 174 cspi_event_listener_get_type
 175 cspi_event_listener_new
 176 cspi_event_listener_get_corba
 177 cspi_event_listener_add_cb
 178 cspi_event_listener_remove_cb
 179 cspi_event_listener_unref
 180 cspi_keystroke_listener_new
 181 cspi_keystroke_listener_unref
 182 cspi_keystroke_listener_get_corba
 183 cspi_keystroke_listener_add_cb
 184 cspi_keystroke_listener_remove_cb
 185 cspi_device_listener_get_type
 186 cspi_device_listener_new
 187 cspi_device_listener_add_cb
 188 cspi_device_listener_remove_cb
 189 cspi_device_listener_unref
 190 CSpiEventListener
 191 CSpiEventListenerClass
 192 CSPI_EVENT_LISTENER_TYPE
 193 CSPI_EVENT_LISTENER
 194 CSPI_EVENT_LISTENER_CLASS
 195 CSPI_IS_EVENT_LISTENER
 196 CSPI_IS_EVENT_LISTENER_CLASS
 197 CSpiDeviceListener
 198 CSpiDeviceListenerClass
 199 CSPI_DEVICE_LISTENER_TYPE
 200 CSPI_DEVICE_LISTENER
 201 CSPI_DEVICE_LISTENER_CLASS
 202 CSPI_IS_DEVICE_LISTENER
 203 CSPI_IS_DEVICE_LISTENER_CLASS
 204 </SECTION>
 205
 206 <SECTION>
 207 <FILE>spi_application</FILE>
 208 <TITLE>AccessibleApplication API</TITLE>
 209 AccessibleApplication_ref
 210 AccessibleApplication_unref
 211 AccessibleApplication_getToolkitName
 212 AccessibleApplication_getVersion
 213 AccessibleApplication_getID
 214 AccessibleApplication_getLocale
 215 AccessibleApplication_pause
 216 AccessibleApplication_resume
 217 </SECTION>
 218
 219 <SECTION>
 220 <FILE>spi_action</FILE>
 221 <TITLE>AccessibleAction Interface</TITLE>
 222 AccessibleAction_ref
 223 AccessibleAction_unref
 224 AccessibleAction_getNActions
 225 AccessibleAction_doAction
 226 AccessibleAction_getKeyBinding
 227 AccessibleAction_getName
 228 AccessibleAction_getDescription
 229 </SECTION>
 230
 231 <SECTION>
 232 <FILE>spi_component</FILE>
 233 <TITLE>AccessibleComponent Interface</TITLE>
 234 AccessibleCoordType
 235 AccessibleComponentLayer
 236 AccessibleComponent_ref
 237 AccessibleComponent_unref
 238 AccessibleComponent_contains
 239 AccessibleComponent_getAccessibleAtPoint
 240 AccessibleComponent_getExtents
 241 AccessibleComponent_getPosition
 242 AccessibleComponent_getSize
 243 AccessibleComponent_getLayer
 244 AccessibleComponent_getMDIZOrder
 245 AccessibleComponent_grabFocus
 246 AccessibleComponent_getAlpha
 247 </SECTION>
 248
 249 <SECTION>
 250 <FILE>spi_editabletext</FILE>
 251 <TITLE>AccessibleEditableText Interface</TITLE>
 252 AccessibleEditableText_ref
 253 AccessibleEditableText_unref
 254 AccessibleEditableText_copyText
 255 AccessibleEditableText_deleteText
 256 AccessibleEditableText_insertText
 257 AccessibleEditableText_cutText
 258 AccessibleEditableText_pasteText
 259 AccessibleEditableText_setTextContents
 260 AccessibleEditableText_setAttributes
 261 </SECTION>
 262
 263 <SECTION>
 264 <FILE>spi_hypertext</FILE>
 265 <TITLE>AccessibleHypertext Interface</TITLE>
 266 AccessibleHypertext_ref
 267 AccessibleHypertext_unref
 268 AccessibleHypertext_getNLinks
 269 AccessibleHypertext_getLink
 270 AccessibleHypertext_getLinkIndex
 271 </SECTION>
 272
 273 <SECTION>
 274 <FILE>spi_image</FILE>
 275 <TITLE>AccessibleImage Interface</TITLE>
 276 AccessibleImage_ref
 277 AccessibleImage_unref
 278 AccessibleImage_getImageDescription
 279 AccessibleImage_getImageSize
 280 AccessibleImage_getImagePosition
 281 AccessibleImage_getImageExtents
 282 AccessibleImage_getImageLocale
 283 </SECTION>
 284
 285 <SECTION>
 286 <FILE>spi_selection</FILE>
 287 <TITLE>AccessibleSelection Interface</TITLE>
 288 AccessibleSelection_ref
 289 AccessibleSelection_unref
 290 AccessibleSelection_getNSelectedChildren
 291 AccessibleSelection_getSelectedChild
 292 AccessibleSelection_selectChild
 293 AccessibleSelection_isChildSelected
 294 AccessibleSelection_deselectSelectedChild
 295 AccessibleSelection_clearSelection
 296 AccessibleSelection_selectAll
 297 </SECTION>
 298
 299 <SECTION>
 300 <FILE>spi_streamable_content</FILE>
 301 <TITLE>AccessibleStreamableContent Interface</TITLE>
 302 AccessibleStreamableContent_ref
 303 AccessibleStreamableContent_unref
 304 AccessibleStreamableContent_getContentTypes
 305 AccessibleStreamableContent_open
 306 AccessibleStreamableContent_seek
 307 AccessibleStreamableContent_read
 308 AccessibleStreamableContent_close
 309 AccessibleStreamableContent_freeContentTypeList
 310 </SECTION>
 311
 312 <SECTION>
 313 <FILE>spi_table</FILE>
 314 <TITLE>AccessibleTable Interface</TITLE>
 315 AccessibleTable_ref
 316 AccessibleTable_unref
 317 AccessibleTable_getAccessibleAt
 318 AccessibleTable_getCaption
 319 AccessibleTable_getColumnAtIndex
 320 AccessibleTable_getColumnDescription
 321 AccessibleTable_getColumnExtentAt
 322 AccessibleTable_getColumnHeader
 323 AccessibleTable_getIndexAt
 324 AccessibleTable_getNColumns
 325 AccessibleTable_getNRows
 326 AccessibleTable_getNSelectedColumns
 327 AccessibleTable_getNSelectedRows
 328 AccessibleTable_getRowAtIndex
 329 AccessibleTable_getRowDescription
 330 AccessibleTable_getRowExtentAt
 331 AccessibleTable_getRowHeader
 332 AccessibleTable_getSelectedRows
 333 AccessibleTable_getSelectedColumns
 334 AccessibleTable_getSummary
 335 AccessibleTable_isColumnSelected
 336 AccessibleTable_isRowSelected
 337 AccessibleTable_isSelected
 338 AccessibleTable_addColumnSelection
 339 AccessibleTable_addRowSelection
 340 AccessibleTable_removeColumnSelection
 341 AccessibleTable_removeRowSelection
 342 </SECTION>
 343
 344 <SECTION>
 345 <FILE>spi_text</FILE>
 346 <TITLE>AccessibleText Interface</TITLE>
 347 AccessibleTextBoundaryType
 348 AccessibleTextClipType
 349 AccessibleText_ref
 350 AccessibleText_unref
 351 AccessibleText_addSelection
 352 AccessibleText_getAttributes
 353 AccessibleText_getBoundedRanges
 354 AccessibleText_getCaretOffset
 355 AccessibleText_getCharacterCount
 356 AccessibleText_getCharacterExtents
 357 AccessibleText_getNSelections
 358 AccessibleText_getOffsetAtPoint
 359 AccessibleText_getRangeExtents
 360 AccessibleText_getSelection
 361 AccessibleText_getText
 362 AccessibleText_getTextBeforeOffset
 363 AccessibleText_getTextAfterOffset
 364 AccessibleText_getTextAtOffset
 365 AccessibleText_removeSelection
 366 AccessibleText_setCaretOffset
 367 AccessibleText_setSelection
 368 AccessibleText_getCharacterAtOffset
 369 AccessibleText_getDefaultAttributes
 370 AccessibleTextRange_freeRanges
 371 </SECTION>
 372
 373 <SECTION>
 374 <FILE>spi_value</FILE>
 375 <TITLE>AccessibleValue Interface</TITLE>
 376 AccessibleValue_ref
 377 AccessibleValue_unref
 378 AccessibleValue_getCurrentValue
 379 AccessibleValue_getMaximumValue
 380 AccessibleValue_getMinimumValue
 381 AccessibleValue_setCurrentValue
 382 </SECTION>
 383
 384 <SECTION>
 385 <FILE>spi_hyperlink</FILE>
 386 <TITLE>AccessibleHyperlink Interface</TITLE>
 387 AccessibleHyperlink_ref
 388 AccessibleHyperlink_unref
 389 AccessibleHyperlink_getNAnchors
 390 AccessibleHyperlink_getIndexRange
 391 AccessibleHyperlink_getObject
 392 AccessibleHyperlink_getURI
 393 AccessibleHyperlink_isValid
 394 </SECTION>
 395
 396 <SECTION>
 397 <FILE>spi_stateset</FILE>
 398 <TITLE>State and StateSets</TITLE>
 399 AccessibleState
 400 AccessibleStateSet
 401 AccessibleStateSet_ref
 402 AccessibleStateSet_unref
 403 AccessibleStateSet_add
 404 AccessibleStateSet_compare
 405 AccessibleStateSet_contains
 406 AccessibleStateSet_equals
 407 AccessibleStateSet_isEmpty
 408 AccessibleStateSet_remove
 409 </SECTION>
 410
 411 <SECTION>
 412 <FILE>spi_relation</FILE>
 413 <TITLE>AccessibleRelations and RelationSets</TITLE>
 414 AccessibleRelationType
 415 AccessibleRelation_ref
 416 AccessibleRelation_unref
 417 AccessibleRelation_getNTargets
 418 AccessibleRelation_getTarget
 419 AccessibleRelation_getRelationType
 420 </SECTION>