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 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef _SPI_LISTENER_H_
  24 #define _SPI_LISTENER_H_
  25
  26 #include <cspi/spi-impl.h>
  27
  28 #ifdef  __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  * Structure used to encapsulate event information
  34  */
  35 typedef struct {
  36   const char  *type;
  37   Accessible  *source;
  38   long         detail1;
  39   long         detail2;
  40 } AccessibleEvent;
  41
  42 typedef enum {
  43   SPI_KEY_PRESSED  = 1<<0,
  44   SPI_KEY_RELEASED = 1<<1
  45 } AccessibleKeyEventType;
  46
  47
  48 typedef struct {
  49   long                   keyID;
  50   short                  keycode;
  51   char *                 keystring;
  52   long                   timestamp;
  53   AccessibleKeyEventType type;
  54   unsigned short         modifiers;
  55   SPIBoolean             is_text;
  56 } AccessibleKeystroke;
  57
  58 /*
  59  * Function prototype typedefs for Event Listener Callbacks.
  60  * (see libspi/accessibleeventlistener.h for definition of SpiVoidEventListenerCB).
  61  *
  62  * usage: signatures should be
  63  * void (*AccessibleEventListenerCB) (AccessibleEvent *event);
  64  *
  65  * SPIBoolean (*AccessibleKeystrokeListenerCB) (AccessibleKeystrokeEvent *Event);
  66  */
  67 typedef void       (*AccessibleEventListenerCB)     (const AccessibleEvent     *event,
  68                                                      void                      *user_data);
  69 typedef SPIBoolean (*AccessibleKeystrokeListenerCB) (const AccessibleKeystroke *stroke,
  70                                                      void                      *user_data);
  71
  72 #ifdef  __cplusplus
  73 }
  74 #endif
  75
  76 #endif