Box some types, add missing header file, and other fixes
[platform/upstream/at-spi2-core.git] / 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-event-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 gboolean
53 atspi_event_listener_register (AtspiEventListenerCB callback,
54                                  void *user_data,
55                                  GDestroyNotify callback_destroyed,
56                                  const gchar              *event_type);
57
58 gboolean
59 atspi_event_listener_register_no_data (AtspiEventListenerSimpleCB callback,
60                                  GDestroyNotify callback_destroyed,
61                                  const gchar              *event_type);
62
63 gboolean
64 atspi_event_listener_deregister (AtspiEventListenerCB callback,
65                                    void *user_data,
66                                    const gchar              *event_type);
67
68 gboolean
69 atspi_event_listener_deregister_no_data (AtspiEventListenerSimpleCB callback,
70                                    const gchar              *event_type);
71 #endif  /* _ATSPI_EVENT_LISTENER_H_ */