2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
7 * Copyright 2010, 2011 Novell, Inc.
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.
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.
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.
26 #ifndef _ATSPI_DEVICE_LISTENER_H_
27 #define _ATSPI_DEVICE_LISTENER_H_
29 #include "glib-object.h"
31 #include "atspi-types.h"
34 * AtspiDeviceListenerCB:
35 * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
37 * @user_data: Data which is passed to the client each time this callback is notified.
39 * A callback function prototype via which clients receive device event notifications.
41 * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
42 * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
44 typedef gboolean (*AtspiDeviceListenerCB) (const AtspiDeviceEvent *stroke,
48 * AtspiDeviceListenerSimpleCB:
49 * @stroke: (transfer full): The #AtspiDeviceEvent for which notification is
52 * Like #AtspiDeviceListenerCB but with no user data.
54 * Returns: %TRUE if the client wishes to consume/preempt the event, preventing it from being
55 * relayed to the currently focussed application, %FALSE if the event delivery should proceed as normal.
57 typedef gboolean (*AtspiDeviceListenerSimpleCB) (const AtspiDeviceEvent *stroke);
59 #define ATSPI_TYPE_DEVICE_LISTENER (atspi_device_listener_get_type ())
60 #define ATSPI_DEVICE_LISTENER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListener))
61 #define ATSPI_DEVICE_LISTENER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
62 #define ATSPI_IS_DEVICE_LISTENER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_DEVICE_LISTENER))
63 #define ATSPI_IS_DEVICE_LISTENER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_DEVICE_LISTENER))
64 #define ATSPI_DEVICE_LISTENER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_DEVICE_LISTENER, AtspiDeviceListenerClass))
66 typedef struct _AtspiDeviceListener AtspiDeviceListener;
67 struct _AtspiDeviceListener
74 typedef struct _AtspiDeviceListenerClass AtspiDeviceListenerClass;
75 struct _AtspiDeviceListenerClass
77 GObjectClass parent_class;
78 gboolean (*device_event) (AtspiDeviceListener *, const AtspiDeviceEvent *);
81 GType atspi_device_listener_get_type (void);
83 AtspiDeviceListener *atspi_device_listener_new (AtspiDeviceListenerCB callback, void *user_data, GDestroyNotify callback_destroyed);
85 AtspiDeviceListener *atspi_device_listener_new_simple (AtspiDeviceListenerSimpleCB callback, GDestroyNotify callback_destroyed);
87 void atspi_device_listener_add_callback (AtspiDeviceListener *listener, AtspiDeviceListenerCB callback, GDestroyNotify callback_destroyed, void *user_data);
89 void atspi_device_listener_remove_callback (AtspiDeviceListener *listener, AtspiDeviceListenerCB callback);
90 #endif /* _ATSPI_DEVICE_LISTENER_H_ */