Revved to 1.7.4; Fixes for cspi event handlers for EventDetails.

[platform/core/uifw/at-spi2-atk.git] / cspi / spi-listener.h

diff --git a/cspi/spi-listener.h b/cspi/spi-listener.h
index 81029d7..aff3762 100644 (file)
--- a/cspi/spi-listener.h
+++ b/cspi/spi-listener.h
@@ -40,14 +40,15 @@ typedef struct {
   long         detail2;
 } AccessibleEvent;
   
-/* 
- * For internal use by CSPI implementation only
- */
-typedef struct {
-  AccessibleEvent event;
-  void           *data; 
-} InternalEvent;
-
+/**
+ *AccessibleDeviceEventType:
+ *@SPI_KEY_PRESSED:
+ *@SPI_KEY_RELEASED:
+ *@SPI_BUTTON_PRESSED:
+ *@SPI_BUTTON_RELEASED:
+ *
+ *The type of an AccessibleDeviceEvent.
+ **/
 typedef enum {
   SPI_KEY_PRESSED  = 1<<0,
   SPI_KEY_RELEASED = 1<<1,
@@ -55,6 +56,11 @@ typedef enum {
   SPI_BUTTON_RELEASED = 1<<3
 } AccessibleDeviceEventType;
 
+/**
+ *AccessibleKeyEventType:
+ *
+ *This is a synonym for AccessibleDeviceEventType
+ **/
 typedef AccessibleDeviceEventType AccessibleKeyEventType;
 
 typedef struct {
@@ -77,6 +83,8 @@ typedef AccessibleDeviceEvent AccessibleKeystroke;
  * void (*AccessibleEventListenerCB) (AccessibleEvent *event);
  *
  * SPIBoolean (*AccessibleKeystrokeListenerCB) (AccessibleKeystrokeEvent *Event);
+ * Note that AccessibleKeystrokeListeners may consume the event received
+ * if one of their callbacks returns TRUE (see SPI_registerAccessibleKeystrokeListener)
  */
 typedef void       (*AccessibleEventListenerCB)     (const AccessibleEvent     *event,
                                                     void                      *user_data);