2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
27 #include <cspi/spi-impl.h>
29 * Definitions for AccessibleRole, AccessibleState,
30 * and event listeners.
32 #include <cspi/spi-roletypes.h>
33 #include <cspi/spi-statetypes.h>
34 #include <cspi/spi-listener.h>
37 * Auxiliary typedefs and mask definitions
39 #include <libspi/keymasks.h>
46 *AccessibleTextBoundaryType:
47 *@SPI_TEXT_BOUNDARY_CHAR:
48 *@SPI_TEXT_BOUNDARY_CURSOR_POS:
49 *@SPI_TEXT_BOUNDARY_WORD_START:
50 *@SPI_TEXT_BOUNDARY_WORD_END:
51 *@SPI_TEXT_BOUNDARY_SENTENCE_START:
52 *@SPI_TEXT_BOUNDARY_SENTENCE_END:
53 *@SPI_TEXT_BOUNDARY_LINE_START:
54 *@SPI_TEXT_BOUNDARY_LINE_END:
55 *@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
57 *Text boundary types used for specifying boundaries for regions of text
61 SPI_TEXT_BOUNDARY_CHAR,
62 SPI_TEXT_BOUNDARY_CURSOR_POS,
63 SPI_TEXT_BOUNDARY_WORD_START,
64 SPI_TEXT_BOUNDARY_WORD_END,
65 SPI_TEXT_BOUNDARY_SENTENCE_START,
66 SPI_TEXT_BOUNDARY_SENTENCE_END,
67 SPI_TEXT_BOUNDARY_LINE_START,
68 SPI_TEXT_BOUNDARY_LINE_END,
69 SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE
70 } AccessibleTextBoundaryType;
73 *AccessibleTextClipType
74 *@SPI_TEXT_CLIP_NONE: No clipping to be done
75 *@SPI_TEXT_CLIP_MIN: Text clipped by min coordinate is omitted
76 *@SPI_TEXT_CLIP_MAX: Text clipped by max coordinate is omitted
77 *@SPI_TEXT_CLIP_BOTH: Only text fully within mix/max bound is retained
79 *Describes the type of clipping required.
87 } AccessibleTextClipType;
90 *AccessibleRelationType:
92 *@SPI_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
93 *@SPI_RELATION_LABELED_BY: Indicates an object is labelled by one or more target objects.
94 *@SPI_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
95 *@SPI_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
96 *@SPI_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or
98 *@SPI_RELATION_NODE_CHILD_OF: Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
99 *@SPI_RELATION_EXTENDED:
100 *@SPI_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
101 * AtkObject in a sequential way, (for instance text-flow).
102 *@SPI_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
103 * another AtkObject in a sequential way, (for instance text-flow).
104 *@SPI_RELATION_SUBWINDOW_OF:
105 *@SPI_RELATION_EMBEDS: Indicates that the object visually embeds
106 * another object's content, i.e. this object's content flows around
108 *@SPI_RELATION_EMBEDDED_BY: Inverse of %SPI_RELATION_EMBEDS, indicates that
109 * this object's content is visualy embedded in another object.
110 *@SPI_RELATION_POPUP_FOR: Indicates that an object is a popup for another objec
112 *@SPI_RELATION_LAST_DEFINED:
114 *Describes the type of the relation
119 SPI_RELATION_LABEL_FOR,
120 SPI_RELATION_LABELED_BY,
121 SPI_RELATION_CONTROLLER_FOR,
122 SPI_RELATION_CONTROLLED_BY,
123 SPI_RELATION_MEMBER_OF,
124 SPI_RELATION_NODE_CHILD_OF,
125 SPI_RELATION_EXTENDED,
126 SPI_RELATION_FLOWS_TO,
127 SPI_RELATION_FLOWS_FROM,
128 SPI_RELATION_SUBWINDOW_OF,
130 SPI_RELATION_EMBEDDED_BY,
131 SPI_RELATION_POPUP_FOR,
132 SPI_RELATION_LAST_DEFINED
133 } AccessibleRelationType;
136 /* don't change the order of these ! */
138 *AccessibleCoordType:
139 *@SPI_COORD_TYPE_SCREEN: specifies xy coordinates relative to the screen
140 *@SPI_COORD_TYPE_WINDOW: specifies xy coordinates relative to an object's
143 *Specifies how xy coordinates are to be interpreted. Used by functions such
144 *as AccessibleComponent_getPosition() and AccessibleText_getCharacterExtents()
147 SPI_COORD_TYPE_SCREEN,
148 SPI_COORD_TYPE_WINDOW
149 } AccessibleCoordType;
152 *AccessibleKeySynthType:
155 *@SPI_KEY_PRESSRELEASE:
159 *Specified the type of a generated event.
164 SPI_KEY_PRESSRELEASE,
167 } AccessibleKeySynthType;
170 *AccessibleKeyListenerSyncType:
171 *@SPI_KEYLISTENER_NOSYNC:
172 *@SPI_KEYLISTENER_SYNCHRONOUS:
173 *@SPI_KEYLISTENER_CANCONSUME:
174 *@SPI_KEYLISTENER_ALL_WINDOWS:
176 *Specified the tyupe of a key listener event.
179 SPI_KEYLISTENER_NOSYNC = 0,
180 SPI_KEYLISTENER_SYNCHRONOUS = 1,
181 SPI_KEYLISTENER_CANCONSUME = 2,
182 SPI_KEYLISTENER_ALL_WINDOWS = 4
183 } AccessibleKeyListenerSyncType;
187 *AccessibleStreamableContentSeekType
188 *@SPI_STREAM_SEEK_SET: seek from the 'top' of the streamable
189 *@SPI_STREAM_SEEK_CUR: seek from the current position in the stream
190 *@SPI_STREAM_SEEK_END: seek from the end of the stream (if known)
192 *The seek type for a specified offset in AccessibleStreamableContent_seek.
199 } AccessibleStreamableContentSeekType;
201 typedef struct _SPIException SPIException;
204 (* SPIExceptionHandler) (SPIException *err, SPIBoolean is_fatal);
207 SPI_EXCEPTION_UNSPECIFIED,
208 SPI_EXCEPTION_DISCONNECT,
209 SPI_EXCEPTION_NO_IMPL,
211 SPI_EXCEPTION_BAD_DATA
215 SPI_EXCEPTION_SOURCE_UNSPECIFIED,
216 SPI_EXCEPTION_SOURCE_ACCESSIBLE,
217 SPI_EXCEPTION_SOURCE_REGISTRY,
218 SPI_EXCEPTION_SOURCE_DEVICE
221 typedef unsigned long AccessibleKeyEventMask;
222 typedef unsigned long AccessibleDeviceEventMask;
225 *AccessibleComponentLayer:
226 *@SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
227 *@SPI_LAYER_BACKGROUND: Component belongs to the destop background.
228 *@SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
229 *@SPI_LAYER_WIDGET: Component is a 'normal' widget.
230 *@SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
231 * Z-information relative to other MDI-layer components.
232 *@SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
234 *@SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
236 *@SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
237 * relative to other window-layer components.
238 *@SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
239 * should not be encountered.
241 * Describes the layer of a component.
243 * These enumerated "layer values" are used when determining which UI
244 * rendering layer a component is drawn into, which can help in making
245 * determinations of when components occlude one another.
249 SPI_LAYER_BACKGROUND,
256 SPI_LAYER_LAST_DEFINED
257 } AccessibleComponentLayer;
261 * AccessibleTextRange:
262 * @start: the first nominal character position within the range.
263 * @end: the first nominal character position following the range.
264 * @content: The actual text content between @start and @end, as a UTF-8 string.
266 * Structure which encapsulates a text range - must be associated with an
267 * AccessibleText-implementing object.
269 typedef struct _AccessibleTextRange
274 } AccessibleTextRange;
282 * Structure containing identifying information about a set of keycode or
285 typedef struct _AccessibleKeySet
287 unsigned long *keysyms;
288 unsigned short *keycodes;
294 * A special value for an AccessibleKeySet type, which tacitly
295 * includes all keycodes and keyvals for the specified modifier set.
297 #define SPI_KEYSET_ALL_KEYS NULL
299 typedef unsigned long AccessibleModifierMaskType;
301 *AccessibleKeyMaskType:
303 *AccessibleKeyMaskType is a mask which is a set of key event modifiers
304 *which is specified in SPI_registerAccessibleKeystrokeListener.
307 typedef AccessibleModifierMaskType AccessibleKeyMaskType;
309 /* Basic SPI initialization and event loop function prototypes */
312 void SPI_event_main (void);
313 void SPI_event_quit (void);
314 SPIBoolean SPI_eventIsReady (void);
315 AccessibleEvent *SPI_nextEvent (SPIBoolean waitForEvent);
318 /* Event Listener creation and support. */
320 void SPI_freeAccessibleKeySet (
321 AccessibleKeySet *keyset);
322 AccessibleKeySet * SPI_createAccessibleKeySet (
326 const char **keystrings);
327 AccessibleEventListener * SPI_createAccessibleEventListener (
328 AccessibleEventListenerCB callback,
330 SPIBoolean AccessibleEventListener_addCallback (
331 AccessibleEventListener *listener,
332 AccessibleEventListenerCB callback,
334 SPIBoolean AccessibleEventListener_removeCallback (
335 AccessibleEventListener *listener,
336 AccessibleEventListenerCB callback);
337 void AccessibleEventListener_unref (
338 AccessibleEventListener *listener);
340 /* Device Event Listener creation and support. */
342 /* First four are deprecated in favor of the last four; really just a re-name */
344 AccessibleKeystrokeListener * SPI_createAccessibleKeystrokeListener (
345 AccessibleKeystrokeListenerCB callback,
347 SPIBoolean AccessibleKeystrokeListener_addCallback (
348 AccessibleKeystrokeListener *listener,
349 AccessibleKeystrokeListenerCB callback,
351 SPIBoolean AccessibleKeystrokeListener_removeCallback (
352 AccessibleKeystrokeListener *listener,
353 AccessibleKeystrokeListenerCB callback);
354 void AccessibleKeystrokeListener_unref (
355 AccessibleKeystrokeListener *listener);
357 AccessibleDeviceListener * SPI_createAccessibleDeviceListener (
358 AccessibleDeviceListenerCB callback,
360 SPIBoolean AccessibleDeviceListener_addCallback (
361 AccessibleDeviceListener *listener,
362 AccessibleDeviceListenerCB callback,
364 SPIBoolean AccessibleDeviceListener_removeCallback (
365 AccessibleDeviceListener *listener,
366 AccessibleDeviceListenerCB callback);
367 void AccessibleDeviceListener_unref (
368 AccessibleDeviceListener *listener);
370 /* Global functions serviced by the registry */
372 SPIBoolean SPI_registerGlobalEventListener (
373 AccessibleEventListener *listener,
374 const char *eventType);
375 SPIBoolean SPI_deregisterGlobalEventListener (
376 AccessibleEventListener *listener,
377 const char *eventType);
378 SPIBoolean SPI_deregisterGlobalEventListenerAll (
379 AccessibleEventListener *listener);
380 SPIBoolean SPI_registerAccessibleKeystrokeListener (
381 AccessibleKeystrokeListener *listener,
382 AccessibleKeySet *keys,
383 AccessibleKeyMaskType modmask,
384 AccessibleKeyEventMask eventmask,
385 AccessibleKeyListenerSyncType sync_type);
386 SPIBoolean SPI_deregisterAccessibleKeystrokeListener (
387 AccessibleKeystrokeListener *listener,
388 AccessibleKeyMaskType modmask);
390 SPIBoolean SPI_registerDeviceEventListener (
391 AccessibleDeviceListener *listener,
392 AccessibleDeviceEventMask eventmask,
394 SPIBoolean SPI_deregisterDeviceEventListener (
395 AccessibleDeviceListener *listener,
398 int SPI_getDesktopCount (void);
399 Accessible *SPI_getDesktop (int i);
400 int SPI_getDesktopList (Accessible ***desktop_list);
401 void SPI_freeDesktopList (Accessible **desktop_list);
403 SPIBoolean SPI_generateKeyboardEvent (long int keyval,
405 AccessibleKeySynthType synth_type);
407 SPIBoolean SPI_generateMouseEvent (long int x, long int y, char *name);
409 /* Accessible function prototypes */
411 void Accessible_ref (Accessible *obj);
412 void Accessible_unref (Accessible *obj);
413 char * Accessible_getName (Accessible *obj);
414 char * Accessible_getDescription (Accessible *obj);
415 Accessible * Accessible_getParent (Accessible *obj);
416 long Accessible_getChildCount (Accessible *obj);
417 Accessible * Accessible_getChildAtIndex (Accessible *obj,
418 long int childIndex);
419 long Accessible_getIndexInParent (Accessible *obj);
420 AccessibleRelation **Accessible_getRelationSet (Accessible *obj);
421 AccessibleRole Accessible_getRole (Accessible *obj);
422 char * Accessible_getRoleName (Accessible *obj);
423 char * Accessible_getLocalizedRoleName (Accessible *obj);
424 AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
426 /* Interface query methods */
428 SPIBoolean Accessible_isAction (Accessible *obj);
429 SPIBoolean Accessible_isApplication (Accessible *obj);
430 SPIBoolean Accessible_isComponent (Accessible *obj);
431 SPIBoolean Accessible_isEditableText (Accessible *obj);
432 SPIBoolean Accessible_isHypertext (Accessible *obj);
433 SPIBoolean Accessible_isImage (Accessible *obj);
434 SPIBoolean Accessible_isSelection (Accessible *obj);
435 SPIBoolean Accessible_isStreamableContent (Accessible *obj);
436 SPIBoolean Accessible_isTable (Accessible *obj);
437 SPIBoolean Accessible_isText (Accessible *obj);
438 SPIBoolean Accessible_isValue (Accessible *obj);
440 AccessibleAction * Accessible_getAction (Accessible *obj);
441 AccessibleApplication * Accessible_getApplication (Accessible *obj);
442 AccessibleComponent * Accessible_getComponent (Accessible *obj);
443 AccessibleEditableText * Accessible_getEditableText (Accessible *obj);
444 AccessibleHypertext * Accessible_getHypertext (Accessible *obj);
445 AccessibleImage * Accessible_getImage (Accessible *obj);
446 AccessibleSelection * Accessible_getSelection (Accessible *obj);
447 AccessibleStreamableContent * Accessible_getStreamableContent (Accessible *obj);
448 AccessibleTable * Accessible_getTable (Accessible *obj);
449 AccessibleText * Accessible_getText (Accessible *obj);
450 AccessibleValue * Accessible_getValue (Accessible *obj);
451 AccessibleUnknown * Accessible_queryInterface (Accessible *obj,
452 const char *interface_name);
454 /* AccessibleAction function prototypes */
456 void AccessibleAction_ref (AccessibleAction *obj);
457 void AccessibleAction_unref (AccessibleAction *obj);
458 long AccessibleAction_getNActions (AccessibleAction *obj);
459 char *AccessibleAction_getName (AccessibleAction *obj,
461 char *AccessibleAction_getDescription (AccessibleAction *obj,
463 SPIBoolean AccessibleAction_doAction (AccessibleAction *obj,
465 char *AccessibleAction_getKeyBinding (AccessibleAction *obj,
468 /* AccessibleApplication function prototypes */
470 void AccessibleApplication_ref (AccessibleApplication *obj);
471 void AccessibleApplication_unref (AccessibleApplication *obj);
472 char *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
473 char *AccessibleApplication_getVersion (AccessibleApplication *obj);
474 long AccessibleApplication_getID (AccessibleApplication *obj);
475 char *AccessibleApplication_getLocale (AccessibleApplication *obj, int lc_category);
476 SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj);
477 SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj);
479 /* AccessibleComponent function prototypes */
481 void AccessibleComponent_ref (AccessibleComponent *obj);
482 void AccessibleComponent_unref (AccessibleComponent *obj);
483 SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj,
486 AccessibleCoordType ctype);
487 Accessible *AccessibleComponent_getAccessibleAtPoint (
488 AccessibleComponent *obj,
491 AccessibleCoordType ctype);
492 void AccessibleComponent_getExtents (AccessibleComponent *obj,
497 AccessibleCoordType ctype);
498 void AccessibleComponent_getPosition (AccessibleComponent *obj,
501 AccessibleCoordType ctype);
502 void AccessibleComponent_getSize (AccessibleComponent *obj,
505 AccessibleComponentLayer
506 AccessibleComponent_getLayer (AccessibleComponent *obj);
507 SPIBoolean AccessibleComponent_grabFocus (AccessibleComponent *obj);
508 short AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
510 /* AccessibleEditableText function prototypes */
513 AccessibleEditableText_ref (AccessibleEditableText *obj);
516 AccessibleEditableText_unref (AccessibleEditableText *obj);
519 AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
520 const char *attributes,
521 long int startOffset,
525 AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
526 const char *newContents);
529 AccessibleEditableText_insertText (AccessibleEditableText *obj,
535 AccessibleEditableText_copyText (AccessibleText *obj,
540 AccessibleEditableText_cutText (AccessibleEditableText *obj,
545 AccessibleEditableText_deleteText (AccessibleEditableText *obj,
550 AccessibleEditableText_pasteText (AccessibleEditableText *obj,
555 * AccessibleHyperlink function prototypes
559 AccessibleHyperlink_ref (AccessibleHyperlink *obj);
561 AccessibleHyperlink_unref (AccessibleHyperlink *obj);
564 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
567 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
571 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
575 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
576 long int *startIndex,
580 AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
584 * AccessibleHypertext function prototypes
589 AccessibleHypertext_ref (AccessibleHypertext *obj);
592 AccessibleHypertext_unref (AccessibleHypertext *obj);
595 AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
597 AccessibleHyperlink *
598 AccessibleHypertext_getLink (AccessibleHypertext *obj,
602 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
603 long int characterOffset);
607 * AccessibleImage function prototypes
612 AccessibleImage_ref (AccessibleImage *obj);
615 AccessibleImage_unref (AccessibleImage *obj);
618 AccessibleImage_getImageDescription (AccessibleImage *obj);
621 AccessibleImage_getImageSize (AccessibleImage *obj,
626 AccessibleImage_getImagePosition (AccessibleImage *obj,
629 AccessibleCoordType ctype);
632 AccessibleImage_getImageExtents (AccessibleImage *obj,
637 AccessibleCoordType ctype);
640 * AccessibleRelation function prototypes
644 void AccessibleRelation_ref (AccessibleRelation *obj);
645 void AccessibleRelation_unref (AccessibleRelation *obj);
647 AccessibleRelationType
648 AccessibleRelation_getRelationType (AccessibleRelation *obj);
651 AccessibleRelation_getNTargets (AccessibleRelation *obj);
654 AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
659 * AccessibleSelection function prototypes
663 void AccessibleSelection_ref (AccessibleSelection *obj);
664 void AccessibleSelection_unref (AccessibleSelection *obj);
667 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
670 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
671 long int selectedChildIndex);
674 AccessibleSelection_selectChild (AccessibleSelection *obj,
675 long int childIndex);
678 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
679 long int selectedChildIndex);
682 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
683 long int childIndex);
686 AccessibleSelection_selectAll (AccessibleSelection *obj);
689 AccessibleSelection_clearSelection (AccessibleSelection *obj);
694 * AccessibleStateSet function prototypes
698 void AccessibleStateSet_ref (AccessibleStateSet *obj);
699 void AccessibleStateSet_unref (AccessibleStateSet *obj);
702 AccessibleStateSet_contains (AccessibleStateSet *obj,
703 AccessibleState state);
706 AccessibleStateSet_add (AccessibleStateSet *obj,
707 AccessibleState state);
710 AccessibleStateSet_remove (AccessibleStateSet *obj,
711 AccessibleState state);
714 AccessibleStateSet_equals (AccessibleStateSet *obj,
715 AccessibleStateSet *obj2);
718 AccessibleStateSet_compare (AccessibleStateSet *obj,
719 AccessibleStateSet *obj2);
722 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
725 AccessibleStreamableContent_ref (AccessibleStreamableContent *obj);
727 AccessibleStreamableContent_unref (AccessibleStreamableContent *obj);
729 AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj);
731 AccessibleStreamableContent_freeContentTypeList (AccessibleStreamableContent *obj,
734 AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
735 const char *content_type);
737 AccessibleStreamableContent_close (AccessibleStreamableContent *obj);
740 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
742 AccessibleStreamableContentSeekType seek_type);
744 AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
747 unsigned int read_type);
750 * AccessibleTable function prototypes
754 void AccessibleTable_ref (AccessibleTable *obj);
755 void AccessibleTable_unref (AccessibleTable *obj);
758 AccessibleTable_getCaption (AccessibleTable *obj);
761 AccessibleTable_getSummary (AccessibleTable *obj);
764 AccessibleTable_getNRows (AccessibleTable *obj);
767 AccessibleTable_getNColumns (AccessibleTable *obj);
770 AccessibleTable_getAccessibleAt (AccessibleTable *obj,
775 AccessibleTable_getIndexAt (AccessibleTable *obj,
780 AccessibleTable_getRowAtIndex (AccessibleTable *obj,
784 AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
788 AccessibleTable_getRowDescription (AccessibleTable *obj,
792 AccessibleTable_getColumnDescription (AccessibleTable *obj,
796 AccessibleTable_getRowExtentAt (AccessibleTable *obj,
801 AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
806 AccessibleTable_getRowHeader (AccessibleTable *obj,
810 AccessibleTable_getColumnHeader (AccessibleTable *obj,
814 AccessibleTable_getNSelectedRows (AccessibleTable *obj);
817 AccessibleTable_getSelectedRows (AccessibleTable *obj,
818 long int **selectedRows);
821 AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
824 AccessibleTable_getSelectedColumns (AccessibleTable *obj,
825 long int **selectedColumns);
828 AccessibleTable_isRowSelected (AccessibleTable *obj,
832 AccessibleTable_isColumnSelected (AccessibleTable *obj,
836 AccessibleTable_isSelected (AccessibleTable *obj,
841 AccessibleTable_addRowSelection (AccessibleTable *obj,
844 AccessibleTable_addColumnSelection (AccessibleTable *obj,
848 AccessibleTable_removeRowSelection (AccessibleTable *obj,
851 AccessibleTable_removeColumnSelection (AccessibleTable *obj,
856 * AccessibleText function prototypes
860 void AccessibleText_ref (AccessibleText *obj);
861 void AccessibleText_unref (AccessibleText *obj);
864 AccessibleText_getCharacterCount (AccessibleText *obj);
867 AccessibleText_getText (AccessibleText *obj,
868 long int startOffset,
872 AccessibleText_getCaretOffset (AccessibleText *obj);
875 AccessibleText_getAttributes (AccessibleText *obj,
877 long int *startOffset,
878 long int *endOffset);
881 AccessibleText_getDefaultAttributes (AccessibleText *obj);
884 AccessibleText_setCaretOffset (AccessibleText *obj,
888 AccessibleText_getTextBeforeOffset (AccessibleText *obj,
890 AccessibleTextBoundaryType type,
891 long int *startOffset,
892 long int *endOffset);
895 AccessibleText_getTextAtOffset (AccessibleText *obj,
897 AccessibleTextBoundaryType type,
898 long int *startOffset,
899 long int *endOffset);
902 AccessibleText_getTextAfterOffset (AccessibleText *obj,
904 AccessibleTextBoundaryType type,
905 long int *startOffset,
906 long int *endOffset);
909 AccessibleText_getCharacterAtOffset (AccessibleText *obj,
913 AccessibleText_getCharacterExtents (AccessibleText *obj,
919 AccessibleCoordType type);
922 AccessibleText_getRangeExtents (AccessibleText *obj,
923 long int startOffset,
929 AccessibleCoordType type);
931 AccessibleTextRange **
932 AccessibleText_getBoundedRanges (AccessibleText *obj,
937 AccessibleCoordType type,
938 AccessibleTextClipType clipTypeX,
939 AccessibleTextClipType clipTypeY);
942 AccessibleTextRange_freeRanges (AccessibleTextRange **ranges);
945 AccessibleText_getOffsetAtPoint (AccessibleText *obj,
948 AccessibleCoordType type);
951 AccessibleText_getNSelections (AccessibleText *obj);
954 AccessibleText_getSelection (AccessibleText *obj,
955 long int selectionNum,
956 long int *startOffset,
957 long int *endOffset);
961 AccessibleText_addSelection (AccessibleText *obj,
962 long int startOffset,
966 AccessibleText_removeSelection (AccessibleText *obj,
967 long int selectionNum);
970 AccessibleText_setSelection (AccessibleText *obj,
971 long int selectionNum,
972 long int startOffset,
975 /* AccessibleValue Function Prototypes: */
977 void AccessibleValue_ref (AccessibleValue *obj);
978 void AccessibleValue_unref (AccessibleValue *obj);
979 double AccessibleValue_getMinimumValue (AccessibleValue *obj);
980 double AccessibleValue_getCurrentValue (AccessibleValue *obj);
981 double AccessibleValue_getMaximumValue (AccessibleValue *obj);
982 SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
985 /* Persistance and lifecycle control for AccessibleEvents. */
986 SPIBoolean AccessibleEvent_ref (const AccessibleEvent *e);
987 void AccessibleEvent_unref (const AccessibleEvent *e);
990 * Prototypes for accessor functions, to obtain context
991 * information for accessible events.
994 char* AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e);
995 Accessible * AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e);
997 Accessible * AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e);
999 char* AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e);
1001 char* AccessibleWindowEvent_getTitleString (const AccessibleEvent *e);
1003 Accessible * AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e);
1005 Accessible * AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e);
1007 Accessible * AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e);
1009 char * AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e);
1011 char * AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1013 char * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1015 char * AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1017 char * AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e);
1019 /* Misc methods and error handling */
1020 void SPI_freeString (char *s);
1022 char* SPI_dupString (char *s);
1024 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler);
1026 SPIExceptionHandler* SPI_exceptionHandlerPop (void);
1028 SPIExceptionType SPIException_getSourceType (SPIException *err);
1030 SPIExceptionCode SPIException_getExceptionCode (SPIException *err);
1032 Accessible* SPIAccessibleException_getSource (SPIException *err);
1034 char* SPIException_getDescription (SPIException *err);