X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=cspi%2Fspi.h;h=a38cb1c31bca28a7c252ceb5228e1942eb7b95c9;hb=2b8f4365c549962de1f20418ca00dd503d6e28bc;hp=b29719e37078b5bb01d6543c32f412ae8dbab3ed;hpb=783e63cad5945ddb6df3ee129d20d5b53c6cce04;p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git diff --git a/cspi/spi.h b/cspi/spi.h index b29719e..a38cb1c 100644 --- a/cspi/spi.h +++ b/cspi/spi.h @@ -1,31 +1,27 @@ - #ifndef _SPI_H #define _SPI_H -/* Implementation private definitions */ - -#include "spi-impl.h" +#include +#include /* - * 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 +#include +#include /* * Auxiliary typedefs and mask definitions */ -#include +#include + +G_BEGIN_DECLS /* - * * Enumerated type for text boundary types - * */ - typedef enum { SPI_TEXT_BOUNDARY_CHAR, @@ -62,11 +58,6 @@ typedef enum { } AccessibleCoordType; typedef enum { - SPI_KEY_PRESSED, - SPI_KEY_RELEASED -} AccessibleKeyEventType; - -typedef enum { SPI_KEY_PRESS, SPI_KEY_RELEASE, SPI_KEY_PRESSRELEASE, @@ -82,13 +73,32 @@ typedef enum { 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: @@ -133,7 +143,7 @@ SPI_init (void); /** * 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. @@ -143,7 +153,7 @@ SPI_init (void); * **/ void -SPI_event_main (boolean isGNOMEApp); +SPI_event_main (SPIBoolean isGNOMEApp); /** * SPI_event_is_ready: @@ -155,7 +165,7 @@ SPI_event_main (boolean isGNOMEApp); * Returns: #TRUE if an event is waiting, otherwise #FALSE. * **/ -boolean +SPIBoolean SPI_eventIsReady (); /** @@ -170,7 +180,7 @@ SPI_eventIsReady (); * **/ AccessibleEvent * -SPI_nextEvent (boolean waitForEvent); +SPI_nextEvent (SPIBoolean waitForEvent); /** * SPI_exit: @@ -208,7 +218,7 @@ createAccessibleEventListener (AccessibleEventListenerCB callback); * Returns: #TRUE if successful, otherwise #FALSE. * **/ -boolean +SPIBoolean AccessibleEventListener_addCallback (AccessibleEventListener *listener, AccessibleEventListenerCB callback); @@ -222,7 +232,7 @@ AccessibleEventListener_addCallback (AccessibleEventListener *listener, * Returns: #TRUE if successful, otherwise #FALSE. * **/ -boolean +SPIBoolean AccessibleEventListener_removeCallback (AccessibleEventListener *listener, AccessibleEventListenerCB callback); @@ -248,7 +258,7 @@ createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback); * Returns: #TRUE if successful, otherwise #FALSE. * **/ -boolean +SPIBoolean AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener, AccessibleKeystrokeListenerCB callback); @@ -262,7 +272,7 @@ AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener, * Returns: #TRUE if successful, otherwise #FALSE. * **/ -boolean +SPIBoolean AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener, AccessibleKeystrokeListenerCB callback); @@ -293,13 +303,13 @@ AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listene * 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); @@ -554,7 +564,7 @@ Accessible_getStateSet (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleAction interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isAction (Accessible *obj); /** @@ -566,7 +576,7 @@ Accessible_isAction (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleComponent interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isComponent (Accessible *obj); /** @@ -578,7 +588,7 @@ Accessible_isComponent (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleEditableText interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isEditableText (Accessible *obj); /** @@ -590,7 +600,7 @@ Accessible_isEditableText (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleHypertext interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isHypertext (Accessible *obj); /** @@ -602,7 +612,7 @@ Accessible_isHypertext (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleImage interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isImage (Accessible *obj); /** @@ -614,7 +624,7 @@ Accessible_isImage (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleSelection interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isSelection (Accessible *obj); /** @@ -626,7 +636,7 @@ Accessible_isSelection (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleTable interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isTable (Accessible *obj); /** @@ -638,7 +648,7 @@ Accessible_isTable (Accessible *obj); * Returns: #TRUE if @obj implements the #AccessibleText interface, * #FALSE otherwise. **/ -boolean +SPIBoolean Accessible_isText (Accessible *obj); AccessibleAction * @@ -768,7 +778,7 @@ char * AccessibleAction_getDescription (AccessibleAction *obj, long int i); -boolean +SPIBoolean AccessibleAction_doAction (AccessibleAction *obj, long int i); @@ -870,7 +880,7 @@ AccessibleApplication_getID (AccessibleApplication *obj); * Returns: #TRUE if the application was paused successfully, #FALSE otherwise. * **/ -boolean +SPIBoolean AccessibleApplication_pause (AccessibleApplication *obj); /** @@ -883,7 +893,7 @@ AccessibleApplication_pause (AccessibleApplication *obj); * Returns: #TRUE if application processing resumed successfully, #FALSE otherwise. * **/ -boolean +SPIBoolean AccessibleApplication_resume (AccessibleApplication *obj); /* @@ -898,7 +908,7 @@ AccessibleComponent_ref (AccessibleComponent *obj); int AccessibleComponent_unref (AccessibleComponent *obj); -boolean +SPIBoolean AccessibleComponent_contains (AccessibleComponent *obj, long int x, long int y, @@ -942,6 +952,30 @@ AccessibleComponent_getSize (AccessibleComponent *obj, 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); @@ -957,38 +991,38 @@ AccessibleEditableText_ref (AccessibleEditableText *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); @@ -1014,7 +1048,7 @@ AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj, long int *startIndex, long int *endIndex); -boolean +SPIBoolean AccessibleHyperlink_isValid (AccessibleHyperlink *obj); /* @@ -1107,19 +1141,19 @@ Accessible * 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 @@ -1138,7 +1172,7 @@ AccessibleStateSet_ref (AccessibleStateSet *obj); int AccessibleStateSet_unref (AccessibleStateSet *obj); -boolean +SPIBoolean AccessibleStateSet_contains (AccessibleStateSet *obj, AccessibleState state); @@ -1150,7 +1184,7 @@ void AccessibleStateSet_remove (AccessibleStateSet *obj, AccessibleState state); -boolean +SPIBoolean AccessibleStateSet_equals (AccessibleStateSet *obj, AccessibleStateSet *obj2); @@ -1159,7 +1193,7 @@ AccessibleStateSet_compare (AccessibleStateSet *obj, AccessibleStateSet *obj2, AccessibleStateSet **differenceSet); -boolean +SPIBoolean AccessibleStateSet_isEmpty (AccessibleStateSet *obj); @@ -1245,15 +1279,15 @@ long 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); @@ -1288,7 +1322,7 @@ AccessibleText_getAttributes (AccessibleText *obj, long int *endOffset); -boolean +SPIBoolean AccessibleText_setCaretOffset (AccessibleText *obj, long int newOffset); @@ -1342,16 +1376,16 @@ AccessibleText_getSelection (AccessibleText *obj, 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, @@ -1378,11 +1412,10 @@ AccessibleValue_getCurrentValue (AccessibleValue *obj); float AccessibleValue_getMaximumValue (AccessibleValue *obj); -boolean +SPIBoolean AccessibleValue_setCurrentValue (AccessibleValue *obj, float newValue); -void -spi_freeString (char *s); +G_END_DECLS #endif