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  * For internal use by CSPI implementation only
  45  */
  46 typedef struct {
  47   AccessibleEvent event;
  48   void           *data;
  49 } InternalEvent;
  50
  51 typedef enum {
  52   SPI_KEY_PRESSED  = 1<<0,
  53   SPI_KEY_RELEASED = 1<<1,
  54   SPI_BUTTON_PRESSED = 1<<2,
  55   SPI_BUTTON_RELEASED = 1<<3
  56 } AccessibleDeviceEventType;
  57
  58 typedef AccessibleDeviceEventType AccessibleKeyEventType;
  59
  60 typedef struct {
  61   long                   keyID;
  62   short                  keycode;
  63   char *                 keystring;
  64   long                   timestamp;
  65   AccessibleDeviceEventType type;
  66   unsigned short         modifiers;
  67   SPIBoolean             is_text;
  68 } AccessibleDeviceEvent;
  69
  70 typedef AccessibleDeviceEvent AccessibleKeystroke;
  71
  72 /*
  73  * Function prototype typedefs for Event Listener Callbacks.
  74  * (see libspi/accessibleeventlistener.h for definition of SpiVoidEventListenerCB).
  75  *
  76  * usage: signatures should be
  77  * void (*AccessibleEventListenerCB) (AccessibleEvent *event);
  78  *
  79  * SPIBoolean (*AccessibleKeystrokeListenerCB) (AccessibleKeystrokeEvent *Event);
  80  */
  81 typedef void       (*AccessibleEventListenerCB)     (const AccessibleEvent     *event,
  82                                                      void                      *user_data);
  83 typedef SPIBoolean (*AccessibleKeystrokeListenerCB) (const AccessibleKeystroke *stroke,
  84                                                      void                      *user_data);
  85 typedef SPIBoolean (*AccessibleDeviceListenerCB)    (const AccessibleDeviceEvent *stroke,
  86                                                      void                      *user_data);
  87
  88 #ifdef  __cplusplus
  89 }
  90 #endif
  91
  92 #endif