4 #include <cspi/spi-impl.h>
6 * Definitions for AccessibleRole, AccessibleState,
7 * AccessibleEvent, and event listeners.
9 #include <cspi/spi-roletypes.h>
10 #include <cspi/spi-statetypes.h>
11 #include <cspi/spi-listener.h>
14 * Auxiliary typedefs and mask definitions
16 #include <libspi/keymasks.h>
23 * Enumerated type for text boundary types
27 SPI_TEXT_BOUNDARY_CHAR,
28 SPI_TEXT_BOUNDARY_CURSOR_POS,
29 SPI_TEXT_BOUNDARY_WORD_START,
30 SPI_TEXT_BOUNDARY_WORD_END,
31 SPI_TEXT_BOUNDARY_SENTENCE_START,
32 SPI_TEXT_BOUNDARY_SENTENCE_END,
33 SPI_TEXT_BOUNDARY_LINE_START,
34 SPI_TEXT_BOUNDARY_LINE_END,
35 SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE
36 } AccessibleTextBoundaryType;
40 * Enumerated type for relation types
46 SPI_RELATION_LABEL_FOR,
47 SPI_RELATION_LABELED_BY,
48 SPI_RELATION_CONTROLLER_FOR,
49 SPI_RELATION_CONTROLLED_BY,
50 SPI_RELATION_MEMBER_OF
51 } AccessibleRelationType;
54 /* don't change the order of these ! */
56 SPI_COORD_TYPE_SCREEN,
58 } AccessibleCoordType;
65 } AccessibleKeySynthType;
68 SPI_KEYLISTENER_NOSYNC = 0,
69 SPI_KEYLISTENER_SYNCHRONOUS = 1,
70 SPI_KEYLISTENER_CANCONSUME = 2,
71 SPI_KEYLISTENER_ALL_WINDOWS = 4
72 } AccessibleKeyListenerSyncType;
74 typedef unsigned long AccessibleKeyEventMask;
77 * AccessibleComponentLayer:
78 * @SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
79 * @SPI_LAYER_BACKGROUND: Component belongs to the destop background.
80 * @SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
81 * @SPI_LAYER_WIDGET: Component is a 'normal' widget.
82 * @SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
83 * Z-information relative to other MDI-layer components.
84 * @SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
86 * @SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
88 * @SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
89 * should not be encountered.
99 SPI_LAYER_LAST_DEFINED
100 } AccessibleComponentLayer;
109 * Structure containing identifying information about a set of keycode or
112 typedef struct _AccessibleKeySet
114 unsigned long *keysyms;
115 unsigned short *keycodes;
120 * SPI_KEYSET_ALL_KEYS:
121 * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
122 * includes all keycodes and keyvals for the specified modifier set.
124 #define SPI_KEYSET_ALL_KEYS NULL
126 typedef unsigned long AccessibleKeyMaskType;
129 /* Basic SPI initialization and event loop function prototypes */
132 void SPI_event_main (void);
133 void SPI_event_quit (void);
134 SPIBoolean SPI_eventIsReady (void);
135 AccessibleEvent *SPI_nextEvent (SPIBoolean waitForEvent);
138 /* Event Listener creation and support. */
140 AccessibleEventListener *
141 createAccessibleEventListener (AccessibleEventListenerCB callback,
143 SPIBoolean AccessibleEventListener_addCallback (AccessibleEventListener *listener,
144 AccessibleEventListenerCB callback,
146 SPIBoolean AccessibleEventListener_removeCallback (AccessibleEventListener *listener,
147 AccessibleEventListenerCB callback);
148 void AccessibleEventListener_unref (AccessibleEventListener *listener);
150 /* Keystroke Listener creation and support. */
152 AccessibleKeystrokeListener *
153 createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback,
155 SPIBoolean AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener,
156 AccessibleKeystrokeListenerCB callback,
158 SPIBoolean AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener,
159 AccessibleKeystrokeListenerCB callback);
160 void AccessibleKeystrokeListener_unref (AccessibleKeystrokeListener *listener);
162 /* Global functions serviced by the registry */
164 SPIBoolean registerGlobalEventListener (AccessibleEventListener *listener,
165 const char *eventType);
166 SPIBoolean deregisterGlobalEventListener (AccessibleEventListener *listener,
167 const char *eventType);
168 SPIBoolean deregisterGlobalEventListenerAll (AccessibleEventListener *listener);
170 SPIBoolean registerAccessibleKeystrokeListener (
171 AccessibleKeystrokeListener *listener,
172 AccessibleKeySet *keys,
173 AccessibleKeyMaskType modmask,
174 AccessibleKeyEventMask eventmask,
175 AccessibleKeyListenerSyncType sync_type);
176 SPIBoolean deregisterAccessibleKeystrokeListener (
177 AccessibleKeystrokeListener *listener,
178 AccessibleKeyMaskType modmask);
180 int getDesktopCount (void);
181 Accessible *getDesktop (int i);
182 int getDesktopList (Accessible **list);
184 SPIBoolean generateKeyEvent (long int keyval,
185 AccessibleKeySynthType synth_type);
186 SPIBoolean generateMouseEvent (long int x, long int y, char *name);
188 /* Accessible function prototypes */
190 void Accessible_ref (Accessible *obj);
191 void Accessible_unref (Accessible *obj);
192 char * Accessible_getName (Accessible *obj);
193 char * Accessible_getDescription (Accessible *obj);
194 Accessible * Accessible_getParent (Accessible *obj);
195 long Accessible_getChildCount (Accessible *obj);
196 Accessible * Accessible_getChildAtIndex (Accessible *obj,
197 long int childIndex);
198 long Accessible_getIndexInParent (Accessible *obj);
199 AccessibleRelation **Accessible_getRelationSet (Accessible *obj);
200 const char * Accessible_getRole (Accessible *obj);
201 AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
203 /* Interface query methods */
205 SPIBoolean Accessible_isAction (Accessible *obj);
206 SPIBoolean Accessible_isApplication (Accessible *obj);
207 SPIBoolean Accessible_isComponent (Accessible *obj);
208 SPIBoolean Accessible_isEditableText (Accessible *obj);
209 SPIBoolean Accessible_isHypertext (Accessible *obj);
210 SPIBoolean Accessible_isImage (Accessible *obj);
211 SPIBoolean Accessible_isSelection (Accessible *obj);
212 SPIBoolean Accessible_isTable (Accessible *obj);
213 SPIBoolean Accessible_isText (Accessible *obj);
214 SPIBoolean Accessible_isValue (Accessible *obj);
216 AccessibleAction * Accessible_getAction (Accessible *obj);
217 AccessibleApplication * Accessible_getApplication (Accessible *obj);
218 AccessibleComponent * Accessible_getComponent (Accessible *obj);
219 AccessibleEditableText * Accessible_getEditableText (Accessible *obj);
220 AccessibleHypertext * Accessible_getHypertext (Accessible *obj);
221 AccessibleImage * Accessible_getImage (Accessible *obj);
222 AccessibleSelection * Accessible_getSelection (Accessible *obj);
223 AccessibleTable * Accessible_getTable (Accessible *obj);
224 AccessibleText * Accessible_getText (Accessible *obj);
225 AccessibleValue * Accessible_getValue (Accessible *obj);
226 AccessibleUnknown * Accessible_queryInterface (Accessible *obj,
227 const char *interface_name);
229 /* AccessibleAction function prototypes */
231 void AccessibleAction_ref (AccessibleAction *obj);
232 void AccessibleAction_unref (AccessibleAction *obj);
233 long AccessibleAction_getNActions (AccessibleAction *obj);
234 char *AccessibleAction_getName (AccessibleAction *obj,
236 char *AccessibleAction_getDescription (AccessibleAction *obj,
238 SPIBoolean AccessibleAction_doAction (AccessibleAction *obj,
240 char *AccessibleAction_getKeyBinding (AccessibleAction *obj,
243 /* AccessibleApplication function prototypes */
245 void AccessibleApplication_ref (AccessibleApplication *obj);
246 void AccessibleApplication_unref (AccessibleApplication *obj);
247 char *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
248 char *AccessibleApplication_getVersion (AccessibleApplication *obj);
249 long AccessibleApplication_getID (AccessibleApplication *obj);
250 SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj);
251 SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj);
253 /* AccessibleComponent function prototypes */
255 void AccessibleComponent_ref (AccessibleComponent *obj);
256 void AccessibleComponent_unref (AccessibleComponent *obj);
257 SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj,
260 AccessibleCoordType ctype);
261 Accessible *AccessibleComponent_getAccessibleAtPoint (
262 AccessibleComponent *obj,
265 AccessibleCoordType ctype);
266 void AccessibleComponent_getExtents (AccessibleComponent *obj,
271 AccessibleCoordType ctype);
272 void AccessibleComponent_getPosition (AccessibleComponent *obj,
275 AccessibleCoordType ctype);
276 void AccessibleComponent_getSize (AccessibleComponent *obj,
279 AccessibleComponentLayer
280 AccessibleComponent_getLayer (AccessibleComponent *obj);
281 void AccessibleComponent_grabFocus (AccessibleComponent *obj);
282 short AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
284 /* AccessibleEditableText function prototypes */
287 AccessibleEditableText_ref (AccessibleEditableText *obj);
290 AccessibleEditableText_unref (AccessibleEditableText *obj);
293 AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
294 const char *attributes,
295 long int startOffset,
299 AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
300 const char *newContents);
303 AccessibleEditableText_insertText (AccessibleEditableText *obj,
309 AccessibleEditableText_copyText (AccessibleText *obj,
314 AccessibleEditableText_cutText (AccessibleEditableText *obj,
319 AccessibleEditableText_deleteText (AccessibleEditableText *obj,
324 AccessibleEditableText_pasteText (AccessibleEditableText *obj,
329 * AccessibleHyperlink function prototypes
333 AccessibleHyperlink_ref (AccessibleHyperlink *obj);
335 AccessibleHyperlink_unref (AccessibleHyperlink *obj);
338 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
341 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
345 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
349 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
350 long int *startIndex,
354 AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
358 * AccessibleHypertext function prototypes
363 AccessibleHypertext_ref (AccessibleHypertext *obj);
366 AccessibleHypertext_unref (AccessibleHypertext *obj);
369 AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
371 AccessibleHyperlink *
372 AccessibleHypertext_getLink (AccessibleHypertext *obj,
376 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
377 long int characterOffset);
381 * AccessibleImage function prototypes
386 AccessibleImage_ref (AccessibleImage *obj);
389 AccessibleImage_unref (AccessibleImage *obj);
392 AccessibleImage_getImageDescription (AccessibleImage *obj);
395 AccessibleImage_getImageSize (AccessibleImage *obj,
400 AccessibleImage_getImagePosition (AccessibleImage *obj,
403 AccessibleCoordType ctype);
406 AccessibleImage_getImageExtents (AccessibleImage *obj,
411 AccessibleCoordType ctype);
414 * AccessibleRelation function prototypes
418 void AccessibleRelation_ref (AccessibleRelation *obj);
419 void AccessibleRelation_unref (AccessibleRelation *obj);
421 AccessibleRelationType
422 AccessibleRelation_getRelationType (AccessibleRelation *obj);
425 AccessibleRelation_getNTargets (AccessibleRelation *obj);
428 AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
433 * AccessibleSelection function prototypes
437 void AccessibleSelection_ref (AccessibleSelection *obj);
438 void AccessibleSelection_unref (AccessibleSelection *obj);
441 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
444 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
445 long int selectedChildIndex);
448 AccessibleSelection_selectChild (AccessibleSelection *obj,
449 long int childIndex);
452 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
453 long int selectedChildIndex);
456 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
457 long int childIndex);
460 AccessibleSelection_selectAll (AccessibleSelection *obj);
463 AccessibleSelection_clearSelection (AccessibleSelection *obj);
468 * AccessibleStateSet function prototypes
472 void AccessibleStateSet_ref (AccessibleStateSet *obj);
473 void AccessibleStateSet_unref (AccessibleStateSet *obj);
476 AccessibleStateSet_contains (AccessibleStateSet *obj,
477 AccessibleState state);
480 AccessibleStateSet_add (AccessibleStateSet *obj,
481 AccessibleState state);
484 AccessibleStateSet_remove (AccessibleStateSet *obj,
485 AccessibleState state);
488 AccessibleStateSet_equals (AccessibleStateSet *obj,
489 AccessibleStateSet *obj2);
492 AccessibleStateSet_compare (AccessibleStateSet *obj,
493 AccessibleStateSet *obj2);
496 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
501 * AccessibleTable function prototypes
505 void AccessibleTable_ref (AccessibleTable *obj);
506 void AccessibleTable_unref (AccessibleTable *obj);
509 AccessibleTable_getCaption (AccessibleTable *obj);
512 AccessibleTable_getSummary (AccessibleTable *obj);
515 AccessibleTable_getNRows (AccessibleTable *obj);
518 AccessibleTable_getNColumns (AccessibleTable *obj);
521 AccessibleTable_getAccessibleAt (AccessibleTable *obj,
526 AccessibleTable_getIndexAt (AccessibleTable *obj,
531 AccessibleTable_getRowAtIndex (AccessibleTable *obj,
535 AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
539 AccessibleTable_getRowDescription (AccessibleTable *obj,
543 AccessibleTable_getColumnDescription (AccessibleTable *obj,
547 AccessibleTable_getRowExtentAt (AccessibleTable *obj,
552 AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
557 AccessibleTable_getRowHeader (AccessibleTable *obj,
561 AccessibleTable_getColumnHeader (AccessibleTable *obj,
565 AccessibleTable_getNSelectedRows (AccessibleTable *obj);
568 AccessibleTable_getSelectedRows (AccessibleTable *obj,
569 long int **selectedRows);
572 AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
575 AccessibleTable_getSelectedColumns (AccessibleTable *obj,
576 long int **selectedColumns);
579 AccessibleTable_isRowSelected (AccessibleTable *obj,
583 AccessibleTable_isColumnSelected (AccessibleTable *obj,
587 AccessibleTable_isSelected (AccessibleTable *obj,
593 * AccessibleText function prototypes
597 void AccessibleText_ref (AccessibleText *obj);
598 void AccessibleText_unref (AccessibleText *obj);
601 AccessibleText_getCharacterCount (AccessibleText *obj);
604 AccessibleText_getText (AccessibleText *obj,
605 long int startOffset,
609 AccessibleText_getCaretOffset (AccessibleText *obj);
612 AccessibleText_getAttributes (AccessibleText *obj,
614 long int *startOffset,
615 long int *endOffset);
619 AccessibleText_setCaretOffset (AccessibleText *obj,
623 AccessibleText_getTextBeforeOffset (AccessibleText *obj,
625 AccessibleTextBoundaryType type,
626 long int *startOffset,
627 long int *endOffset);
630 AccessibleText_getTextAtOffset (AccessibleText *obj,
632 AccessibleTextBoundaryType type,
633 long int *startOffset,
634 long int *endOffset);
637 AccessibleText_getTextAfterOffset (AccessibleText *obj,
639 AccessibleTextBoundaryType type,
640 long int *startOffset,
641 long int *endOffset);
644 AccessibleText_getCharacterAtOffset (AccessibleText *obj,
648 AccessibleText_getCharacterExtents (AccessibleText *obj,
654 AccessibleCoordType type);
657 AccessibleText_getOffsetAtPoint (AccessibleText *obj,
660 AccessibleCoordType type);
663 AccessibleText_getNSelections (AccessibleText *obj);
666 AccessibleText_getSelection (AccessibleText *obj,
667 long int selectionNum,
668 long int *startOffset,
669 long int *endOffset);
673 AccessibleText_addSelection (AccessibleText *obj,
674 long int startOffset,
678 AccessibleText_removeSelection (AccessibleText *obj,
679 long int selectionNum);
682 AccessibleText_setSelection (AccessibleText *obj,
683 long int selectionNum,
684 long int startOffset,
687 /* AccessibleValue Function Prototypes: */
689 void AccessibleValue_ref (AccessibleValue *obj);
690 void AccessibleValue_unref (AccessibleValue *obj);
691 float AccessibleValue_getMinimumValue (AccessibleValue *obj);
692 float AccessibleValue_getCurrentValue (AccessibleValue *obj);
693 float AccessibleValue_getMaximumValue (AccessibleValue *obj);
694 SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
698 void SPI_freeString (char *s);