atspi/atspi-event-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_EVENT_LISTENER_H_
  26 #define _ATSPI_EVENT_LISTENER_H_
  27
  28 #include "glib-object.h"
  29
  30 #include "atspi-types.h"
  31
  32 /**
  33  * AtspiEventListenerCB:
  34  * @event: The event for which notification is sent.
  35  * @user_data: User data which is passed to the callback each time a notification takes place.
  36  *
  37  * A function prototype for callbacks via which clients are notified of AT-SPI events.
  38  *
  39  **/
  40 typedef void       (*AtspiEventListenerCB)     (const AtspiEvent     *event,
  41                                                      void                      *user_data);
  42
  43 /**
  44  * AtspiEventListenerSimpleCB:
  45  * @event: The event for which notification is sent.
  46  *
  47  * Like #AtspiEventlistenerCB, but with no user_data.
  48  *
  49  **/
  50 typedef void       (*AtspiEventListenerSimpleCB)     (const AtspiEvent     *event);
  51
  52 #define ATSPI_TYPE_EVENT_LISTENER                        (atspi_event_listener_get_type ())
  53 #define ATSPI_EVENT_LISTENER(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListener))
  54 #define ATSPI_EVENT_LISTENER_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListenerClass))
  55 #define ATSPI_IS_EVENT_LISTENER(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_EVENT_LISTENER))
  56 #define ATSPI_IS_EVENT_LISTENER_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_EVENT_LISTENER))
  57 #define ATSPI_EVENT_LISTENER_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListenerClass))
  58
  59 typedef struct _AtspiEventListener AtspiEventListener;
  60 struct _AtspiEventListener
  61 {
  62   GObject parent;
  63   AtspiEventListenerCB callback;
  64   void *user_data;
  65   GDestroyNotify cb_destroyed;
  66 };
  67
  68 typedef struct _AtspiEventListenerClass AtspiEventListenerClass;
  69 struct _AtspiEventListenerClass
  70 {
  71   GObjectClass parent_class;
  72 };
  73
  74 GType atspi_event_listener_get_type (void);
  75
  76 AtspiEventListener *
  77 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
  78                                  GDestroyNotify callback_destroyed);
  79
  80 gboolean
  81 atspi_event_listener_register (AtspiEventListener *listener,
  82                                  const gchar              *event_type);
  83
  84 gboolean
  85 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
  86                                              void *user_data,
  87                                              GDestroyNotify callback_destroyed,
  88                                              const gchar              *event_type);
  89
  90 gboolean
  91 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
  92                                  GDestroyNotify callback_destroyed,
  93                                  const gchar              *event_type);
  94
  95 gboolean
  96 atspi_event_listener_deregister (AtspiEventListener *listener,
  97                                  const gchar              *event_type);
  98
  99 gboolean
 100 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
 101                                                void *user_data,
 102                                                const gchar              *event_type);
 103
 104 gboolean
 105 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
 106                                    const gchar              *event_type);
 107 #endif  /* _ATSPI_EVENT_LISTENER_H_ */