atspi/atspi-device-listener.h

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2002 Ximian, Inc.
   6  *           2002 Sun Microsystems Inc.
   7  *
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef _ATSPI_DEVICE_LISTENER_H_
  26 #define _ATSPI_DEVICE_LISTENER_H_
  27
  28 #include "glib-object.h"
  29
  30 #include "atspi-types.h"
  31
  32 /**
  33  * AtspiDeviceListenerCB:
  34  * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
  35  *          being received.
  36  * @user_data: Data which is passed to the client each time this callback is notified.
  37  *
  38  * A callback function prototype via which clients receive device event notifications.
  39  *
  40  * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
  41  * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
  42  **/
  43 typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
  44                                                      void                      *user_data);
  45
  46 /**
  47  * AtspiDeviceListenerSimpleCB:
  48  * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
  49  *          being received.
  50  *
  51  * Like #AtspiDeviceListenerCB but with no user data.
  52  *
  53  * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
  54  * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
  55  **/
  56 typedef gboolean (*AtspiDeviceListenerSimpleCB)    (const AtspiDeviceEvent *stroke);
  57
  58 #define ATSPI_TYPE_DEVICE_LISTENER                        (atspi_device_listener_get_type ())
  59 #define ATSPI_DEVICE_LISTENER(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListener))
  60 #define ATSPI_DEVICE_LISTENER_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
  61 #define ATSPI_IS_DEVICE_LISTENER(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_DEVICE_LISTENER))
  62 #define ATSPI_IS_DEVICE_LISTENER_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_DEVICE_LISTENER))
  63 #define ATSPI_DEVICE_LISTENER_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
  64
  65 typedef struct _AtspiDeviceListener AtspiDeviceListener;
  66 struct _AtspiDeviceListener
  67 {
  68   GObject parent;
  69   guint id;
  70   GList *callbacks;
  71 };
  72
  73 typedef struct _AtspiDeviceListenerClass AtspiDeviceListenerClass;
  74 struct _AtspiDeviceListenerClass
  75 {
  76   GObjectClass parent_class;
  77   gboolean (*device_event) (AtspiDeviceListener *, const AtspiDeviceEvent *);
  78 };
  79
  80 GType atspi_device_listener_get_type (void);
  81
  82 AtspiDeviceListener *atspi_device_listener_new (AtspiDeviceListenerCB callback, GDestroyNotify callback_destroyed, void *user_data);
  83
  84 AtspiDeviceListener *atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback, GDestroyNotify callback_destroyed);
  85
  86 void atspi_device_listener_add_callback (AtspiDeviceListener *listener, AtspiDeviceListenerCB callback, GDestroyNotify callback_destroyed, void *user_data);
  87
  88 void atspi_device_listener_remove_callback (AtspiDeviceListener  *listener, AtspiDeviceListenerCB callback);
  89 #endif  /* _ATSPI_DEVICE_LISTENER_H_ */