-
#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.
+ * Definitions for AccessibleRole, AccessibleState,
+ * AccessibleEvent, and event listeners.
*/
-
-#include "spi-roletypes.h"
-#include "spi-statetypes.h"
-#include "spi-listener.h"
+#include <cspi/spi-roletypes.h>
+#include <cspi/spi-statetypes.h>
+#include <cspi/spi-listener.h>
/*
* Auxiliary typedefs and mask definitions
*/
-#include <keymasks.h>
+#include <libspi/keymasks.h>
+
+G_BEGIN_DECLS
/*
- *
* Enumerated type for text boundary types
- *
*/
-
typedef enum
{
SPI_TEXT_BOUNDARY_CHAR,
} AccessibleCoordType;
typedef enum {
- SPI_KEY_PRESSED,
- SPI_KEY_RELEASED
-} AccessibleKeyEventType;
-
-typedef enum {
SPI_KEY_PRESS,
SPI_KEY_RELEASE,
SPI_KEY_PRESSRELEASE,
typedef unsigned long AccessibleKeyEventMask;
-typedef struct _AccessibleKeyStroke
-{
- long keyID;
- short keycode;
- AccessibleKeyEventType type;
- unsigned short modifiers;
-} AccessibleKeyStroke;
+/**
+ * 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:
* @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
* includes all keycodes and keyvals for the specified modifier set.
**/
-#define SPI_KEYSET_ALL_KEYS ((void *)NULL)
+#define SPI_KEYSET_ALL_KEYS NULL
typedef unsigned long AccessibleKeyMaskType;
/**
* SPI_event_main:
- * @isGNOMEApp: a #boolean indicating whether the client of the SPI
+ * @isGNOMEApp: a #SPIBoolean 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.
*
**/
void
-SPI_event_main (boolean isGNOMEApp);
+SPI_event_main (SPIBoolean isGNOMEApp);
/**
* SPI_event_is_ready:
* Returns: #TRUE if an event is waiting, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
SPI_eventIsReady ();
/**
*
**/
AccessibleEvent *
-SPI_nextEvent (boolean waitForEvent);
+SPI_nextEvent (SPIBoolean waitForEvent);
/**
* SPI_exit:
* Returns: #TRUE if successful, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
AccessibleEventListener_addCallback (AccessibleEventListener *listener,
AccessibleEventListenerCB callback);
* Returns: #TRUE if successful, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
AccessibleEventListener_removeCallback (AccessibleEventListener *listener,
AccessibleEventListenerCB callback);
* Returns: #TRUE if successful, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener,
AccessibleKeystrokeListenerCB callback);
* Returns: #TRUE if successful, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener,
AccessibleKeystrokeListenerCB callback);
* Returns: #TRUE if successful, otherwise #FALSE.
*
**/
-boolean
+SPIBoolean
registerGlobalEventListener (AccessibleEventListener *listener,
char *eventType);
-boolean
+SPIBoolean
deregisterGlobalEventListener (AccessibleEventListener *listener,
char *eventType);
-boolean
+SPIBoolean
deregisterGlobalEventListenerAll (AccessibleEventListener *listener);
* Returns: #TRUE if @obj implements the #AccessibleAction interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isAction (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleComponent interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isComponent (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isEditableText (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isHypertext (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleImage interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isImage (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleSelection interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isSelection (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleTable interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isTable (Accessible *obj);
/**
* Returns: #TRUE if @obj implements the #AccessibleText interface,
* #FALSE otherwise.
**/
-boolean
+SPIBoolean
Accessible_isText (Accessible *obj);
AccessibleAction *
AccessibleAction_getDescription (AccessibleAction *obj,
long int i);
-boolean
+SPIBoolean
AccessibleAction_doAction (AccessibleAction *obj,
long int i);
* Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
*
**/
-boolean
+SPIBoolean
AccessibleApplication_pause (AccessibleApplication *obj);
/**
* Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
*
**/
-boolean
+SPIBoolean
AccessibleApplication_resume (AccessibleApplication *obj);
/*
int
AccessibleComponent_unref (AccessibleComponent *obj);
-boolean
+SPIBoolean
AccessibleComponent_contains (AccessibleComponent *obj,
long int x,
long int y,
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
AccessibleEditableText_unref (AccessibleEditableText *obj);
-boolean
+SPIBoolean
AccessibleEditableText_setAttributes (AccessibleEditableText *obj,
const char *attributes,
long int startOffset,
long int endOffset);
-boolean
+SPIBoolean
AccessibleEditableText_setTextContents (AccessibleEditableText *obj,
const char *newContents);
-boolean
+SPIBoolean
AccessibleEditableText_insertText (AccessibleEditableText *obj,
long int position,
char *text,
long int length);
-boolean
+SPIBoolean
AccessibleEditableText_copyText (AccessibleText *obj,
long int startPos,
long int endPos);
-boolean
+SPIBoolean
AccessibleEditableText_cutText (AccessibleEditableText *obj,
long int startPos,
long int endPos);
-boolean
+SPIBoolean
AccessibleEditableText_deleteText (AccessibleEditableText *obj,
long int startPos,
long int endPos);
-boolean
+SPIBoolean
AccessibleEditableText_pasteText (AccessibleEditableText *obj,
long int position);
long int *startIndex,
long int *endIndex);
-boolean
+SPIBoolean
AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
/*
AccessibleRelationType
AccessibleRelation_getRelationType (AccessibleRelation *obj);
+int
+AccessibleRelation_getNTargets (AccessibleRelation *obj);
+
Accessible *
-AccessibleRelation_getTarget (AccessibleRelation *obj);
+AccessibleRelation_getTarget (AccessibleRelation *obj, int i);
/*
AccessibleSelection_getSelectedChild (AccessibleSelection *obj,
long int selectedChildIndex);
-boolean
+SPIBoolean
AccessibleSelection_selectChild (AccessibleSelection *obj,
long int childIndex);
-boolean
+SPIBoolean
AccessibleSelection_deselectSelectedChild (AccessibleSelection *obj,
long int selectedChildIndex);
-boolean
+SPIBoolean
AccessibleSelection_isChildSelected (AccessibleSelection *obj,
long int childIndex);
-boolean
+SPIBoolean
AccessibleSelection_selectAll (AccessibleSelection *obj);
void
int
AccessibleStateSet_unref (AccessibleStateSet *obj);
-boolean
+SPIBoolean
AccessibleStateSet_contains (AccessibleStateSet *obj,
AccessibleState state);
AccessibleStateSet_remove (AccessibleStateSet *obj,
AccessibleState state);
-boolean
+SPIBoolean
AccessibleStateSet_equals (AccessibleStateSet *obj,
AccessibleStateSet *obj2);
AccessibleStateSet *obj2,
AccessibleStateSet **differenceSet);
-boolean
+SPIBoolean
AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
AccessibleTable_getSelectedColumns (AccessibleTable *obj,
long int **selectedColumns);
-boolean
+SPIBoolean
AccessibleTable_isRowSelected (AccessibleTable *obj,
long int row);
-boolean
+SPIBoolean
AccessibleTable_isColumnSelected (AccessibleTable *obj,
long int column);
-boolean
+SPIBoolean
AccessibleTable_isSelected (AccessibleTable *obj,
long int row,
long int column);
long int *endOffset);
-boolean
+SPIBoolean
AccessibleText_setCaretOffset (AccessibleText *obj,
long int newOffset);
long int *endOffset);
-boolean
+SPIBoolean
AccessibleText_addSelection (AccessibleText *obj,
long int startOffset,
long int endOffset);
-boolean
+SPIBoolean
AccessibleText_removeSelection (AccessibleText *obj,
long int selectionNum);
-boolean
+SPIBoolean
AccessibleText_setSelection (AccessibleText *obj,
long int selectionNum,
long int startOffset,
float
AccessibleValue_getMaximumValue (AccessibleValue *obj);
-boolean
+SPIBoolean
AccessibleValue_setCurrentValue (AccessibleValue *obj,
float newValue);
-void
-spi_freeString (char *s);
+G_END_DECLS
#endif
projects / platform / core / uifw / at-spi2-atk.git / blobdiff