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