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: The #AtspiDeviceEvent for which notification is being received.
  35  * @user_data: Data which is passed to the client each time this callback is notified.
  36  *
  37  * A callback function prototype via which clients receive device event notifications.
  38  *
  39  * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
  40  * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
  41  **/
  42 typedef gboolean (*AtspiDeviceListenerCB)    (const AtspiDeviceEvent *stroke,
  43                                                      void                      *user_data);
  44
  45 #define ATSPI_TYPE_DEVICE_LISTENER                        (atspi_device_listener_get_type ())
  46 #define ATSPI_DEVICE_LISTENER(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListener))
  47 #define ATSPI_DEVICE_LISTENER_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
  48 #define ATSPI_IS_DEVICE_LISTENER(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_DEVICE_LISTENER))
  49 #define ATSPI_IS_DEVICE_LISTENER_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_DEVICE_LISTENER))
  50 #define ATSPI_DEVICE_LISTENER_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
  51
  52 typedef struct _AtspiDeviceListener AtspiDeviceListener;
  53 struct _AtspiDeviceListener
  54 {
  55   GObject parent;
  56   guint id;
  57   GList *callbacks;
  58 };
  59
  60 typedef struct _AtspiDeviceListenerClass AtspiDeviceListenerClass;
  61 struct _AtspiDeviceListenerClass
  62 {
  63   GObjectClass parent_class;
  64   gboolean (*device_event) (AtspiDeviceListener *, const AtspiDeviceEvent *);
  65 };
  66
  67 GType atspi_device_listener_get_type (void);
  68
  69 AtspiDeviceListener *atspi_device_listener_new (AtspiDeviceListenerCB callback);
  70
  71 void atspi_device_listener_add_callback (AtspiDeviceListener  *listener, AtspiDeviceListenerCB callback, void                      *user_data);
  72
  73 void atspi_device_listener_remove_callback (AtspiDeviceListener  *listener, AtspiDeviceListenerCB callback);
  74 #endif  /* _ATSPI_DEVICE_LISTENER_H_ */