-
#ifndef _SPI_H
#define _SPI_H
-/* Implementation private definitions */
-#include "spi-impl.h"
+#include <glib/gmacros.h>
+
+#include <cspi/spi-impl.h>
+/*
+ * Definitions for AccessibleRole, AccessibleState,
+ * AccessibleEvent, and event listeners.
+ */
+#include <cspi/spi-roletypes.h>
+#include <cspi/spi-statetypes.h>
+#include <cspi/spi-listener.h>
/*
- * Definitions for ACCESSIBLE_STATE , ACCESSIBLE_ROLE, AccessibleEvent,
- * and event listeners.
+ * Auxiliary typedefs and mask definitions
*/
+#include <libspi/keymasks.h>
-#include "spi-roletypes.h"
-#include "spi-statetypes.h"
-#include "spi-listener.h"
+G_BEGIN_DECLS
/*
- *
* Enumerated type for text boundary types
- *
*/
-
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;
-
-
+ 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;
/*
*
typedef enum
{
- RELATION_LABEL_FOR,
- RELATION_LABELED_BY,
- RELATION_CONTROLLER_FOR,
- RELATION_CONTROLLED_BY,
- RELATION_MEMBER_OF
-} RELATION_TYPE;
+ SPI_RELATION_LABEL_FOR,
+ SPI_RELATION_LABELED_BY,
+ SPI_RELATION_CONTROLLER_FOR,
+ SPI_RELATION_CONTROLLED_BY,
+ SPI_RELATION_MEMBER_OF
+} AccessibleRelationType;
/* don't change the order of these ! */
-typedef enum _AccessibleCoordType {
- COORD_TYPE_SCREEN,
- COORD_TYPE_WINDOW
+typedef enum {
+ SPI_COORD_TYPE_SCREEN,
+ SPI_COORD_TYPE_WINDOW
} AccessibleCoordType;
-typedef enum _KeyEventType {
- KEY_PRESSED,
- KEY_RELEASED
-} KeyEventType;
-
-typedef enum _KeyListenerSyncType {
- KEYLISTENER_SYNCHRONOUS = 1,
- KEYLISTENER_CANCONSUME = 2,
- KEYLISTENER_ALLWINDOWS = 4
-} KeyListenerSyncType;
-
-typedef unsigned long KeyEventMask;
-
-typedef struct _KeyStroke
-{
- long keyID;
- short keycode;
- KeyEventType type;
- unsigned short modifiers;
-} KeyStroke;
-
-typedef struct _KeySet
+typedef enum {
+ SPI_KEY_PRESS,
+ SPI_KEY_RELEASE,
+ SPI_KEY_PRESSRELEASE,
+ SPI_KEY_SYM
+} AccessibleKeySynthType;
+
+typedef enum {
+ SPI_KEYLISTENER_NOSYNC = 0,
+ SPI_KEYLISTENER_SYNCHRONOUS = 1,
+ SPI_KEYLISTENER_CANCONSUME = 2,
+ SPI_KEYLISTENER_ALL_WINDOWS = 4
+} AccessibleKeyListenerSyncType;
+
+typedef unsigned long AccessibleKeyEventMask;
+
+/**
+ * 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_LAST_DEFINED: Used to determine the last valid value in the enum,
+ * should not be encountered.
+ **/
+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_LAST_DEFINED
+} AccessibleComponentLayer;
+
+
+/**
+ * AccessibleKeySet:
+ * @keysyms:
+ * @keycodes:
+ * @len:
+ *
+ * Structure containing identifying information about a set of keycode or
+ * keysyms.
+ **/
+typedef struct _AccessibleKeySet
{
unsigned long *keysyms;
unsigned short *keycodes;
short len;
-} KeySet;
-
-#define ALL_KEYS ((void *)NULL)
-
-/*
- *
- * Basic SPI initialization and event loop function prototypes
- *
- */
+} AccessibleKeySet;
/**
- * SPI_init:
- *
- * Connects to the accessibility registry and initializes the SPI.
- *
- * Returns: 0 on success, otherwise an integer error code.
+ * SPI_KEYSET_ALL_KEYS:
+ * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
+ * includes all keycodes and keyvals for the specified modifier set.
**/
-int
-SPI_init (void);
+#define SPI_KEYSET_ALL_KEYS NULL
-/**
- * SPI_event_main:
- * @isGNOMEApp: a #boolean indicating whether the client of the SPI
- * will use the Gnome event loop or not.
- *
- * Starts/enters the main event loop for the SPI services.
- *
- * (NOTE: This method does not return control, it is exited via a call to exit()
- * from within an event handler).
- *
- **/
-void
-SPI_event_main (boolean isGNOMEApp);
+typedef unsigned long AccessibleKeyMaskType;
-/**
- * SPI_event_is_ready:
- *
- * Checks to see if an SPI event is waiting in the event queue.
- * Used by clients that don't wish to use SPI_event_main().
- * Not Yet Implemented.
- *
- * Returns: #TRUE if an event is waiting, otherwise #FALSE.
- *
- **/
-boolean
-SPI_eventIsReady ();
-/**
- * SPI_nextEvent:
- *
- * Gets the next event in the SPI event queue; blocks if no event
- * is pending.
- * Used by clients that don't wish to use SPI_event_main().
- * Not Yet Implemented.
- *
- * Returns: the next #AccessibleEvent in the SPI event queue.
- *
- **/
-AccessibleEvent *
-SPI_nextEvent (boolean waitForEvent);
+/* Basic SPI initialization and event loop function prototypes */
-/**
- * SPI_exit:
- *
- * Disconnects from the Accessibility Registry and releases resources.
- * Not Yet Implemented.
- *
- **/
-void
-SPI_exit (void);
+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.
- */
+/* Event Listener creation and support. */
-/**
- * createEventListener:
- * @callback : an #AccessibleEventListenerCB callback function, or NULL.
- *
- * Create a new #AccessibleEventListener with a specified callback function.
- *
- * Returns: a pointer to a newly-created #AccessibleEventListener.
- *
- **/
AccessibleEventListener *
-createEventListener (AccessibleEventListenerCB callback);
-
-/**
- * EventListener_addCallback:
- * @listener: the #AccessibleEventListener instance to modify.
- * @callback: an #AccessibleEventListenerCB function pointer.
- *
- * Add an in-process callback function to an existing AccessibleEventListener.
- *
- * Returns: #TRUE if successful, otherwise #FALSE.
- *
- **/
-boolean
-EventListener_addCallback (AccessibleEventListener *listener,
- AccessibleEventListenerCB callback);
-
-/**
- * EventListener_removeCallback:
- * @listener: the #AccessibleEventListener instance to modify.
- * @callback: an #AccessibleEventListenerCB function pointer.
- *
- * Remove an in-process callback function from an existing AccessibleEventListener.
- *
- * Returns: #TRUE if successful, otherwise #FALSE.
- *
- **/
-boolean
-EventListener_removeCallback (AccessibleEventListener *listener,
- AccessibleEventListenerCB callback);
-
-/**
- * createKeyListener:
- * @callback : an #KeystrokeListenerCB callback function, or NULL.
- *
- * Create a new #KeystrokeListener with a specified callback function.
- *
- * Returns: a pointer to a newly-created #KeystrokeListener.
- *
- **/
-KeystrokeListener *
-createKeystrokeListener (KeystrokeListenerCB callback);
-
-/**
- * KeystrokeListener_addCallback:
- * @listener: the #KeystrokeListener instance to modify.
- * @callback: an #KeystrokeListenerCB function pointer.
- *
- * Add an in-process callback function to an existing #KeystrokeListener.
- *
- * Returns: #TRUE if successful, otherwise #FALSE.
- *
- **/
-boolean
-KeystrokeListener_addCallback (KeystrokeListener *listener,
- KeystrokeListenerCB callback);
-
-/**
- * KeystrokeListener_removeCallback:
- * @listener: the #KeystrokeListener instance to modify.
- * @callback: an #KeystrokeListenerCB function pointer.
- *
- * Remove an in-process callback function from an existing #KeystrokeListener.
- *
- * Returns: #TRUE if successful, otherwise #FALSE.
- *
- **/
-boolean
-KeystrokeListener_removeCallback (KeystrokeListener *listener,
- KeystrokeListenerCB callback);
-
-/*
- *
- * Global functions serviced by the registry
- *
- */
-
-/**
- * registerGlobalEventListener:
- * @listener: the #AccessibleEventListener to be registered against an event type.
- * @callback: a character string indicating the type of events for which
- * notification is requested. Format is
- * EventClass:major_type:minor_type:detail
- * where all subfields other than EventClass are optional.
- * EventClasses include "Focus", "Window", "Mouse",
- * and toolkit events (e.g. "Gtk", "AWT").
- * Examples: "focus:", "Gtk:GtkWidget:button_press_event".
- *
- * NOTE: this string may be UTF-8, but should not contain byte value 56 (ascii ':'),
- * except as a delimiter, since non-UTF-8 string delimiting
- * functions are used internally. In general, listening to
- * toolkit-specific events is not recommended.
- *
- * Add an in-process callback function to an existing AccessibleEventListener.
- *
- * Returns: #TRUE if successful, otherwise #FALSE.
- *
- **/
-boolean
-registerGlobalEventListener (AccessibleEventListener *listener,
- char *eventType);
-
-/**
- * getDesktopCount:
- *
- * Get the number of virtual desktops.
- * NOTE: currently multiple virtual desktops are not implemented, this
- * function always returns '1'.
- *
- * Returns: an integer indicating the number of active virtual desktops.
- *
- **/
-int
-getDesktopCount ();
+ 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);
+
+/* Keystroke Listener creation and support. */
+
+AccessibleKeystrokeListener *
+ 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);
+
+/* Global functions serviced by the registry */
+
+SPIBoolean registerGlobalEventListener (AccessibleEventListener *listener,
+ const char *eventType);
+SPIBoolean deregisterGlobalEventListener (AccessibleEventListener *listener,
+ const char *eventType);
+SPIBoolean deregisterGlobalEventListenerAll (AccessibleEventListener *listener);
+
+void registerAccessibleKeystrokeListener (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeySet *keys,
+ AccessibleKeyMaskType modmask,
+ AccessibleKeyEventMask eventmask,
+ AccessibleKeyListenerSyncType sync_type);
+void deregisterAccessibleKeystrokeListener (
+ AccessibleKeystrokeListener *listener,
+ AccessibleKeyMaskType modmask);
+
+int getDesktopCount (void);
+Accessible *getDesktop (int i);
+int getDesktopList (Accessible **list);
+
+void generateKeyEvent (long int keyval,
+ AccessibleKeySynthType synth_type);
+void 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);
+const char * Accessible_getRole (Accessible *obj);
+AccessibleStateSet * Accessible_getStateSet (Accessible *obj);
-/**
- * getDesktop:
- * @i: an integer indicating which of the accessible desktops is to be returned.
- *
- * Get the virtual desktop indicated by index @i.
- * NOTE: currently multiple virtual desktops are not implemented, this
- * function always returns '1'.
- *
- * Returns: a pointer to the 'i-th' virtual desktop's #Accessible representation.
- *
- **/
-Accessible*
-getDesktop (int n);
-
-/**
- * getDesktopList:
- * @list: a pointer to an array of #Accessible objects.
- *
- * Get the list of virtual desktops. On return, @list will point
- * to a newly-created array of virtual desktop pointers.
- * It is the responsibility of the caller to free this array when
- * it is no longer needed.
- *
- * Not Yet Implemented.
- *
- * Returns: an integer indicating how many virtual desktops have been
- * placed in the list pointed to by parameter @list.
- **/
-int
-getDesktopList (Accessible **list);
-
-/**
- * registerKeystrokeListener:
- * @listener: a pointer to the #KeystrokeListener for which
- * keystroke events are requested.
- *
- * Not Yet Implemented.
- *
- **/
-void
-registerKeystrokeListener (KeystrokeListener *listener,
- KeySet *keys,
- KeyMaskType modmask,
- KeyEventMask eventmask,
- KeyListenerSyncType sync_type);
-
-/**
- * generateKeyEvent:
- * @keycode: a #long indicating the keycode of the key event
- * being synthesized.
- * @meta: a #long indicating the key modifiers to be sent
- * with the event, if any.
- *
- * Synthesize a keyboard event (as if a hardware keyboard event occurred in the
- * current UI context).
- * Not Yet Implemented.
- *
- **/
-void
-generateKeyEvent (long keyCode, long meta);
+/* Interface query methods */
-/**
- * generateMouseEvent:
- * @x: a #long indicating the screen x coordinate of the mouse event.
- * @y: a #long indicating the screen y coordinate of the mouse event.
- * @name: a string indicating which mouse event to be synthesized
- * (e.g. "button1", "button2", "mousemove").
- *
- * Synthesize a mouse event at a specific screen coordinate.
- * Not Yet Implemented.
- *
- **/
-void
-generateMouseEvent (long x, long y, char *name);
+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_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);
+AccessibleTable * Accessible_getTable (Accessible *obj);
+AccessibleText * Accessible_getText (Accessible *obj);
+AccessibleValue * Accessible_getValue (Accessible *obj);
+GenericInterface * Accessible_queryInterface (Accessible *obj,
+ const char *interface_name);
/*
- *
- * Accessible function prototypes
- *
+ * AccessibleAction function prototypes
*/
-/**
- * Accessible_ref:
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Increment the reference count for an #Accessible object.
- *
- * Returns: (no return code implemented yet).
- *
- **/
-int
-Accessible_ref (Accessible *obj);
-
-/**
- * Accessible_unref:
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Decrement the reference count for an #Accessible object.
- *
- * Returns: (no return code implemented yet).
- *
- **/
-int
-Accessible_unref (Accessible *obj);
-
-/**
- * Accessible_getName:
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Get the name of an #Accessible object.
- *
- * Returns: a UTF-8 string indicating the name of the #Accessible object.
- *
- **/
-char *
-Accessible_getName (Accessible *obj);
-
-/**
- * Accessible_getDescription:
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Get the description of an #Accessible object.
- *
- * Returns: a UTF-8 string describing the #Accessible object.
- *
- **/
-char *
-Accessible_getDescription (Accessible *obj);
-
-/**
- * Accessible_getParent:
- * @obj: a pointer to the #Accessible object to query.
- *
- * Get an #Accessible object's parent container.
- *
- * Returns: a pointer to the #Accessible object which contains the given
- * #Accessible instance, or NULL if the @obj has no parent container.
- *
- **/
-Accessible *
-Accessible_getParent (Accessible *obj);
-
-/**
- * Accessible_getChildCount:
- *
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Get the number of children contained by an #Accessible object.
- *
- * Returns: a #long indicating the number of #Accessible children
- * contained by an #Accessible object.
- *
- **/
-long
-Accessible_getChildCount (Accessible *obj);
-
-/**
- * Accessible_getChildAtIndex:
- *
- * @obj: a pointer to the #Accessible object on which to operate.
- * @childIndex: a #long indicating which child is specified.
- *
- * Get the #Accessible child of an #Accessible object at a given index.
- *
- * Returns: a pointer to the #Accessible child object at index
- * @childIndex.
- *
- **/
-Accessible *
-Accessible_getChildAtIndex (Accessible *obj,
- long childIndex);
-
-/**
- * Accessible_getIndexInParent:
- *
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Get the index of an #Accessible object in its containing #Accessible.
- *
- * Returns: a #long indicating the index of the #Accessible object
- * in its parent (i.e. containing) #Accessible instance,
- * or -1 if @obj has no containing parent.
- *
- **/
+void AccessibleAction_ref (AccessibleAction *obj);
+void AccessibleAction_unref (AccessibleAction *obj);
long
-Accessible_getIndexInParent (Accessible *obj);
+AccessibleAction_getNActions (AccessibleAction *obj);
/**
- * Accessible_getRelationSet:
- *
- * Not Yet Implemented.
+ * AccessibleAction_getName:
+ * @obj: a pointer to the #AccessibleAction implementor to query.
+ * @i: a long integer indicating which action to query.
*
- **/
-AccessibleRelation **
-Accessible_getRelationSet (Accessible *obj);
-
-/**
- * Accessible_getRole:
- * @obj: a pointer to the #Accessible object on which to operate.
- *
- * Get the UI role of an #Accessible object.
+ * Get the name of the '@i-th' action invokable on an
+ * object implementing #AccessibleAction.
*
- * Returns: a UTF-8 string indicating the UI role of the #Accessible object.
+ * Returns: the 'event type' name of the action, as a UTF-8 string.
*
**/
char *
-Accessible_getRole (Accessible *obj);
-
-/**
- * Accessible_getStateSet:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleStateSet *
-Accessible_getStateSet (Accessible *obj);
-
-/* Interface query methods */
-
-/**
- * Accessible_isAction:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleAction.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleAction interface,
- * #FALSE otherwise.
- **/
-boolean
-Accessible_isAction (Accessible *obj);
-
-/**
- * Accessible_isComponent:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleComponent.
- *
- * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
- * #FALSE otherwise.
- **/
-boolean
-Accessible_isComponent (Accessible *obj);
-
-/**
- * Accessible_isEditableText:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleEditableText.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
- * #FALSE otherwise.
- **/
-boolean
-Accessible_isEditableText (Accessible *obj);
-
-/**
- * Accessible_isHypertext:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleHypertext.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
- * #FALSE otherwise.
- **/
-boolean
-Accessible_isHypertext (Accessible *obj);
-
-/**
- * Accessible_isImage:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleImage.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleImage interface,
- * #FALSE otherwise.
-**/
-boolean
-Accessible_isImage (Accessible *obj);
-
-/**
- * Accessible_isSelection:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleSelection.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
- * #FALSE otherwise.
-**/
-boolean
-Accessible_isSelection (Accessible *obj);
-
-/**
- * Accessible_isTable:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleTable.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleTable interface,
- * #FALSE otherwise.
-**/
-boolean
-Accessible_isTable (Accessible *obj);
-
-/**
- * Accessible_isText:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Query whether the specified #Accessible implements #AccessibleText.
- * Not Yet Implemented.
- *
- * Returns: #TRUE if @obj implements the #AccessibleText interface,
- * #FALSE otherwise.
-**/
-boolean
-Accessible_isText (Accessible *obj);
-
-/**
- * Accessible_getAction:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleAction *
-Accessible_getAction (Accessible *obj);
-
-/**
- * Accessible_getComponent:
- * @obj: a pointer to the #Accessible instance to query.
- *
- * Get the #AccessibleComponent interface for an #Accessible.
- *
- * Returns: a pointer to an #AccessibleComponent interface instance, or
- * NULL if @obj does not implement #AccessibleComponent.
- **/
-AccessibleComponent *
-Accessible_getComponent (Accessible *obj);
-
-/**
- * Accessible_getEditableText:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleEditableText *
-Accessible_getEditableText (Accessible *obj);
-
-/**
- * Accessible_getHypertext:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleHypertext *
-Accessible_getHypertext (Accessible *obj);
-
-/**
- * Accessible_getImage:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleImage *
-Accessible_getImage (Accessible *obj);
-
-/**
- * Accessible_getSelection:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleSelection *
-Accessible_getSelection (Accessible *obj);
-
-/**
- * Accessible_getTable:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleTable *
-Accessible_getTable (Accessible *obj);
-
-/**
- * Accessible_getText:
- *
- * Not Yet Implemented.
- *
- **/
-AccessibleText *
-Accessible_getText (Accessible *obj);
-
-/**
- * Accessible_queryInterface:
- * @obj: a pointer to the #Accessible instance to query.
- * @interface_name: a UTF-8 character string specifiying the requested interface.
- *
- * Query an #Accessible object to for a named interface.
- *
- * Returns: an instance of the named interface object, if it is implemented
- * by @obj, or NULL otherwise.
- *
- **/
-GenericInterface *
-Accessible_queryInterface (Accessible *obj, char *interface_name);
-
-/*
- *
- * AccessibleAction function prototypes
- *
- */
-
-int
-AccessibleAction_ref (
- AccessibleAction *obj);
-
-int
-AccessibleAction_unref (AccessibleAction *obj);
-
-long
-AccessibleAction_getNActions (AccessibleAction *obj);
+AccessibleAction_getName (AccessibleAction *obj, long int i);
/**
* AccessibleAction_getDescription:
* @obj: a pointer to the #AccessibleAction to query.
+ * @i: a long integer indicating which action to query.
*
- * Get the description of 'i-th' action invokable on an
+ * Get the description of '@i-th' action invokable on an
* object implementing #AccessibleAction.
*
- * Not Yet Implemented.
- *
- * Returns: a UTF-8 string describing the 'i-th' invokable action.
+ * Returns: a UTF-8 string describing the '@i-th' invokable action.
*
**/
char *
AccessibleAction_getDescription (AccessibleAction *obj,
- long index);
+ long int i);
-boolean
+SPIBoolean
AccessibleAction_doAction (AccessibleAction *obj,
- long index);
+ long int i);
+/**
+ * AccessibleAction_getKeybinding:
+ * @obj: a pointer to the #AccessibleAction implementor to query.
+ * @i: a long integer indicating which action to query.
+ *
+ * Get the keybindings for the @i-th action invokable on an
+ * object implementing #AccessibleAction, if any are defined.
+ *
+ * Returns: a UTF-8 string which can be parsed to determine the @i-th
+ * invokable action's keybindings.
+ *
+ **/
char *
AccessibleAction_getKeyBinding (AccessibleAction *obj,
- long index);
+ long int i);
/*
*
* Returns: (no return code implemented yet).
*
**/
-int
+void
AccessibleApplication_ref (AccessibleApplication *obj);
/**
* Returns: (no return code implemented yet).
*
**/
-int
+void
AccessibleApplication_unref (AccessibleApplication *obj);
/**
/**
* AccessibleApplication_pause:
+ * @obj: a pointer to the #Accessible object on which to operate.
*
* Attempt to pause the application (used when client event queue is
* over-full).
* Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
*
**/
-boolean
+SPIBoolean
AccessibleApplication_pause (AccessibleApplication *obj);
/**
- * AccessibleApplication_pause:
+ * AccessibleApplication_resume:
+ * @obj: a pointer to the #Accessible object on which to operate.
*
* Attempt to resume the application (used after #AccessibleApplication_pause).
* Not Yet Implemented.
* Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
*
**/
-boolean
+SPIBoolean
AccessibleApplication_resume (AccessibleApplication *obj);
/*
*
*/
-int
+void
AccessibleComponent_ref (AccessibleComponent *obj);
-int
+void
AccessibleComponent_unref (AccessibleComponent *obj);
-boolean
+SPIBoolean
AccessibleComponent_contains (AccessibleComponent *obj,
- long x,
- long y,
+ long int x,
+ long int y,
AccessibleCoordType ctype);
Accessible *
AccessibleComponent_getAccessibleAtPoint (AccessibleComponent *obj,
- long x,
- long y,
+ long int x,
+ long int y,
AccessibleCoordType ctype);
/**
**/
void
AccessibleComponent_getExtents (AccessibleComponent *obj,
- long *x,
- long *y,
- long *width,
- long *height,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
AccessibleCoordType ctype);
void
AccessibleComponent_getPosition (AccessibleComponent *obj,
- long *x,
- long *y,
+ long int *x,
+ long int *y,
AccessibleCoordType ctype);
void
AccessibleComponent_getSize (AccessibleComponent *obj,
- long *width,
- long *height);
+ long int *width,
+ long int *height);
+
+/**
+ * AccessibleComponent_getLayer:
+ * @obj: a pointer to the #AccessibleComponent to query.
+ *
+ * Query which layer the component is painted into, to help determine its
+ * visibility in terms of stacking order.
+ *
+ * Returns: the #AccessibleComponentLayer into which this component is painted.
+ **/
+AccessibleComponentLayer
+AccessibleComponent_getLayer (AccessibleComponent *obj);
+
+/**
+ * AccessibleComponent_getMDIZOrder:
+ * @obj: a pointer to the #AccessibleComponent to query.
+ *
+ * Query the z stacking order of a component which is in the MDI layer.
+ *
+ * Returns: a short integer indicating the stacking order of the component
+ * in the MDI layer, or -1 if the component is not in the MDI layer.
+ **/
+short
+AccessibleComponent_getMDIZOrder (AccessibleComponent *obj);
void
AccessibleComponent_grabFocus (AccessibleComponent *obj);
*
*/
-int
+void
AccessibleEditableText_ref (AccessibleEditableText *obj);
-int
+void
AccessibleEditableText_unref (AccessibleEditableText *obj);
-boolean
-AccessibleEditableText_setRunAttributes (AccessibleEditableText *obj,
- const char *attributes,
- long startPos, long endPos);
+SPIBoolean
+AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
+ const char *attributes,
+ long int startOffset,
+ long int endOffset);
-void
+SPIBoolean
AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
const char *newContents);
-void
+SPIBoolean
AccessibleEditableText_insertText (AccessibleEditableText *obj,
- long position,
- char *text,
- long length);
+ 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);
/*
*
*
*/
-int
-AccessibleHyperlink_ref (AccessibleHyperlink *obj);
-
-int
-AccessibleHyperlink_unref (AccessibleHyperlink *obj);
-
long
AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj);
char *
AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
- long i);
+ long int i);
-Accessible
+Accessible *
AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
- long i);
+ 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);
+ 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
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
*
*/
-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);
*
*/
-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);
AccessibleTable_getNColumns (AccessibleTable *obj);
Accessible *
-AccessibleTable_refAt (AccessibleTable *obj,
- long row,
- long column);
+AccessibleTable_getAccessibleAt (AccessibleTable *obj,
+ 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,
- long row);
+ long int row);
char *
AccessibleTable_getColumnDescription (AccessibleTable *obj,
- long column);
+ 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);
Accessible *
AccessibleTable_getRowHeader (AccessibleTable *obj,
- long row);
+ long int row);
Accessible *
AccessibleTable_getColumnHeader (AccessibleTable *obj,
- long column);
+ long int column);
long
AccessibleTable_getNSelectedRows (AccessibleTable *obj);
long
AccessibleTable_getSelectedRows (AccessibleTable *obj,
- long **selectedRows);
+ long int **selectedRows);
long
AccessibleTable_getNSelectedColumns (AccessibleTable *obj);
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);
/*
*
*
*/
-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);
char *
AccessibleText_getAttributes (AccessibleText *obj,
- long offset,
- long *startOffset,
- long *endOfset);
+ long int offset,
+ long int *startOffset,
+ long int *endOffset);
-boolean
+SPIBoolean
AccessibleText_setCaretOffset (AccessibleText *obj,
- long newOffset);
+ long int newOffset);
char *
AccessibleText_getTextBeforeOffset (AccessibleText *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type,
- long *startOffset, long *endOffset);
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
char *
AccessibleText_getTextAtOffset (AccessibleText *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type,
- long *startOffset, long *endOffset);
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
char *
AccessibleText_getTextAfterOffset (AccessibleText *obj,
- long offset,
- TEXT_BOUNDARY_TYPE type,
- long *startOffset, long *endOffset);
+ long int offset,
+ AccessibleTextBoundaryType type,
+ long int *startOffset,
+ long int *endOffset);
+
unsigned long
AccessibleText_getCharacterAtOffset (AccessibleText *obj,
- long offset);
+ long int offset);
void
AccessibleText_getCharacterExtents (AccessibleText *obj,
- long offset,
- long *x,
- long *y,
- long *width,
- long *height, AccessibleCoordType type);
+ long int offset,
+ long int *x,
+ long int *y,
+ long int *width,
+ long int *height,
+ AccessibleCoordType type);
long
AccessibleText_getOffsetAtPoint (AccessibleText *obj,
- long x,
- long y, AccessibleCoordType type);
+ long int x,
+ long int y,
+ AccessibleCoordType type);
long
AccessibleText_getNSelections (AccessibleText *obj);
void
AccessibleText_getSelection (AccessibleText *obj,
- long selectionNum, long *startOffset,
- long *endOffset);
+ long int selectionNum,
+ long int *startOffset,
+ long int *endOffset);
-boolean
+SPIBoolean
AccessibleText_addSelection (AccessibleText *obj,
- long startOffset, long endOffset);
+ long int startOffset,
+ long int endOffset);
-boolean
+SPIBoolean
AccessibleText_removeSelection (AccessibleText *obj,
- long selectionNum);
+ long int selectionNum);
-boolean
+SPIBoolean
AccessibleText_setSelection (AccessibleText *obj,
- long selectionNum,
- long startOffset,
- long endOffset);
+ long int selectionNum,
+ long int startOffset,
+ long int endOffset);
/*
*
*
*/
+void AccessibleValue_ref (AccessibleValue *obj);
+void AccessibleValue_unref (AccessibleValue *obj);
+
float
-AccessibleValue_getMinimumValue (AccessibleValue *value);
+AccessibleValue_getMinimumValue (AccessibleValue *obj);
float
-AccessibleValue_getCurrentValue (AccessibleValue *value);
+AccessibleValue_getCurrentValue (AccessibleValue *obj);
float
-AccessibleValue_getMaximumValue (AccessibleValue *value);
+AccessibleValue_getMaximumValue (AccessibleValue *obj);
-boolean
-AccessibleValue_setCurrentValue (AccessibleValue *value,
+SPIBoolean
+AccessibleValue_setCurrentValue (AccessibleValue *obj,
float newValue);
void
-spi_freeString (char *s);
+SPI_freeString (char *s);
+
+G_END_DECLS
#endif
projects / platform / core / uifw / at-spi2-atk.git / blobdiff