cspi/spi-listener.h

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef _SPI_LISTENER_H_
  25 #define _SPI_LISTENER_H_
  26
  27 #include <cspi/spi-impl.h>
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * Structure used to encapsulate event information
  35  */
  36 typedef struct {
  37   const char  *type;
  38   Accessible  *source;
  39   long         detail1;
  40   long         detail2;
  41 } AccessibleEvent;
  42
  43 /**
  44  *AccessibleDeviceEventType:
  45  *@SPI_KEY_PRESSED:
  46  *@SPI_KEY_RELEASED:
  47  *@SPI_BUTTON_PRESSED:
  48  *@SPI_BUTTON_RELEASED:
  49  *
  50  *The type of an AccessibleDeviceEvent.
  51  **/
  52 typedef enum {
  53   SPI_KEY_PRESSED  = 1<<0,
  54   SPI_KEY_RELEASED = 1<<1,
  55   SPI_BUTTON_PRESSED = 1<<2,
  56   SPI_BUTTON_RELEASED = 1<<3
  57 } AccessibleDeviceEventType;
  58
  59 /**
  60  *AccessibleKeyEventType:
  61  *
  62  *This is a synonym for AccessibleDeviceEventType
  63  **/
  64 typedef AccessibleDeviceEventType AccessibleKeyEventType;
  65
  66 typedef struct {
  67   long                   keyID;
  68   short                  keycode;
  69   char *                 keystring;
  70   long                   timestamp;
  71   AccessibleDeviceEventType type;
  72   unsigned short         modifiers;
  73   SPIBoolean             is_text;
  74 } AccessibleDeviceEvent;
  75
  76 typedef AccessibleDeviceEvent AccessibleKeystroke;
  77
  78 /*
  79  * Function prototype typedefs for Event Listener Callbacks.
  80  * (see libspi/accessibleeventlistener.h for definition of SpiVoidEventListenerCB).
  81  *
  82  * usage: signatures should be
  83  * void (*AccessibleEventListenerCB) (AccessibleEvent *event);
  84  *
  85  * SPIBoolean (*AccessibleKeystrokeListenerCB) (AccessibleKeystrokeEvent *Event);
  86  * Note that AccessibleKeystrokeListeners may consume the event received
  87  * if one of their callbacks returns TRUE (see SPI_registerAccessibleKeystrokeListener)
  88  */
  89 typedef void       (*AccessibleEventListenerCB)     (const AccessibleEvent     *event,
  90                                                      void                      *user_data);
  91 typedef SPIBoolean (*AccessibleKeystrokeListenerCB) (const AccessibleKeystroke *stroke,
  92                                                      void                      *user_data);
  93 typedef SPIBoolean (*AccessibleDeviceListenerCB)    (const AccessibleDeviceEvent *stroke,
  94                                                      void                      *user_data);
  95
  96 #ifdef  __cplusplus
  97 }
  98 #endif
  99
 100 #endif