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
47 SPI_RELATION_LABEL_FOR,
48 SPI_RELATION_LABELED_BY,
49 SPI_RELATION_CONTROLLER_FOR,
50 SPI_RELATION_CONTROLLED_BY,
51 SPI_RELATION_MEMBER_OF,
52 SPI_RELATION_NODE_CHILD_OF,
53 SPI_RELATION_EXTENDED,
54 SPI_RELATION_LAST_DEFINED
55 } AccessibleRelationType;
58 /* don't change the order of these ! */
60 SPI_COORD_TYPE_SCREEN,
62 } AccessibleCoordType;
70 } AccessibleKeySynthType;
73 SPI_KEYLISTENER_NOSYNC = 0,
74 SPI_KEYLISTENER_SYNCHRONOUS = 1,
75 SPI_KEYLISTENER_CANCONSUME = 2,
76 SPI_KEYLISTENER_ALL_WINDOWS = 4
77 } AccessibleKeyListenerSyncType;
79 typedef unsigned long AccessibleKeyEventMask;
82 * AccessibleComponentLayer:
83 * @SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
84 * @SPI_LAYER_BACKGROUND: Component belongs to the destop background.
85 * @SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
86 * @SPI_LAYER_WIDGET: Component is a 'normal' widget.
87 * @SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
88 * Z-information relative to other MDI-layer components.
89 * @SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
91 * @SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
93 * @SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
94 * should not be encountered.
104 SPI_LAYER_LAST_DEFINED
105 } AccessibleComponentLayer;
114 * Structure containing identifying information about a set of keycode or
117 typedef struct _AccessibleKeySet
119 unsigned long *keysyms;
120 unsigned short *keycodes;
126 * SPI_KEYSET_ALL_KEYS:
127 * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
128 * includes all keycodes and keyvals for the specified modifier set.
130 #define SPI_KEYSET_ALL_KEYS NULL
132 typedef unsigned long AccessibleKeyMaskType;
135 /* Basic SPI initialization and event loop function prototypes */
138 void SPI_event_main (void);
139 void SPI_event_quit (void);
140 SPIBoolean SPI_eventIsReady (void);
141 AccessibleEvent *SPI_nextEvent (SPIBoolean waitForEvent);
144 /* Event Listener creation and support. */
146 void SPI_freeAccessibleKeySet (
147 AccessibleKeySet *keyset);
148 AccessibleKeySet * SPI_createAccessibleKeySet (
152 const char **keystrings);
153 AccessibleEventListener * SPI_createAccessibleEventListener (
154 AccessibleEventListenerCB callback,
156 SPIBoolean AccessibleEventListener_addCallback (
157 AccessibleEventListener *listener,
158 AccessibleEventListenerCB callback,
160 SPIBoolean AccessibleEventListener_removeCallback (
161 AccessibleEventListener *listener,
162 AccessibleEventListenerCB callback);
163 void AccessibleEventListener_unref (
164 AccessibleEventListener *listener);
166 /* Keystroke Listener creation and support. */
168 AccessibleKeystrokeListener * SPI_createAccessibleKeystrokeListener (
169 AccessibleKeystrokeListenerCB callback,
171 SPIBoolean AccessibleKeystrokeListener_addCallback (
172 AccessibleKeystrokeListener *listener,
173 AccessibleKeystrokeListenerCB callback,
175 SPIBoolean AccessibleKeystrokeListener_removeCallback (
176 AccessibleKeystrokeListener *listener,
177 AccessibleKeystrokeListenerCB callback);
178 void AccessibleKeystrokeListener_unref (
179 AccessibleKeystrokeListener *listener);
181 /* Global functions serviced by the registry */
183 SPIBoolean SPI_registerGlobalEventListener (
184 AccessibleEventListener *listener,
185 const char *eventType);
186 SPIBoolean SPI_deregisterGlobalEventListener (
187 AccessibleEventListener *listener,
188 const char *eventType);
189 SPIBoolean SPI_deregisterGlobalEventListenerAll (
190 AccessibleEventListener *listener);
191 SPIBoolean SPI_registerAccessibleKeystrokeListener (
192 AccessibleKeystrokeListener *listener,
193 AccessibleKeySet *keys,
194 AccessibleKeyMaskType modmask,
195 AccessibleKeyEventMask eventmask,
196 AccessibleKeyListenerSyncType sync_type);
197 SPIBoolean SPI_deregisterAccessibleKeystrokeListener (
198 AccessibleKeystrokeListener *listener,
199 AccessibleKeyMaskType modmask);
201 int SPI_getDesktopCount (void);
202 Accessible *SPI_getDesktop (int i);
203 int SPI_getDesktopList (Accessible **list);
205 SPIBoolean SPI_generateKeyboardEvent (long int keyval,
207 AccessibleKeySynthType synth_type);
209 SPIBoolean SPI_generateMouseEvent (long int x, long int y, char *name);
211 /* Accessible function prototypes */
213 void Accessible_ref (Accessible *obj);
214 void Accessible_unref (Accessible *obj);
215 char * Accessible_getName (Accessible *obj);
216 char * Accessible_getDescription (Accessible *obj);
217 Accessible * Accessible_getParent (Accessible *obj);
218 long Accessible_getChildCount (Accessible *obj);
219 Accessible * Accessible_getChildAtIndex (Accessible *obj,
220 long int childIndex);
221 long Accessible_getIndexInParent (Accessible *obj);
222 AccessibleRelation **Accessible_getRelationSet (Accessible *obj);
223 AccessibleRole Accessible_getRole (Accessible *obj);
224 char * Accessible_getRoleName (Accessible *obj);
225 AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
227 /* Interface query methods */
229 SPIBoolean Accessible_isAction (Accessible *obj);
230 SPIBoolean Accessible_isApplication (Accessible *obj);
231 SPIBoolean Accessible_isComponent (Accessible *obj);
232 SPIBoolean Accessible_isEditableText (Accessible *obj);
233 SPIBoolean Accessible_isHypertext (Accessible *obj);
234 SPIBoolean Accessible_isImage (Accessible *obj);
235 SPIBoolean Accessible_isSelection (Accessible *obj);
236 SPIBoolean Accessible_isStreamableContent (Accessible *obj);
237 SPIBoolean Accessible_isTable (Accessible *obj);
238 SPIBoolean Accessible_isText (Accessible *obj);
239 SPIBoolean Accessible_isValue (Accessible *obj);
241 AccessibleAction * Accessible_getAction (Accessible *obj);
242 AccessibleApplication * Accessible_getApplication (Accessible *obj);
243 AccessibleComponent * Accessible_getComponent (Accessible *obj);
244 AccessibleEditableText * Accessible_getEditableText (Accessible *obj);
245 AccessibleHypertext * Accessible_getHypertext (Accessible *obj);
246 AccessibleImage * Accessible_getImage (Accessible *obj);
247 AccessibleSelection * Accessible_getSelection (Accessible *obj);
248 AccessibleStreamableContent * Accessible_getStreamableContent (Accessible *obj);
249 AccessibleTable * Accessible_getTable (Accessible *obj);
250 AccessibleText * Accessible_getText (Accessible *obj);
251 AccessibleValue * Accessible_getValue (Accessible *obj);
252 AccessibleUnknown * Accessible_queryInterface (Accessible *obj,
253 const char *interface_name);
255 /* AccessibleAction function prototypes */
257 void AccessibleAction_ref (AccessibleAction *obj);
258 void AccessibleAction_unref (AccessibleAction *obj);
259 long AccessibleAction_getNActions (AccessibleAction *obj);
260 char *AccessibleAction_getName (AccessibleAction *obj,
262 char *AccessibleAction_getDescription (AccessibleAction *obj,
264 SPIBoolean AccessibleAction_doAction (AccessibleAction *obj,
266 char *AccessibleAction_getKeyBinding (AccessibleAction *obj,
269 /* AccessibleApplication function prototypes */
271 void AccessibleApplication_ref (AccessibleApplication *obj);
272 void AccessibleApplication_unref (AccessibleApplication *obj);
273 char *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
274 char *AccessibleApplication_getVersion (AccessibleApplication *obj);
275 long AccessibleApplication_getID (AccessibleApplication *obj);
276 SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj);
277 SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj);
279 /* AccessibleComponent function prototypes */
281 void AccessibleComponent_ref (AccessibleComponent *obj);
282 void AccessibleComponent_unref (AccessibleComponent *obj);
283 SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj,
286 AccessibleCoordType ctype);
287 Accessible *AccessibleComponent_getAccessibleAtPoint (
288 AccessibleComponent *obj,
291 AccessibleCoordType ctype);
292 void AccessibleComponent_getExtents (AccessibleComponent *obj,
297 AccessibleCoordType ctype);
298 void AccessibleComponent_getPosition (AccessibleComponent *obj,
301 AccessibleCoordType ctype);
302 void AccessibleComponent_getSize (AccessibleComponent *obj,
305 AccessibleComponentLayer
306 AccessibleComponent_getLayer (AccessibleComponent *obj);
307 void AccessibleComponent_grabFocus (AccessibleComponent *obj);
308 short AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
310 /* AccessibleEditableText function prototypes */
313 AccessibleEditableText_ref (AccessibleEditableText *obj);
316 AccessibleEditableText_unref (AccessibleEditableText *obj);
319 AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
320 const char *attributes,
321 long int startOffset,
325 AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
326 const char *newContents);
329 AccessibleEditableText_insertText (AccessibleEditableText *obj,
335 AccessibleEditableText_copyText (AccessibleText *obj,
340 AccessibleEditableText_cutText (AccessibleEditableText *obj,
345 AccessibleEditableText_deleteText (AccessibleEditableText *obj,
350 AccessibleEditableText_pasteText (AccessibleEditableText *obj,
355 * AccessibleHyperlink function prototypes
359 AccessibleHyperlink_ref (AccessibleHyperlink *obj);
361 AccessibleHyperlink_unref (AccessibleHyperlink *obj);
364 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
367 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
371 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
375 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
376 long int *startIndex,
380 AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
384 * AccessibleHypertext function prototypes
389 AccessibleHypertext_ref (AccessibleHypertext *obj);
392 AccessibleHypertext_unref (AccessibleHypertext *obj);
395 AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
397 AccessibleHyperlink *
398 AccessibleHypertext_getLink (AccessibleHypertext *obj,
402 AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
403 long int characterOffset);
407 * AccessibleImage function prototypes
412 AccessibleImage_ref (AccessibleImage *obj);
415 AccessibleImage_unref (AccessibleImage *obj);
418 AccessibleImage_getImageDescription (AccessibleImage *obj);
421 AccessibleImage_getImageSize (AccessibleImage *obj,
426 AccessibleImage_getImagePosition (AccessibleImage *obj,
429 AccessibleCoordType ctype);
432 AccessibleImage_getImageExtents (AccessibleImage *obj,
437 AccessibleCoordType ctype);
440 * AccessibleRelation function prototypes
444 void AccessibleRelation_ref (AccessibleRelation *obj);
445 void AccessibleRelation_unref (AccessibleRelation *obj);
447 AccessibleRelationType
448 AccessibleRelation_getRelationType (AccessibleRelation *obj);
451 AccessibleRelation_getNTargets (AccessibleRelation *obj);
454 AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
459 * AccessibleSelection function prototypes
463 void AccessibleSelection_ref (AccessibleSelection *obj);
464 void AccessibleSelection_unref (AccessibleSelection *obj);
467 AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
470 AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
471 long int selectedChildIndex);
474 AccessibleSelection_selectChild (AccessibleSelection *obj,
475 long int childIndex);
478 AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
479 long int selectedChildIndex);
482 AccessibleSelection_isChildSelected (AccessibleSelection *obj,
483 long int childIndex);
486 AccessibleSelection_selectAll (AccessibleSelection *obj);
489 AccessibleSelection_clearSelection (AccessibleSelection *obj);
494 * AccessibleStateSet function prototypes
498 void AccessibleStateSet_ref (AccessibleStateSet *obj);
499 void AccessibleStateSet_unref (AccessibleStateSet *obj);
502 AccessibleStateSet_contains (AccessibleStateSet *obj,
503 AccessibleState state);
506 AccessibleStateSet_add (AccessibleStateSet *obj,
507 AccessibleState state);
510 AccessibleStateSet_remove (AccessibleStateSet *obj,
511 AccessibleState state);
514 AccessibleStateSet_equals (AccessibleStateSet *obj,
515 AccessibleStateSet *obj2);
518 AccessibleStateSet_compare (AccessibleStateSet *obj,
519 AccessibleStateSet *obj2);
522 AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
525 AccessibleStreamableContent_ref (AccessibleStreamableContent *obj);
527 AccessibleStreamableContent_unref (AccessibleStreamableContent *obj);
529 AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj);
531 AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
532 const char *content_type);
534 AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
537 AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
540 unsigned int read_type);
543 * AccessibleTable function prototypes
547 void AccessibleTable_ref (AccessibleTable *obj);
548 void AccessibleTable_unref (AccessibleTable *obj);
551 AccessibleTable_getCaption (AccessibleTable *obj);
554 AccessibleTable_getSummary (AccessibleTable *obj);
557 AccessibleTable_getNRows (AccessibleTable *obj);
560 AccessibleTable_getNColumns (AccessibleTable *obj);
563 AccessibleTable_getAccessibleAt (AccessibleTable *obj,
568 AccessibleTable_getIndexAt (AccessibleTable *obj,
573 AccessibleTable_getRowAtIndex (AccessibleTable *obj,
577 AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
581 AccessibleTable_getRowDescription (AccessibleTable *obj,
585 AccessibleTable_getColumnDescription (AccessibleTable *obj,
589 AccessibleTable_getRowExtentAt (AccessibleTable *obj,
594 AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
599 AccessibleTable_getRowHeader (AccessibleTable *obj,
603 AccessibleTable_getColumnHeader (AccessibleTable *obj,
607 AccessibleTable_getNSelectedRows (AccessibleTable *obj);
610 AccessibleTable_getSelectedRows (AccessibleTable *obj,
611 long int **selectedRows);
614 AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
617 AccessibleTable_getSelectedColumns (AccessibleTable *obj,
618 long int **selectedColumns);
621 AccessibleTable_isRowSelected (AccessibleTable *obj,
625 AccessibleTable_isColumnSelected (AccessibleTable *obj,
629 AccessibleTable_isSelected (AccessibleTable *obj,
635 * AccessibleText function prototypes
639 void AccessibleText_ref (AccessibleText *obj);
640 void AccessibleText_unref (AccessibleText *obj);
643 AccessibleText_getCharacterCount (AccessibleText *obj);
646 AccessibleText_getText (AccessibleText *obj,
647 long int startOffset,
651 AccessibleText_getCaretOffset (AccessibleText *obj);
654 AccessibleText_getAttributes (AccessibleText *obj,
656 long int *startOffset,
657 long int *endOffset);
661 AccessibleText_setCaretOffset (AccessibleText *obj,
665 AccessibleText_getTextBeforeOffset (AccessibleText *obj,
667 AccessibleTextBoundaryType type,
668 long int *startOffset,
669 long int *endOffset);
672 AccessibleText_getTextAtOffset (AccessibleText *obj,
674 AccessibleTextBoundaryType type,
675 long int *startOffset,
676 long int *endOffset);
679 AccessibleText_getTextAfterOffset (AccessibleText *obj,
681 AccessibleTextBoundaryType type,
682 long int *startOffset,
683 long int *endOffset);
686 AccessibleText_getCharacterAtOffset (AccessibleText *obj,
690 AccessibleText_getCharacterExtents (AccessibleText *obj,
696 AccessibleCoordType type);
699 AccessibleText_getOffsetAtPoint (AccessibleText *obj,
702 AccessibleCoordType type);
705 AccessibleText_getNSelections (AccessibleText *obj);
708 AccessibleText_getSelection (AccessibleText *obj,
709 long int selectionNum,
710 long int *startOffset,
711 long int *endOffset);
715 AccessibleText_addSelection (AccessibleText *obj,
716 long int startOffset,
720 AccessibleText_removeSelection (AccessibleText *obj,
721 long int selectionNum);
724 AccessibleText_setSelection (AccessibleText *obj,
725 long int selectionNum,
726 long int startOffset,
729 /* AccessibleValue Function Prototypes: */
731 void AccessibleValue_ref (AccessibleValue *obj);
732 void AccessibleValue_unref (AccessibleValue *obj);
733 double AccessibleValue_getMinimumValue (AccessibleValue *obj);
734 double AccessibleValue_getCurrentValue (AccessibleValue *obj);
735 double AccessibleValue_getMaximumValue (AccessibleValue *obj);
736 SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
740 void SPI_freeString (char *s);