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  * Copyright 2010, 2011 Novell, Inc.
   8  *
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Library General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Library General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Library General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, USA.
  24  */
  25
  26 #ifndef _ATSPI_EVENT_LISTENER_H_
  27 #define _ATSPI_EVENT_LISTENER_H_
  28
  29 #include "glib-object.h"
  30
  31 #include "atspi-types.h"
  32
  33 GType atspi_event_get_type (void);
  34
  35 /**
  36  * AtspiEventListenerCB:
  37  * @event: (transfer full): The event for which notification is sent.
  38  * @user_data: User data which is passed to the callback each time a notification takes place.
  39  *
  40  * A function prototype for callbacks via which clients are notified of AT-SPI events.
  41  *
  42  **/
  43 typedef void       (*AtspiEventListenerCB)     (const AtspiEvent     *event,
  44                                                      void                      *user_data);
  45
  46 /**
  47  * AtspiEventListenerSimpleCB:
  48  * @event: (transfer full): The event for which notification is sent.
  49  *
  50  * Like #AtspiEventlistenerCB, but with no user_data.
  51  *
  52  **/
  53 typedef void       (*AtspiEventListenerSimpleCB)     (const AtspiEvent     *event);
  54
  55 #define ATSPI_TYPE_EVENT_LISTENER                        (atspi_event_listener_get_type ())
  56 #define ATSPI_EVENT_LISTENER(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListener))
  57 #define ATSPI_EVENT_LISTENER_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListenerClass))
  58 #define ATSPI_IS_EVENT_LISTENER(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_EVENT_LISTENER))
  59 #define ATSPI_IS_EVENT_LISTENER_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_EVENT_LISTENER))
  60 #define ATSPI_EVENT_LISTENER_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_EVENT_LISTENER, AtspiEventListenerClass))
  61
  62 typedef struct _AtspiEventListener AtspiEventListener;
  63 struct _AtspiEventListener
  64 {
  65   GObject parent;
  66   AtspiEventListenerCB callback;
  67   void *user_data;
  68   GDestroyNotify cb_destroyed;
  69 };
  70
  71 typedef struct _AtspiEventListenerClass AtspiEventListenerClass;
  72 struct _AtspiEventListenerClass
  73 {
  74   GObjectClass parent_class;
  75 };
  76
  77 GType atspi_event_listener_get_type (void);
  78
  79 AtspiEventListener *
  80 atspi_event_listener_new (AtspiEventListenerCB callback,
  81                                  gpointer user_data,
  82                                  GDestroyNotify callback_destroyed);
  83
  84 AtspiEventListener *
  85 atspi_event_listener_new_simple (AtspiEventListenerSimpleCB callback,
  86                                  GDestroyNotify callback_destroyed);
  87
  88 gboolean
  89 atspi_event_listener_register (AtspiEventListener *listener,
  90                                  const gchar              *event_type,
  91                                  GError **error);
  92
  93 gboolean
  94 atspi_event_listener_register_from_callback (AtspiEventListenerCB callback,
  95                                              void *user_data,
  96                                              GDestroyNotify callback_destroyed,
  97                                              const gchar              *event_type,
  98                                              GError **error);
  99
 100 gboolean
 101 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
 102                                  GDestroyNotify callback_destroyed,
 103                                  const gchar              *event_type,
 104                                  GError **error);
 105
 106 gboolean
 107 atspi_event_listener_deregister (AtspiEventListener *listener,
 108                                  const gchar              *event_type,
 109                                  GError **error);
 110
 111 gboolean
 112 atspi_event_listener_deregister_from_callback (AtspiEventListenerCB callback,
 113                                                void *user_data,
 114                                                const gchar              *event_type,
 115                                                GError **error);
 116
 117 gboolean
 118 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
 119                                    const gchar              *event_type,
 120                                    GError **error);
 121 #endif  /* _ATSPI_EVENT_LISTENER_H_ */