Started fixing IDL docs.
[platform/core/uifw/at-spi2-atk.git] / libspi / keystrokelistener.h
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2001 Sun Microsystems Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #ifndef SPI_KEYSTROKE_LISTENER_H_
24 #define SPI_KEYSTROKE_LISTENER_H_
25
26 #include <bonobo/bonobo-object.h>
27 #include <atk/atkobject.h>
28 #include <libspi/Accessibility.h>
29 #include <libspi/keymasks.h>
30
31 G_BEGIN_DECLS
32
33 #define SPI_KEYSTROKE_LISTENER_TYPE        (spi_keystroke_listener_get_type ())
34 #define SPI_KEYSTROKE_LISTENER(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), SPI_KEYSTROKE_LISTENER_TYPE, SpiKeystrokeListener))
35 #define SPI_KEYSTROKE_LISTENER_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), SPI_KEYSTROKE_LISTENER_TYPE, SpiKeystrokeListenerClass))
36 #define IS_SPI_KEYSTROKE_LISTENER(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), SPI_KEYSTROKE_LISTENER_TYPE))
37 #define IS_SPI_KEYSTROKE_LISTENER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), SPI_KEYSTROKE_LISTENER_TYPE))
38
39 typedef gboolean (*BooleanKeystrokeListenerCB) (const void *keystroke_ptr);
40
41 typedef struct {
42         BonoboObject parent;
43         GList *callbacks;
44 } SpiKeystrokeListener;
45
46 typedef struct {
47         BonoboObjectClass parent_class;
48         POA_Accessibility_KeystrokeListener__epv epv;
49 } SpiKeystrokeListenerClass;
50
51 GType                  spi_keystroke_listener_get_type        (void);
52 SpiKeystrokeListener  *spi_keystroke_listener_new             (void);
53 void                   spi_keystroke_listener_add_callback    (SpiKeystrokeListener *listener,
54                                                                BooleanKeystrokeListenerCB callback);
55 void                   spi_keystroke_listener_remove_callback (SpiKeystrokeListener *listener,
56                                                                BooleanKeystrokeListenerCB callback);
57
58
59 G_END_DECLS
60
61 #endif /* KEYSTROKE_SPI_LISTENER_H_ */