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: Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.
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;
232 *AccessibleComponentLayer:
233 *@SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
234 *@SPI_LAYER_BACKGROUND: Component belongs to the destop background.
235 *@SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
236 *@SPI_LAYER_WIDGET: Component is a 'normal' widget.
237 *@SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
238 * Z-information relative to other MDI-layer components.
239 *@SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
241 *@SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
243 *@SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
244 * relative to other window-layer components.
245 *@SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
246 * should not be encountered.
248 * Describes the layer of a component.
250 * These enumerated "layer values" are used when determining which UI
251 * rendering layer a component is drawn into, which can help in making
252 * determinations of when components occlude one another.
256 SPI_LAYER_BACKGROUND,
263 SPI_LAYER_LAST_DEFINED
264 } AccessibleComponentLayer;
268 * AccessibleTextRange:
269 * @start: the first nominal character position within the range.
270 * @end: the first nominal character position following the range.
271 * @content: The actual text content between @start and @end, as a UTF-8 string.
273 * Structure which encapsulates a text range - must be associated with an
274 * AccessibleText-implementing object.
276 typedef struct _AccessibleTextRange
281 } AccessibleTextRange;
289 * Structure containing identifying information about a set of keycode or
292 typedef struct _AccessibleKeySet
294 unsigned long *keysyms;
295 unsigned short *keycodes;
301 * A special value for an AccessibleKeySet type, which tacitly
302 * includes all keycodes and keyvals for the specified modifier set.
304 #define SPI_KEYSET_ALL_KEYS NULL
306 typedef unsigned long AccessibleModifierMaskType;
308 *AccessibleKeyMaskType:
310 *AccessibleKeyMaskType is a mask which is a set of key event modifiers
311 *which is specified in SPI_registerAccessibleKeystrokeListener.
314 typedef AccessibleModifierMaskType AccessibleKeyMaskType;
316 /* Basic SPI initialization and event loop function prototypes */
319 void SPI_event_main (void);
320 void SPI_event_quit (void);
321 SPIBoolean SPI_eventIsReady (void);
322 AccessibleEvent *SPI_nextEvent (SPIBoolean waitForEvent);
325 /* Event Listener creation and support. */
327 void SPI_freeAccessibleKeySet (
328 AccessibleKeySet *keyset);
329 AccessibleKeySet * SPI_createAccessibleKeySet (
333 const char **keystrings);
334 AccessibleEventListener * SPI_createAccessibleEventListener (
335 AccessibleEventListenerCB callback,
337 SPIBoolean AccessibleEventListener_addCallback (
338 AccessibleEventListener *listener,
339 AccessibleEventListenerCB callback,
341 SPIBoolean AccessibleEventListener_removeCallback (
342 AccessibleEventListener *listener,
343 AccessibleEventListenerCB callback);
344 void AccessibleEventListener_unref (
345 AccessibleEventListener *listener);
347 /* Device Event Listener creation and support. */
349 /* First four are deprecated in favor of the last four; really just a re-name */
351 AccessibleKeystrokeListener * SPI_createAccessibleKeystrokeListener (
352 AccessibleKeystrokeListenerCB callback,
354 SPIBoolean AccessibleKeystrokeListener_addCallback (
355 AccessibleKeystrokeListener *listener,
356 AccessibleKeystrokeListenerCB callback,
358 SPIBoolean AccessibleKeystrokeListener_removeCallback (
359 AccessibleKeystrokeListener *listener,
360 AccessibleKeystrokeListenerCB callback);
361 void AccessibleKeystrokeListener_unref (
362 AccessibleKeystrokeListener *listener);
364 AccessibleDeviceListener * SPI_createAccessibleDeviceListener (
365 AccessibleDeviceListenerCB callback,
367 SPIBoolean AccessibleDeviceListener_addCallback (
368 AccessibleDeviceListener *listener,
369 AccessibleDeviceListenerCB callback,
371 SPIBoolean AccessibleDeviceListener_removeCallback (
372 AccessibleDeviceListener *listener,
373 AccessibleDeviceListenerCB callback);
374 void AccessibleDeviceListener_unref (
375 AccessibleDeviceListener *listener);
377 /* Global functions serviced by the registry */
379 SPIBoolean SPI_registerGlobalEventListener (
380 AccessibleEventListener *listener,
381 const char *eventType);
382 SPIBoolean SPI_deregisterGlobalEventListener (
383 AccessibleEventListener *listener,
384 const char *eventType);
385 SPIBoolean SPI_deregisterGlobalEventListenerAll (
386 AccessibleEventListener *listener);
387 SPIBoolean SPI_registerAccessibleKeystrokeListener (
388 AccessibleKeystrokeListener *listener,
389 AccessibleKeySet *keys,
390 AccessibleKeyMaskType modmask,
391 AccessibleKeyEventMask eventmask,
392 AccessibleKeyListenerSyncType sync_type);
393 SPIBoolean SPI_deregisterAccessibleKeystrokeListener (
394 AccessibleKeystrokeListener *listener,
395 AccessibleKeyMaskType modmask);
397 SPIBoolean SPI_registerDeviceEventListener (
398 AccessibleDeviceListener *listener,
399 AccessibleDeviceEventMask eventmask,
401 SPIBoolean SPI_deregisterDeviceEventListener (
402 AccessibleDeviceListener *listener,
405 int SPI_getDesktopCount (void);
406 Accessible *SPI_getDesktop (int i);
407 int SPI_getDesktopList (Accessible ***desktop_list);
408 void SPI_freeDesktopList (Accessible **desktop_list);
410 SPIBoolean SPI_generateKeyboardEvent (long int keyval,
412 AccessibleKeySynthType synth_type);
414 SPIBoolean SPI_generateMouseEvent (long int x, long int y, char *name);
416 /* Accessible function prototypes */
418 void Accessible_ref (Accessible *obj);
419 void Accessible_unref (Accessible *obj);
420 char * Accessible_getName (Accessible *obj);
421 char * Accessible_getDescription (Accessible *obj);
422 Accessible * Accessible_getParent (Accessible *obj);
423 long Accessible_getChildCount (Accessible *obj);
424 Accessible * Accessible_getChildAtIndex (Accessible *obj,
425 long int childIndex);
426 long Accessible_getIndexInParent (Accessible *obj);
427 AccessibleRelation **Accessible_getRelationSet (Accessible *obj);
428 AccessibleRole Accessible_getRole (Accessible *obj);
429 char * Accessible_getRoleName (Accessible *obj);
430 char * Accessible_getLocalizedRoleName (Accessible *obj);
431 AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
433 /* Interface query methods */
435 SPIBoolean Accessible_isAction (Accessible *obj);
436 SPIBoolean Accessible_isApplication (Accessible *obj);
437 SPIBoolean Accessible_isComponent (Accessible *obj);
438 SPIBoolean Accessible_isEditableText (Accessible *obj);
439 SPIBoolean Accessible_isHypertext (Accessible *obj);
440 SPIBoolean Accessible_isImage (Accessible *obj);
441 SPIBoolean Accessible_isSelection (Accessible *obj);
442 SPIBoolean Accessible_isStreamableContent (Accessible *obj);
443 SPIBoolean Accessible_isTable (Accessible *obj);
444 SPIBoolean Accessible_isText (Accessible *obj);
445 SPIBoolean Accessible_isValue (Accessible *obj);
447 AccessibleAction * Accessible_getAction (Accessible *obj);
448 AccessibleApplication * Accessible_getApplication (Accessible *obj);
449 AccessibleComponent * Accessible_getComponent (Accessible *obj);
450 AccessibleEditableText * Accessible_getEditableText (Accessible *obj);
451 AccessibleHypertext * Accessible_getHypertext (Accessible *obj);
452 AccessibleImage * Accessible_getImage (Accessible *obj);
453 AccessibleSelection * Accessible_getSelection (Accessible *obj);
454 AccessibleStreamableContent * Accessible_getStreamableContent (Accessible *obj);
455 AccessibleTable * Accessible_getTable (Accessible *obj);
456 AccessibleText * Accessible_getText (Accessible *obj);
457 AccessibleValue * Accessible_getValue (Accessible *obj);
458 AccessibleUnknown * Accessible_queryInterface (Accessible *obj,
459 const char *interface_name);
461 /* AccessibleAction function prototypes */
463 void AccessibleAction_ref (AccessibleAction *obj);
464 void AccessibleAction_unref (AccessibleAction *obj);
465 long AccessibleAction_getNActions (AccessibleAction *obj);
466 char *AccessibleAction_getName (AccessibleAction *obj,
468 char *AccessibleAction_getDescription (AccessibleAction *obj,
470 SPIBoolean AccessibleAction_doAction (AccessibleAction *obj,
472 char *AccessibleAction_getKeyBinding (AccessibleAction *obj,
475 /* AccessibleApplication function prototypes */
477 void AccessibleApplication_ref (AccessibleApplication *obj);
478 void AccessibleApplication_unref (AccessibleApplication *obj);
479 char *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
480 char *AccessibleApplication_getVersion (AccessibleApplication *obj);
481 long AccessibleApplication_getID (AccessibleApplication *obj);
482 char *AccessibleApplication_getLocale (AccessibleApplication *obj, int lc_category);
483 SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj);
484 SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj);
486 /* AccessibleComponent function prototypes */
488 void AccessibleComponent_ref (AccessibleComponent *obj);
489 void AccessibleComponent_unref (AccessibleComponent *obj);
490 SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj,
493 AccessibleCoordType ctype);
494 Accessible *AccessibleComponent_getAccessibleAtPoint (
495 AccessibleComponent *obj,
498 AccessibleCoordType ctype);
499 void AccessibleComponent_getExtents (AccessibleComponent *obj,
504 AccessibleCoordType ctype);
505 void AccessibleComponent_getPosition (AccessibleComponent *obj,
508 AccessibleCoordType ctype);
509 void AccessibleComponent_getSize (AccessibleComponent *obj,
512 AccessibleComponentLayer
513 AccessibleComponent_getLayer (AccessibleComponent *obj);
514 SPIBoolean AccessibleComponent_grabFocus (AccessibleComponent *obj);
515 short AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
517 /* AccessibleEditableText function prototypes */
520 AccessibleEditableText_ref (AccessibleEditableText *obj);
523 AccessibleEditableText_unref (AccessibleEditableText *obj);
526 AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
527 const char *attributes,
528 long int startOffset,
532 AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
533 const char *newContents);
536 AccessibleEditableText_insertText (AccessibleEditableText *obj,
542 AccessibleEditableText_copyText (AccessibleText *obj,
547 AccessibleEditableText_cutText (AccessibleEditableText *obj,
552 AccessibleEditableText_deleteText (AccessibleEditableText *obj,
557 AccessibleEditableText_pasteText (AccessibleEditableText *obj,
562 * AccessibleHyperlink function prototypes
566 AccessibleHyperlink_ref (AccessibleHyperlink *obj);
568 AccessibleHyperlink_unref (AccessibleHyperlink *obj);
571 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
574 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
578 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
582 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
583 long int *startIndex,
587 AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
591 * AccessibleHypertext function prototypes
596 AccessibleHypertext_ref (AccessibleHypertext *obj);
599 AccessibleHypertext_unref (AccessibleHypertext *obj);
602 AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
604 AccessibleHyperlink *
605 AccessibleHypertext_getLink (AccessibleHypertext *obj,
609 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
610 long int characterOffset);
614 * AccessibleImage function prototypes
619 AccessibleImage_ref (AccessibleImage *obj);
622 AccessibleImage_unref (AccessibleImage *obj);
625 AccessibleImage_getImageDescription (AccessibleImage *obj);
628 AccessibleImage_getImageSize (AccessibleImage *obj,
633 AccessibleImage_getImagePosition (AccessibleImage *obj,
636 AccessibleCoordType ctype);
639 AccessibleImage_getImageExtents (AccessibleImage *obj,
644 AccessibleCoordType ctype);
647 * AccessibleRelation function prototypes
651 void AccessibleRelation_ref (AccessibleRelation *obj);
652 void AccessibleRelation_unref (AccessibleRelation *obj);
654 AccessibleRelationType
655 AccessibleRelation_getRelationType (AccessibleRelation *obj);
658 AccessibleRelation_getNTargets (AccessibleRelation *obj);
661 AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
666 * AccessibleSelection function prototypes
670 void AccessibleSelection_ref (AccessibleSelection *obj);
671 void AccessibleSelection_unref (AccessibleSelection *obj);
674 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
677 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
678 long int selectedChildIndex);
681 AccessibleSelection_selectChild (AccessibleSelection *obj,
682 long int childIndex);
685 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
686 long int selectedChildIndex);
689 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
690 long int childIndex);
693 AccessibleSelection_selectAll (AccessibleSelection *obj);
696 AccessibleSelection_clearSelection (AccessibleSelection *obj);
701 * AccessibleStateSet function prototypes
705 void AccessibleStateSet_ref (AccessibleStateSet *obj);
706 void AccessibleStateSet_unref (AccessibleStateSet *obj);
709 AccessibleStateSet_contains (AccessibleStateSet *obj,
710 AccessibleState state);
713 AccessibleStateSet_add (AccessibleStateSet *obj,
714 AccessibleState state);
717 AccessibleStateSet_remove (AccessibleStateSet *obj,
718 AccessibleState state);
721 AccessibleStateSet_equals (AccessibleStateSet *obj,
722 AccessibleStateSet *obj2);
725 AccessibleStateSet_compare (AccessibleStateSet *obj,
726 AccessibleStateSet *obj2);
729 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
732 AccessibleStreamableContent_ref (AccessibleStreamableContent *obj);
734 AccessibleStreamableContent_unref (AccessibleStreamableContent *obj);
736 AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj);
738 AccessibleStreamableContent_freeContentTypeList (AccessibleStreamableContent *obj,
741 AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
742 const char *content_type);
744 AccessibleStreamableContent_close (AccessibleStreamableContent *obj);
747 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
749 AccessibleStreamableContentSeekType seek_type);
751 AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
754 unsigned int read_type);
757 * AccessibleTable function prototypes
761 void AccessibleTable_ref (AccessibleTable *obj);
762 void AccessibleTable_unref (AccessibleTable *obj);
765 AccessibleTable_getCaption (AccessibleTable *obj);
768 AccessibleTable_getSummary (AccessibleTable *obj);
771 AccessibleTable_getNRows (AccessibleTable *obj);
774 AccessibleTable_getNColumns (AccessibleTable *obj);
777 AccessibleTable_getAccessibleAt (AccessibleTable *obj,
782 AccessibleTable_getIndexAt (AccessibleTable *obj,
787 AccessibleTable_getRowAtIndex (AccessibleTable *obj,
791 AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
795 AccessibleTable_getRowDescription (AccessibleTable *obj,
799 AccessibleTable_getColumnDescription (AccessibleTable *obj,
803 AccessibleTable_getRowExtentAt (AccessibleTable *obj,
808 AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
813 AccessibleTable_getRowHeader (AccessibleTable *obj,
817 AccessibleTable_getColumnHeader (AccessibleTable *obj,
821 AccessibleTable_getNSelectedRows (AccessibleTable *obj);
824 AccessibleTable_getSelectedRows (AccessibleTable *obj,
825 long int **selectedRows);
828 AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
831 AccessibleTable_getSelectedColumns (AccessibleTable *obj,
832 long int **selectedColumns);
835 AccessibleTable_isRowSelected (AccessibleTable *obj,
839 AccessibleTable_isColumnSelected (AccessibleTable *obj,
843 AccessibleTable_isSelected (AccessibleTable *obj,
848 AccessibleTable_addRowSelection (AccessibleTable *obj,
851 AccessibleTable_addColumnSelection (AccessibleTable *obj,
855 AccessibleTable_removeRowSelection (AccessibleTable *obj,
858 AccessibleTable_removeColumnSelection (AccessibleTable *obj,
863 * AccessibleText function prototypes
867 void AccessibleText_ref (AccessibleText *obj);
868 void AccessibleText_unref (AccessibleText *obj);
871 AccessibleText_getCharacterCount (AccessibleText *obj);
874 AccessibleText_getText (AccessibleText *obj,
875 long int startOffset,
879 AccessibleText_getCaretOffset (AccessibleText *obj);
882 AccessibleText_getAttributes (AccessibleText *obj,
884 long int *startOffset,
885 long int *endOffset);
888 AccessibleText_getDefaultAttributes (AccessibleText *obj);
891 AccessibleText_setCaretOffset (AccessibleText *obj,
895 AccessibleText_getTextBeforeOffset (AccessibleText *obj,
897 AccessibleTextBoundaryType type,
898 long int *startOffset,
899 long int *endOffset);
902 AccessibleText_getTextAtOffset (AccessibleText *obj,
904 AccessibleTextBoundaryType type,
905 long int *startOffset,
906 long int *endOffset);
909 AccessibleText_getTextAfterOffset (AccessibleText *obj,
911 AccessibleTextBoundaryType type,
912 long int *startOffset,
913 long int *endOffset);
916 AccessibleText_getCharacterAtOffset (AccessibleText *obj,
920 AccessibleText_getCharacterExtents (AccessibleText *obj,
926 AccessibleCoordType type);
929 AccessibleText_getRangeExtents (AccessibleText *obj,
930 long int startOffset,
936 AccessibleCoordType type);
938 AccessibleTextRange **
939 AccessibleText_getBoundedRanges (AccessibleText *obj,
944 AccessibleCoordType type,
945 AccessibleTextClipType clipTypeX,
946 AccessibleTextClipType clipTypeY);
949 AccessibleTextRange_freeRanges (AccessibleTextRange **ranges);
952 AccessibleText_getOffsetAtPoint (AccessibleText *obj,
955 AccessibleCoordType type);
958 AccessibleText_getNSelections (AccessibleText *obj);
961 AccessibleText_getSelection (AccessibleText *obj,
962 long int selectionNum,
963 long int *startOffset,
964 long int *endOffset);
968 AccessibleText_addSelection (AccessibleText *obj,
969 long int startOffset,
973 AccessibleText_removeSelection (AccessibleText *obj,
974 long int selectionNum);
977 AccessibleText_setSelection (AccessibleText *obj,
978 long int selectionNum,
979 long int startOffset,
982 /* AccessibleValue Function Prototypes: */
984 void AccessibleValue_ref (AccessibleValue *obj);
985 void AccessibleValue_unref (AccessibleValue *obj);
986 double AccessibleValue_getMinimumValue (AccessibleValue *obj);
987 double AccessibleValue_getCurrentValue (AccessibleValue *obj);
988 double AccessibleValue_getMaximumValue (AccessibleValue *obj);
989 SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
992 /* Persistance and lifecycle control for AccessibleEvents. */
993 SPIBoolean AccessibleEvent_ref (const AccessibleEvent *e);
994 void AccessibleEvent_unref (const AccessibleEvent *e);
997 * Prototypes for accessor functions, to obtain context
998 * information for accessible events.
1001 char* AccessibleEvent_getSourceName (const AccessibleEvent *e);
1002 AccessibleRole AccessibleEvent_getSourceRole (const AccessibleEvent *e);
1003 AccessibleApplication* AccessibleEvent_getSourceApplication (const AccessibleEvent *e);
1004 SPIBoolean AccessibleEvent_getSourceDetails (const AccessibleEvent *e, char **name,
1005 AccessibleRole *role,
1006 AccessibleApplication **app);
1008 char* AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e);
1009 Accessible * AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e);
1011 Accessible * AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e);
1013 char* AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e);
1015 char* AccessibleWindowEvent_getTitleString (const AccessibleEvent *e);
1017 Accessible * AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e);
1019 Accessible * AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e);
1021 Accessible * AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e);
1023 char * AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e);
1025 char * AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1027 char * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1029 char * AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
1031 char * AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e);
1032 SPIRect * AccessibleBoundsChangedEvent_getNewBounds (const AccessibleEvent *e);
1034 /* Misc methods and error handling */
1035 void SPI_freeString (char *s);
1037 char* SPI_dupString (char *s);
1039 void SPI_freeRect (SPIRect *rect);
1041 SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler);
1043 SPIExceptionHandler* SPI_exceptionHandlerPop (void);
1045 SPIExceptionType SPIException_getSourceType (SPIException *err);
1047 SPIExceptionCode SPIException_getExceptionCode (SPIException *err);
1049 Accessible* SPIAccessibleException_getSource (SPIException *err);
1051 char* SPIException_getDescription (SPIException *err);