Removed intltool dependency and translation of .server file. Fixes bug 322846.
[platform/core/uifw/at-spi2-atk.git] / cspi / spi-listener.h
index 63384f6..aff3762 100644 (file)
@@ -39,7 +39,16 @@ typedef struct {
   long         detail1;
   long         detail2;
 } AccessibleEvent;
-
+  
+/**
+ *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,
@@ -47,6 +56,11 @@ typedef enum {
   SPI_BUTTON_RELEASED = 1<<3
 } AccessibleDeviceEventType;
 
+/**
+ *AccessibleKeyEventType:
+ *
+ *This is a synonym for AccessibleDeviceEventType
+ **/
 typedef AccessibleDeviceEventType AccessibleKeyEventType;
 
 typedef struct {
@@ -69,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);