-
-#ifndef _SPI_H
-#define _SPI_H
-
-#include "spi-impl.h"
-
-/* definitions for ACCESSIBLE_STATE */
-#include "spi-roletypes.h"
-#include "spi-statetypes.h"
-
/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
*
- * Enumerated type for text boundary types
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
*
- */
-
-typedef enum
-{
- TEXT_BOUNDARY_CHAR,
- TEXT_BOUNDARY_CURSOR_POS,
- TEXT_BOUNDARY_WORD_START,
- TEXT_BOUNDARY_WORD_END,
- TEXT_BOUNDARY_SENTENCE_START,
- TEXT_BOUNDARY_SENTENCE_END,
- TEXT_BOUNDARY_LINE_START,
- TEXT_BOUNDARY_LINE_END,
- TEXT_BOUNDARY_ATTRIBUTE_RANGE
-} TEXT_BOUNDARY_TYPE;
-
-
-
-/*
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
*
- * Enumerated type for relation types
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
*
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
*/
-typedef enum
-{
- RELATION_LABEL_FOR,
- RELATION_LABELED_BY,
- RELATION_CONTROLLER_FOR,
- RELATION_CONTROLLED_BY,
- RELATION_MEMBER_OF
-} RELATION_TYPE;
-
-
+#ifndef _SPI_H
+#define _SPI_H
+#include <cspi/spi-impl.h>
/*
- *
- * Structure used to encapsulate event information
- *
+ * Definitions for AccessibleRole, AccessibleState,
+ * and event listeners.
*/
-
-typedef struct _AccessibleEvent {
- Accessible *source;
- char *type;
- char *detail1;
- char *detail2;
-} AccessibleEvent;
-
-typedef enum _AccessibleCoordType {
- COORD_TYPE_WINDOW,
- COORD_TYPE_SCREEN
-} AccessibleCoordType;
+#include <cspi/spi-roletypes.h>
+#include <cspi/spi-statetypes.h>
+#include <cspi/spi-listener.h>
/*
- *
- * Function prototype typedef for AccessibleEventListener
- *
+ * Auxiliary typedefs and mask definitions
*/
+#include <libspi/keymasks.h>
-typedef void (*AccessibleEventListener) (AccessibleEvent *e);
-typedef void (*KeystrokeListener) (AccessibleEvent *e);
-
-
+#ifdef __cplusplus
+extern "C" {
+#endif
-/*
+/**
+ *AccessibleTextBoundaryType:
+ *@SPI_TEXT_BOUNDARY_CHAR:
+ *@SPI_TEXT_BOUNDARY_CURSOR_POS:
+ *@SPI_TEXT_BOUNDARY_WORD_START:
+ *@SPI_TEXT_BOUNDARY_WORD_END:
+ *@SPI_TEXT_BOUNDARY_SENTENCE_START:
+ *@SPI_TEXT_BOUNDARY_SENTENCE_END:
+ *@SPI_TEXT_BOUNDARY_LINE_START:
+ *@SPI_TEXT_BOUNDARY_LINE_END:
+ *@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
*
- * Basic SPI initialization and event loop function prototypes
+ *Text boundary types used for specifying boundaries for regions of text
+ **/
+typedef enum
+{
+ SPI_TEXT_BOUNDARY_CHAR,
+ SPI_TEXT_BOUNDARY_CURSOR_POS,
+ SPI_TEXT_BOUNDARY_WORD_START,
+ SPI_TEXT_BOUNDARY_WORD_END,
+ SPI_TEXT_BOUNDARY_SENTENCE_START,
+ SPI_TEXT_BOUNDARY_SENTENCE_END,
+ SPI_TEXT_BOUNDARY_LINE_START,
+ SPI_TEXT_BOUNDARY_LINE_END,
+ SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE
+} AccessibleTextBoundaryType;
+
+/**
+ *AccessibleTextClipType
+ *@SPI_TEXT_CLIP_NONE: No clipping to be done
+ *@SPI_TEXT_CLIP_MIN: Text clipped by min coordinate is omitted
+ *@SPI_TEXT_CLIP_MAX: Text clipped by max coordinate is omitted
+ *@SPI_TEXT_CLIP_BOTH: Only text fully within mix/max bound is retained
*
- */
-
-int
-SPI_init (void);
-
-void
-SPI_event_main (boolean isGNOMEApp);
-
-boolean
-SPI_eventIsReady ();
-
-AccessibleEvent *
-SPI_nextEvent (boolean waitForEvent);
-
-void
-SPI_exit (void);
-
-/*
+ *Describes the type of clipping required.
+ **/
+typedef enum
+{
+ SPI_TEXT_CLIP_NONE,
+ SPI_TEXT_CLIP_MIN,
+ SPI_TEXT_CLIP_MAX,
+ SPI_TEXT_CLIP_BOTH
+} AccessibleTextClipType;
+
+/**
+ *AccessibleRelationType:
+ *@SPI_RELATION_NULL:
+ *@SPI_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
+ *@SPI_RELATION_LABELED_BY: Indicates an object is labelled by one or more target objects.
+ *@SPI_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
+ *@SPI_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
+ *@SPI_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or
+more target objects.
+ *@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.
+ *@SPI_RELATION_EXTENDED:
+ *@SPI_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
+ * AtkObject in a sequential way, (for instance text-flow).
+ *@SPI_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
+ * another AtkObject in a sequential way, (for instance text-flow).
+ *@SPI_RELATION_SUBWINDOW_OF:
+ *@SPI_RELATION_EMBEDS: Indicates that the object visually embeds
+ * another object's content, i.e. this object's content flows around
+ * another's content.
+ *@SPI_RELATION_EMBEDDED_BY: Inverse of %SPI_RELATION_EMBEDS, indicates that
+ * this object's content is visualy embedded in another object.
+ *@SPI_RELATION_POPUP_FOR: Indicates that an object is a popup for another objec
+t.
+ *@SPI_RELATION_LAST_DEFINED:
*
- * Global functions serviced by the registry
+ *Describes the type of the relation
+ **/
+typedef enum
+{
+ SPI_RELATION_NULL,
+ SPI_RELATION_LABEL_FOR,
+ SPI_RELATION_LABELED_BY,
+ SPI_RELATION_CONTROLLER_FOR,
+ SPI_RELATION_CONTROLLED_BY,
+ SPI_RELATION_MEMBER_OF,
+ SPI_RELATION_NODE_CHILD_OF,
+ SPI_RELATION_EXTENDED,
+ SPI_RELATION_FLOWS_TO,
+ SPI_RELATION_FLOWS_FROM,
+ SPI_RELATION_SUBWINDOW_OF,
+ SPI_RELATION_EMBEDS,
+ SPI_RELATION_EMBEDDED_BY,
+ SPI_RELATION_POPUP_FOR,
+ SPI_RELATION_LAST_DEFINED
+} AccessibleRelationType;
+
+
+/* don't change the order of these ! */
+/**
+ *AccessibleCoordType:
+ *@SPI_COORD_TYPE_SCREEN: specifies xy coordinates relative to the screen
+ *@SPI_COORD_TYPE_WINDOW: specifies xy coordinates relative to an object's
+ * top-level window
*
- */
-
-boolean
-RegisterGlobalEventListener (AccessibleEventListener listener,
- char *eventType);
-
-int
-GetDesktopCount ();
-
-Accessible
-*getDesktop (int n);
-
-int
-getDesktopList (Accessible **list);
-
-void
-registerKeystrokeListener (KeystrokeListener *listener);
-
-void
-generateKeyEvent (long keyCode, long meta);
-
-void
-generateMouseEvent (long x, long y, char *name);
+ *Specifies how xy coordinates are to be interpreted. Used by functions such
+ *as AccessibleComponent_getPosition() and AccessibleText_getCharacterExtents()
+ **/
+typedef enum {
+ SPI_COORD_TYPE_SCREEN,
+ SPI_COORD_TYPE_WINDOW
+} AccessibleCoordType;
-/*
+/**
+ *AccessibleKeySynthType:
+ *@SPI_KEY_PRESS:
+ *@SPI_KEY_RELEASE:
+ *@SPI_KEY_PRESSRELEASE:
+ *@SPI_KEY_SYM:
+ *@SPI_KEY_STRING:
*
- * Accessible function prototypes
+ *Specified the type of a generated event.
+ **/
+typedef enum {
+ SPI_KEY_PRESS,
+ SPI_KEY_RELEASE,
+ SPI_KEY_PRESSRELEASE,
+ SPI_KEY_SYM,
+ SPI_KEY_STRING
+} AccessibleKeySynthType;
+
+/**
+ *AccessibleKeyListenerSyncType:
+ *@SPI_KEYLISTENER_NOSYNC:
+ *@SPI_KEYLISTENER_SYNCHRONOUS:
+ *@SPI_KEYLISTENER_CANCONSUME:
+ *@SPI_KEYLISTENER_ALL_WINDOWS:
*
- */
-
-int
-Accessible_ref (Accessible *obj);
-
-int
-Accessible_unref (Accessible *obj);
-
-char *
-Accessible_getName (Accessible *obj);
-
-char *
-Accessible_getDescription (Accessible *obj);
-
-Accessible *
-Accessible_getParent (Accessible *obj);
-
-long
-Accessible_getChildCount (Accessible *obj);
-
-Accessible *
-Accessible_getChildAtIndex (Accessible *obj,
- long childIndex);
-
-long
-Accessible_getIndexInParent (Accessible *obj);
-
-AccessibleRelation **
-Accessible_getRelationSet (Accessible *obj);
-
-char *
-Accessible_getRole (Accessible *obj);
-
-AccessibleStateSet *
-Accessible_getStateSet (Accessible *obj);
-
-
-/*
+ *Specified the tyupe of a key listener event.
+ **/
+typedef enum {
+ SPI_KEYLISTENER_NOSYNC = 0,
+ SPI_KEYLISTENER_SYNCHRONOUS = 1,
+ SPI_KEYLISTENER_CANCONSUME = 2,
+ SPI_KEYLISTENER_ALL_WINDOWS = 4
+} AccessibleKeyListenerSyncType;
+
+
+/**
+ *AccessibleStreamableContentSeekType
+ *@SPI_STREAM_SEEK_SET: seek from the 'top' of the streamable
+ *@SPI_STREAM_SEEK_CUR: seek from the current position in the stream
+ *@SPI_STREAM_SEEK_END: seek from the end of the stream (if known)
*
- * AccessibleAction function prototypes
+ *The seek type for a specified offset in AccessibleStreamableContent_seek.
+ **/
+typedef enum
+{
+ SPI_STREAM_SEEK_SET,
+ SPI_STREAM_SEEK_CUR,
+ SPI_STREAM_SEEK_END
+} AccessibleStreamableContentSeekType;
+
+typedef struct _SPIException SPIException;
+
+typedef SPIBoolean
+(* SPIExceptionHandler) (SPIException *err, SPIBoolean is_fatal);
+
+typedef enum {
+ SPI_EXCEPTION_UNSPECIFIED,
+ SPI_EXCEPTION_DISCONNECT,
+ SPI_EXCEPTION_NO_IMPL,
+ SPI_EXCEPTION_IO,
+ SPI_EXCEPTION_BAD_DATA
+} SPIExceptionCode;
+
+typedef enum {
+ SPI_EXCEPTION_SOURCE_UNSPECIFIED,
+ SPI_EXCEPTION_SOURCE_ACCESSIBLE,
+ SPI_EXCEPTION_SOURCE_REGISTRY,
+ SPI_EXCEPTION_SOURCE_DEVICE
+} SPIExceptionType;
+
+typedef unsigned long AccessibleKeyEventMask;
+typedef unsigned long AccessibleDeviceEventMask;
+
+typedef struct {
+ long x;
+ long y;
+ long width;
+ long height;
+} SPIRect;
+
+/**
+ *AccessibleComponentLayer:
+ *@SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
+ *@SPI_LAYER_BACKGROUND: Component belongs to the destop background.
+ *@SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
+ *@SPI_LAYER_WIDGET: Component is a 'normal' widget.
+ *@SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
+ * Z-information relative to other MDI-layer components.
+ *@SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
+ * MDI components.
+ *@SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
+ * for future use.
+ *@SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
+ * relative to other window-layer components.
+ *@SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
+ * should not be encountered.
*
- */
-
-int
-AccessibleAction_ref (
- AccessibleAction *obj);
-
-int
-AccessibleAction_unref (AccessibleAction *obj);
-
-long
-AccessibleAction_getNActions (AccessibleAction *obj);
-
-char *
-AccessibleAction_getDescription (AccessibleAction *obj,
- long index);
-
-void
-AccessibleAction_doAction (AccessibleAction *obj,
- long index);
-
-char *
-AccessibleAction_getKeyBinding (AccessibleAction *obj,
- long index);
-
-/*
+ * Describes the layer of a component.
*
- * AccessibleApplication function prototypes
+ * These enumerated "layer values" are used when determining which UI
+ * rendering layer a component is drawn into, which can help in making
+ * determinations of when components occlude one another.
+ **/
+typedef enum {
+ SPI_LAYER_INVALID,
+ SPI_LAYER_BACKGROUND,
+ SPI_LAYER_CANVAS,
+ SPI_LAYER_WIDGET,
+ SPI_LAYER_MDI,
+ SPI_LAYER_POPUP,
+ SPI_LAYER_OVERLAY,
+ SPI_LAYER_WINDOW,
+ SPI_LAYER_LAST_DEFINED
+} AccessibleComponentLayer;
+
+
+/**
+ * AccessibleTextRange:
+ * @start: the first nominal character position within the range.
+ * @end: the first nominal character position following the range.
+ * @content: The actual text content between @start and @end, as a UTF-8 string.
*
- */
-
-int
-AccessibleApplication_ref (AccessibleApplication *obj);
-
-int
-AccessibleApplication_unref (AccessibleApplication *obj);
-
-char *
-AccessibleApplication_getToolkitName (AccessibleApplication *obj);
-
-char *
-AccessibleApplication_getVersion (AccessibleApplication *obj);
-
-long
-AccessibleApplication_getID (AccessibleApplication *obj);
-
-boolean
-AccessibleApplication_pause (AccessibleApplication *obj);
-
-boolean
-AccessibleApplication_resume (AccessibleApplication *obj);
+ * Structure which encapsulates a text range - must be associated with an
+ * AccessibleText-implementing object.
+ **/
+typedef struct _AccessibleTextRange
+{
+ long int start;
+ long int end;
+ char *contents;
+} AccessibleTextRange;
+
+/**
+ * AccessibleKeySet:
+ * @keysyms:
+ * @keycodes:
+ * @len:
+ *
+ * Structure containing identifying information about a set of keycode or
+ * keysyms.
+ **/
+typedef struct _AccessibleKeySet
+{
+ unsigned long *keysyms;
+ unsigned short *keycodes;
+ char **keystrings;
+ short len;
+} AccessibleKeySet;
/*
- *
- * AccessibleComponent function prototypes
- *
+ * A special value for an AccessibleKeySet type, which tacitly
+ * includes all keycodes and keyvals for the specified modifier set.
*/
+#define SPI_KEYSET_ALL_KEYS NULL
-int
-AccessibleComponent_ref (AccessibleComponent *obj);
-
-int
-AccessibleComponent_unref (AccessibleComponent *obj);
-
-boolean
-AccessibleComponent_contains (AccessibleComponent *obj,
- long x,
- long y,
- AccessibleCoordType ctype);
-
-Accessible *
-AccessibleComponent_getAccessibleAtPoint (AccessibleComponent *obj,
- long x,
- long y,
- AccessibleCoordType ctype);
-
-void
-AccessibleComponent_getExtents (AccessibleComponent *obj,
- long *x,
- long *y,
- long *width,
- long *height,
- AccessibleCoordType ctype);
-
-void
-AccessibleComponent_getPosition (AccessibleComponent *obj,
- long *x,
- long *y,
- AccessibleCoordType ctype);
-
-void
-AccessibleComponent_getSize (AccessibleComponent *obj,
- long *width,
- long *height);
-
-void
-AccessibleComponent_grabFocus (AccessibleComponent *obj);
-
-/*
- *
- * AccessibleEditableText function prototypes
+typedef unsigned long AccessibleModifierMaskType;
+/**
+ *AccessibleKeyMaskType:
*
- */
+ *AccessibleKeyMaskType is a mask which is a set of key event modifiers
+ *which is specified in SPI_registerAccessibleKeystrokeListener.
+ **/
+
+typedef AccessibleModifierMaskType AccessibleKeyMaskType;
+
+/* Basic SPI initialization and event loop function prototypes */
+
+int SPI_init (void);
+void SPI_event_main (void);
+void SPI_event_quit (void);
+SPIBoolean SPI_eventIsReady (void);
+AccessibleEvent *SPI_nextEvent (SPIBoolean waitForEvent);
+int SPI_exit (void);
+
+/* Event Listener creation and support. */
+
+void SPI_freeAccessibleKeySet (
+ AccessibleKeySet *keyset);
+AccessibleKeySet * SPI_createAccessibleKeySet (
+ int len,
+ const char *keysyms,
+ short *keycodes,
+ const char **keystrings);
+AccessibleEventListener * SPI_createAccessibleEventListener (
+ AccessibleEventListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleEventListener_addCallback (
+ AccessibleEventListener *listener,
+ AccessibleEventListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleEventListener_removeCallback (
+ AccessibleEventListener *listener,
+ AccessibleEventListenerCB callback);
+void AccessibleEventListener_unref (
+ AccessibleEventListener *listener);
+
+/* Device Event Listener creation and support. */
+
+/* First four are deprecated in favor of the last four; really just a re-name */
+
+AccessibleKeystrokeListener * SPI_createAccessibleKeystrokeListener (
+ AccessibleKeystrokeListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleKeystrokeListener_addCallback (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeystrokeListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleKeystrokeListener_removeCallback (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeystrokeListenerCB callback);
+void AccessibleKeystrokeListener_unref (
+ AccessibleKeystrokeListener *listener);
+
+AccessibleDeviceListener * SPI_createAccessibleDeviceListener (
+ AccessibleDeviceListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleDeviceListener_addCallback (
+ AccessibleDeviceListener *listener,
+ AccessibleDeviceListenerCB callback,
+ void *user_data);
+SPIBoolean AccessibleDeviceListener_removeCallback (
+ AccessibleDeviceListener *listener,
+ AccessibleDeviceListenerCB callback);
+void AccessibleDeviceListener_unref (
+ AccessibleDeviceListener *listener);
+
+/* Global functions serviced by the registry */
+
+SPIBoolean SPI_registerGlobalEventListener (
+ AccessibleEventListener *listener,
+ const char *eventType);
+SPIBoolean SPI_deregisterGlobalEventListener (
+ AccessibleEventListener *listener,
+ const char *eventType);
+SPIBoolean SPI_deregisterGlobalEventListenerAll (
+ AccessibleEventListener *listener);
+SPIBoolean SPI_registerAccessibleKeystrokeListener (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeySet *keys,
+ AccessibleKeyMaskType modmask,
+ AccessibleKeyEventMask eventmask,
+ AccessibleKeyListenerSyncType sync_type);
+SPIBoolean SPI_deregisterAccessibleKeystrokeListener (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeyMaskType modmask);
+
+SPIBoolean SPI_registerDeviceEventListener (
+ AccessibleDeviceListener *listener,
+ AccessibleDeviceEventMask eventmask,
+ void *filter);
+SPIBoolean SPI_deregisterDeviceEventListener (
+ AccessibleDeviceListener *listener,
+ void *filter);
+
+int SPI_getDesktopCount (void);
+Accessible *SPI_getDesktop (int i);
+int SPI_getDesktopList (Accessible ***desktop_list);
+void SPI_freeDesktopList (Accessible **desktop_list);
+
+SPIBoolean SPI_generateKeyboardEvent (long int keyval,
+ char *keystring,
+ AccessibleKeySynthType synth_type);
+
+SPIBoolean SPI_generateMouseEvent (long int x, long int y, char *name);
+
+/* Accessible function prototypes */
+
+void Accessible_ref (Accessible *obj);
+void Accessible_unref (Accessible *obj);
+char * Accessible_getName (Accessible *obj);
+char * Accessible_getDescription (Accessible *obj);
+Accessible * Accessible_getParent (Accessible *obj);
+long Accessible_getChildCount (Accessible *obj);
+Accessible * Accessible_getChildAtIndex (Accessible *obj,
+ long int childIndex);
+long Accessible_getIndexInParent (Accessible *obj);
+AccessibleRelation **Accessible_getRelationSet (Accessible *obj);
+AccessibleRole Accessible_getRole (Accessible *obj);
+char * Accessible_getRoleName (Accessible *obj);
+char * Accessible_getLocalizedRoleName (Accessible *obj);
+AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
+
+/* Interface query methods */
+
+SPIBoolean Accessible_isAction (Accessible *obj);
+SPIBoolean Accessible_isApplication (Accessible *obj);
+SPIBoolean Accessible_isComponent (Accessible *obj);
+SPIBoolean Accessible_isEditableText (Accessible *obj);
+SPIBoolean Accessible_isHypertext (Accessible *obj);
+SPIBoolean Accessible_isImage (Accessible *obj);
+SPIBoolean Accessible_isSelection (Accessible *obj);
+SPIBoolean Accessible_isStreamableContent (Accessible *obj);
+SPIBoolean Accessible_isTable (Accessible *obj);
+SPIBoolean Accessible_isText (Accessible *obj);
+SPIBoolean Accessible_isValue (Accessible *obj);
+
+AccessibleAction * Accessible_getAction (Accessible *obj);
+AccessibleApplication * Accessible_getApplication (Accessible *obj);
+AccessibleComponent * Accessible_getComponent (Accessible *obj);
+AccessibleEditableText * Accessible_getEditableText (Accessible *obj);
+AccessibleHypertext * Accessible_getHypertext (Accessible *obj);
+AccessibleImage * Accessible_getImage (Accessible *obj);
+AccessibleSelection * Accessible_getSelection (Accessible *obj);
+AccessibleStreamableContent * Accessible_getStreamableContent (Accessible *obj);
+AccessibleTable * Accessible_getTable (Accessible *obj);
+AccessibleText * Accessible_getText (Accessible *obj);
+AccessibleValue * Accessible_getValue (Accessible *obj);
+AccessibleUnknown * Accessible_queryInterface (Accessible *obj,
+ const char *interface_name);
+
+/* AccessibleAction function prototypes */
+
+void AccessibleAction_ref (AccessibleAction *obj);
+void AccessibleAction_unref (AccessibleAction *obj);
+long AccessibleAction_getNActions (AccessibleAction *obj);
+char *AccessibleAction_getName (AccessibleAction *obj,
+ long int i);
+char *AccessibleAction_getDescription (AccessibleAction *obj,
+ long int i);
+SPIBoolean AccessibleAction_doAction (AccessibleAction *obj,
+ long int i);
+char *AccessibleAction_getKeyBinding (AccessibleAction *obj,
+ long int i);
+
+/* AccessibleApplication function prototypes */
+
+void AccessibleApplication_ref (AccessibleApplication *obj);
+void AccessibleApplication_unref (AccessibleApplication *obj);
+char *AccessibleApplication_getToolkitName (AccessibleApplication *obj);
+char *AccessibleApplication_getVersion (AccessibleApplication *obj);
+long AccessibleApplication_getID (AccessibleApplication *obj);
+char *AccessibleApplication_getLocale (AccessibleApplication *obj, int lc_category);
+SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj);
+SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj);
+
+/* AccessibleComponent function prototypes */
+
+void AccessibleComponent_ref (AccessibleComponent *obj);
+void AccessibleComponent_unref (AccessibleComponent *obj);
+SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj,
+ long int x,
+ long int y,
+ AccessibleCoordType ctype);
+Accessible *AccessibleComponent_getAccessibleAtPoint (
+ AccessibleComponent *obj,
+ long int x,
+ long int y,
+ AccessibleCoordType ctype);
+void AccessibleComponent_getExtents (AccessibleComponent *obj,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
+ AccessibleCoordType ctype);
+void AccessibleComponent_getPosition (AccessibleComponent *obj,
+ long int *x,
+ long int *y,
+ AccessibleCoordType ctype);
+void AccessibleComponent_getSize (AccessibleComponent *obj,
+ long int *width,
+ long int *height);
+AccessibleComponentLayer
+ AccessibleComponent_getLayer (AccessibleComponent *obj);
+SPIBoolean AccessibleComponent_grabFocus (AccessibleComponent *obj);
+short AccessibleComponent_getMDIZOrder(AccessibleComponent *obj);
+
+/* AccessibleEditableText function prototypes */
-int
+void
AccessibleEditableText_ref (AccessibleEditableText *obj);
-int
+void
AccessibleEditableText_unref (AccessibleEditableText *obj);
-void
+SPIBoolean
+AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
+ const char *attributes,
+ long int startOffset,
+ long int endOffset);
+
+SPIBoolean
AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
- char *newContents);
+ const char *newContents);
-void
+SPIBoolean
AccessibleEditableText_insertText (AccessibleEditableText *obj,
- long position,
- char *text,
- long length);
-
-boolean
-AccessibleEditableText_selectText (AccessibleEditableText *obj,
- long startPos,
- long endPos);
-
-boolean
-AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
- long startPos,
- long endPos,
- char *attributes);
+ long int position,
+ const char *text,
+ long int length);
-void
+SPIBoolean
AccessibleEditableText_copyText (AccessibleText *obj,
- long startPos,
- long endPos);
+ long int startPos,
+ long int endPos);
-void
+SPIBoolean
AccessibleEditableText_cutText (AccessibleEditableText *obj,
- long startPos,
- long endPos);
+ long int startPos,
+ long int endPos);
-void
+SPIBoolean
AccessibleEditableText_deleteText (AccessibleEditableText *obj,
- long startPos,
- long endPos);
+ long int startPos,
+ long int endPos);
-void
+SPIBoolean
AccessibleEditableText_pasteText (AccessibleEditableText *obj,
- long position);
+ long int position);
/*
*
* AccessibleHyperlink function prototypes
*
*/
-
-int
+void
AccessibleHyperlink_ref (AccessibleHyperlink *obj);
-
-int
+void
AccessibleHyperlink_unref (AccessibleHyperlink *obj);
long
char *
AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
- long i);
+ long int i);
-Accessible
-AccessibleHyperlink_getAnchor (AccessibleHyperlink *obj,
- long i);
+Accessible *
+AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
+ long int i);
void
AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
- long *startIndex,
- long *endIndex);
+ long int *startIndex,
+ long int *endIndex);
-boolean
+SPIBoolean
AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
/*
*
*/
-int
+void
AccessibleHypertext_ref (AccessibleHypertext *obj);
-int
+void
AccessibleHypertext_unref (AccessibleHypertext *obj);
long
AccessibleHypertext_getNLinks (AccessibleHypertext *obj);
AccessibleHyperlink *
-AccessibleHyperText_getLink (AccessibleHypertext *obj,
- long linkIndex);
+AccessibleHypertext_getLink (AccessibleHypertext *obj,
+ long int linkIndex);
long
AccessibleHypertext_getLinkIndex (AccessibleHypertext *obj,
- long characterIndex);
+ long int characterOffset);
/*
*
*
*/
-int
+void
AccessibleImage_ref (AccessibleImage *obj);
-int
+void
AccessibleImage_unref (AccessibleImage *obj);
char *
void
AccessibleImage_getImageSize (AccessibleImage *obj,
- long *width,
- long *height,
- AccessibleCoordType ctype);
+ long int *width,
+ long int *height);
+
void
AccessibleImage_getImagePosition (AccessibleImage *obj,
- long *x,
- long *y,
+ long int *x,
+ long int *y,
AccessibleCoordType ctype);
+void
+AccessibleImage_getImageExtents (AccessibleImage *obj,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
+ AccessibleCoordType ctype);
/*
*
* AccessibleRelation function prototypes
*
*/
-int
-AccessibleRelation_ref (AccessibleRelation *obj);
-
-int
-AccessibleRelation_unref (AccessibleRelation *obj);
+void AccessibleRelation_ref (AccessibleRelation *obj);
+void AccessibleRelation_unref (AccessibleRelation *obj);
-RELATION_TYPE
+AccessibleRelationType
AccessibleRelation_getRelationType (AccessibleRelation *obj);
-Accessible *
-AccessibleRelation_getTarget (AccessibleRelation *obj);
+int
+AccessibleRelation_getNTargets (AccessibleRelation *obj);
+Accessible *
+AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
/*
*
*/
-int
-AccessibleSelection_ref (AccessibleSelection *obj);
-
-int
-AccessibleSelection_unref (AccessibleSelection *obj);
+void AccessibleSelection_ref (AccessibleSelection *obj);
+void AccessibleSelection_unref (AccessibleSelection *obj);
long
-AccessibleSelwection_getNSelectedChildren (AccessibleSelection *obj);
+AccessibleSelection_getNSelectedChildren (AccessibleSelection *obj);
Accessible *
AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
- long selectedChildIndex);
+ long int selectedChildIndex);
-boolean
+SPIBoolean
AccessibleSelection_selectChild (AccessibleSelection *obj,
- long childIndex);
+ long int childIndex);
-boolean
+SPIBoolean
AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
- long selectedChildIndex);
+ long int selectedChildIndex);
-boolean
+SPIBoolean
AccessibleSelection_isChildSelected (AccessibleSelection *obj,
- long childIndex);
+ long int childIndex);
-void
+SPIBoolean
AccessibleSelection_selectAll (AccessibleSelection *obj);
-void
+SPIBoolean
AccessibleSelection_clearSelection (AccessibleSelection *obj);
*
*/
-int
-AccessibleStateSet_ref (AccessibleStateSet *obj);
+void AccessibleStateSet_ref (AccessibleStateSet *obj);
+void AccessibleStateSet_unref (AccessibleStateSet *obj);
-int
-AccessibleStateSet_unref (AccessibleStateSet *obj);
-
-boolean
+SPIBoolean
AccessibleStateSet_contains (AccessibleStateSet *obj,
- ACCESSIBLE_STATE state);
+ AccessibleState state);
void
AccessibleStateSet_add (AccessibleStateSet *obj,
- ACCESSIBLE_STATE state);
+ AccessibleState state);
void
AccessibleStateSet_remove (AccessibleStateSet *obj,
- ACCESSIBLE_STATE state);
+ AccessibleState state);
-boolean
+SPIBoolean
AccessibleStateSet_equals (AccessibleStateSet *obj,
AccessibleStateSet *obj2);
-void
+AccessibleStateSet *
AccessibleStateSet_compare (AccessibleStateSet *obj,
- AccessibleStateSet *obj2,
- AccessibleStateSet **differenceSet);
+ AccessibleStateSet *obj2);
-boolean
+SPIBoolean
AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
-
+void
+AccessibleStreamableContent_ref (AccessibleStreamableContent *obj);
+void
+AccessibleStreamableContent_unref (AccessibleStreamableContent *obj);
+char **
+AccessibleStreamableContent_getContentTypes (AccessibleStreamableContent *obj);
+void
+AccessibleStreamableContent_freeContentTypeList (AccessibleStreamableContent *obj,
+ char **list);
+SPIBoolean
+AccessibleStreamableContent_open (AccessibleStreamableContent *obj,
+ const char *content_type);
+SPIBoolean
+AccessibleStreamableContent_close (AccessibleStreamableContent *obj);
+
+long int
+AccessibleStreamableContent_seek (AccessibleStreamableContent *obj,
+ long int offset,
+ AccessibleStreamableContentSeekType seek_type);
+SPIBoolean
+AccessibleStreamableContent_read (AccessibleStreamableContent *obj,
+ void *buff,
+ long int nbytes,
+ unsigned int read_type);
/*
*
* AccessibleTable function prototypes
*
*/
-int
-AccessibleTable_ref (AccessibleTable *obj);
-
-int
-AccessibleTable_unref (AccessibleTable *obj);
+void AccessibleTable_ref (AccessibleTable *obj);
+void AccessibleTable_unref (AccessibleTable *obj);
Accessible *
AccessibleTable_getCaption (AccessibleTable *obj);
Accessible *
AccessibleTable_getAccessibleAt (AccessibleTable *obj,
- long row,
- long column);
+ long int row,
+ long int column);
long
AccessibleTable_getIndexAt (AccessibleTable *obj,
- long row,
- long column);
+ long int row,
+ long int column);
long
AccessibleTable_getRowAtIndex (AccessibleTable *obj,
- long index);
+ long int index);
long
AccessibleTable_getColumnAtIndex (AccessibleTable *obj,
- long index);
+ long int index);
char *
-AccessibleTable_getRowDescription (AccessibleTable *obj);
+AccessibleTable_getRowDescription (AccessibleTable *obj,
+ long int row);
char *
-AccessibleTable_getColumnDescription (AccessibleTable *obj);
+AccessibleTable_getColumnDescription (AccessibleTable *obj,
+ long int column);
long
AccessibleTable_getRowExtentAt (AccessibleTable *obj,
- long row,
- long column);
+ long int row,
+ long int column);
long
AccessibleTable_getColumnExtentAt (AccessibleTable *obj,
- long row,
- long column);
+ long int row,
+ long int column);
-AccessibleTable *
-AccessibleTable_getRowHeaders (AccessibleTable *obj);
+Accessible *
+AccessibleTable_getRowHeader (AccessibleTable *obj,
+ long int row);
-AccessibleTable *
-AccessibleTable_getColumnHeaders (AccessibleTable *obj);
+Accessible *
+AccessibleTable_getColumnHeader (AccessibleTable *obj,
+ long int column);
long
AccessibleTable_getNSelectedRows (AccessibleTable *obj);
-void
+long
AccessibleTable_getSelectedRows (AccessibleTable *obj,
- long **selectedRows);
+ long int **selectedRows);
long
AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
-void
+long
AccessibleTable_getSelectedColumns (AccessibleTable *obj,
- long **selectedColumns);
+ long int **selectedColumns);
-boolean
+SPIBoolean
AccessibleTable_isRowSelected (AccessibleTable *obj,
- long row);
+ long int row);
-boolean
+SPIBoolean
AccessibleTable_isColumnSelected (AccessibleTable *obj,
- long column);
+ long int column);
-boolean
+SPIBoolean
AccessibleTable_isSelected (AccessibleTable *obj,
- long row,
- long column);
+ long int row,
+ long int column);
+
+SPIBoolean
+AccessibleTable_addRowSelection (AccessibleTable *obj,
+ long int row);
+SPIBoolean
+AccessibleTable_addColumnSelection (AccessibleTable *obj,
+ long int column);
+
+SPIBoolean
+AccessibleTable_removeRowSelection (AccessibleTable *obj,
+ long int row);
+SPIBoolean
+AccessibleTable_removeColumnSelection (AccessibleTable *obj,
+ long int column);
/*
*
*
*/
-int
-AccessibleText_ref (AccessibleText *obj);
-
-int
-AccessibleText_unref (AccessibleText *obj);
+void AccessibleText_ref (AccessibleText *obj);
+void AccessibleText_unref (AccessibleText *obj);
long
AccessibleText_getCharacterCount (AccessibleText *obj);
char *
AccessibleText_getText (AccessibleText *obj,
- long startOffset,
- long endOffset);
+ long int startOffset,
+ long int endOffset);
long
AccessibleText_getCaretOffset (AccessibleText *obj);
-boolean
+char *
+AccessibleText_getAttributes (AccessibleText *obj,
+ long int offset,
+ long int *startOffset,
+ long int *endOffset);
+
+char *
+AccessibleText_getDefaultAttributes (AccessibleText *obj);
+
+SPIBoolean
AccessibleText_setCaretOffset (AccessibleText *obj,
- long newOffset);
+ long int newOffset);
char *
AccessibleText_getTextBeforeOffset (AccessibleText *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type);
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
char *
-AccessibleText_getTextAtOffset (Accessible *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type);
+AccessibleText_getTextAtOffset (AccessibleText *obj,
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
char *
AccessibleText_getTextAfterOffset (AccessibleText *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type);
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
-char
+unsigned long
AccessibleText_getCharacterAtOffset (AccessibleText *obj,
- long offset);
+ long int offset);
-char *
-AccessibleText_getAttributes (AccessibleText *obj,
- long startOffset,
- long endOffset);
-
-boolean
+void
AccessibleText_getCharacterExtents (AccessibleText *obj,
- long offset,
- long *x,
- long *y,
- long *width,
- long *height);
+ long int offset,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
+ AccessibleCoordType type);
+
+void
+AccessibleText_getRangeExtents (AccessibleText *obj,
+ long int startOffset,
+ long int endOffset,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
+ AccessibleCoordType type);
+
+AccessibleTextRange **
+AccessibleText_getBoundedRanges (AccessibleText *obj,
+ long int x,
+ long int y,
+ long int width,
+ long int height,
+ AccessibleCoordType type,
+ AccessibleTextClipType clipTypeX,
+ AccessibleTextClipType clipTypeY);
+
+void
+AccessibleTextRange_freeRanges (AccessibleTextRange **ranges);
long
AccessibleText_getOffsetAtPoint (AccessibleText *obj,
- long x,
- long y);
+ long int x,
+ long int y,
+ AccessibleCoordType type);
-char *
-AccessibleText_getSelectedText (AccessibleText *obj);
+long
+AccessibleText_getNSelections (AccessibleText *obj);
void
-AccessibleText_getSelectionBounds (AccessibleText *obj,
- long *startOffset,
- long *endOffset);
+AccessibleText_getSelection (AccessibleText *obj,
+ long int selectionNum,
+ long int *startOffset,
+ long int *endOffset);
+
+
+SPIBoolean
+AccessibleText_addSelection (AccessibleText *obj,
+ long int startOffset,
+ long int endOffset);
+
+SPIBoolean
+AccessibleText_removeSelection (AccessibleText *obj,
+ long int selectionNum);
+
+SPIBoolean
+AccessibleText_setSelection (AccessibleText *obj,
+ long int selectionNum,
+ long int startOffset,
+ long int endOffset);
+
+/* AccessibleValue Function Prototypes: */
-boolean
-AccessibleText_setSelectionBounds (AccessibleText *obj,
- long startOffset,
- long endOffset);
+void AccessibleValue_ref (AccessibleValue *obj);
+void AccessibleValue_unref (AccessibleValue *obj);
+double AccessibleValue_getMinimumValue (AccessibleValue *obj);
+double AccessibleValue_getCurrentValue (AccessibleValue *obj);
+double AccessibleValue_getMaximumValue (AccessibleValue *obj);
+SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj,
+ double newValue);
+
+/* Persistance and lifecycle control for AccessibleEvents. */
+SPIBoolean AccessibleEvent_ref (const AccessibleEvent *e);
+void AccessibleEvent_unref (const AccessibleEvent *e);
/*
- *
- * AccessibleValue Function Prototypes:
- *
+ * Prototypes for accessor functions, to obtain context
+ * information for accessible events.
*/
-float
-AccessibleValue_getMinimumValue (AccessibleValue *value);
+char* AccessibleTextChangedEvent_getChangeString (const AccessibleEvent *e);
+Accessible * AccessibleChildChangedEvent_getChildAccessible (const AccessibleEvent *e);
+
+Accessible * AccessibleParentChangedEvent_getParentAccessible (const AccessibleEvent *e);
+
+char* AccessibleTextSelectionChangedEvent_getSelectionString (const AccessibleEvent *e);
+
+char* AccessibleWindowEvent_getTitleString (const AccessibleEvent *e);
+
+Accessible * AccessibleActiveDescendantChangedEvent_getActiveDescendant (const AccessibleEvent *e);
-float
-AccessibleValue_getCurrentValue (AccessibleValue *value);
+Accessible * AccessibleTableSummaryChangedEvent_getSummaryAccessible (const AccessibleEvent *e);
-float
-AccessibleValue_getMaximumValue (AccessibleValue *value);
+Accessible * AccessibleTableHeaderChangedEvent_getHeaderAccessible (const AccessibleEvent *e);
-boolean
-AccessibleValue_setCurrentValue (AccessibleValue *value,
- float newValue);
+char * AccessibleTableCaptionChangedEvent_getCaptionString (const AccessibleEvent *e);
+
+char * AccessibleTableRowDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char * AccessibleDescriptionChangedEvent_getDescriptionString (const AccessibleEvent *e);
+
+char * AccessibleNameChangedEvent_getNameString (const AccessibleEvent *e);
+SPIRect * AccessibleBoundsChangedEvent_getNewBounds (const AccessibleEvent *e);
+
+/* Misc methods and error handling */
+void SPI_freeString (char *s);
+
+char* SPI_dupString (char *s);
+
+void SPI_freeRect (SPIRect *rect);
+
+SPIBoolean SPI_exceptionHandlerPush (SPIExceptionHandler *handler);
+
+SPIExceptionHandler* SPI_exceptionHandlerPop (void);
+
+SPIExceptionType SPIException_getSourceType (SPIException *err);
+
+SPIExceptionCode SPIException_getExceptionCode (SPIException *err);
+
+Accessible* SPIAccessibleException_getSource (SPIException *err);
+
+char* SPIException_getDescription (SPIException *err);
+
+#ifdef __cplusplus
+}
+#endif
#endif