2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
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.
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.
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.
23 #include <cspi/spi-private.h>
24 #include <cspi/spi-listener-impl.h>
27 * createAccessibleEventListener:
28 * @callback : an #AccessibleEventListenerCB callback function, or NULL.
29 * @user_data: a pointer to data which will be passed to the callback when invoked.
31 * Create a new #AccessibleEventListener with a specified (in-process) callback function.
33 * Returns: a pointer to a newly-created #AccessibleEventListener.
36 AccessibleEventListener *
37 createAccessibleEventListener (AccessibleEventListenerCB callback,
40 AccessibleEventListener *listener = cspi_event_listener_new ();
43 AccessibleEventListener_addCallback (listener, callback, user_data);
49 * AccessibleEventListener_addCallback:
50 * @listener: the #AccessibleEventListener instance to modify.
51 * @callback: an #AccessibleEventListenerCB function pointer.
52 * @user_data: a pointer to data which will be passed to the callback when invoked.
54 * Add an in-process callback function to an existing AccessibleEventListener.
55 * Note that the callback function must live in the same address
56 * space as the AccessibleEventListener implementation code, thus one should not
57 * use this function to attach callbacks to a 'remote' event listener
58 * (that is, one that was not created by a client call to
59 * createAccessibleEventListener ();
61 * Returns: #TRUE if successful, otherwise #FALSE.
65 AccessibleEventListener_addCallback (AccessibleEventListener *listener,
66 AccessibleEventListenerCB callback,
69 cspi_event_listener_add_callback (listener, callback, user_data);
74 * AccessibleEventListener_unref:
75 * @listener: a pointer to the #AccessibleEventListener being operated on.
77 * Decrements an #AccessibleEventListener's reference count.
80 AccessibleEventListener_unref (AccessibleEventListener *listener)
82 /* Would prefer this not to be bonobo api */
83 bonobo_object_unref (BONOBO_OBJECT (listener));
87 * AccessibleEventListener_removeCallback:
88 * @listener: the #AccessibleEventListener instance to modify.
89 * @callback: an #AccessibleEventListenerCB function pointer.
91 * Remove an in-process callback function from an existing AccessibleEventListener.
93 * Returns: #TRUE if successful, otherwise #FALSE.
97 AccessibleEventListener_removeCallback (AccessibleEventListener *listener,
98 AccessibleEventListenerCB callback)
100 cspi_event_listener_remove_callback (listener, callback);
105 * createAccessibleKeystrokeListener:
106 * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL.
107 * @user_data: a pointer to data which will be passed to the callback when invoked.
109 * Create a new #AccessibleKeystrokeListener with a specified callback function.
111 * Returns: a pointer to a newly-created #AccessibleKeystrokeListener.
114 AccessibleKeystrokeListener *
115 createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback,
118 CSpiKeystrokeListener *listener = cspi_keystroke_listener_new ();
121 AccessibleKeystrokeListener_addCallback (listener, callback, user_data);
123 return (AccessibleKeystrokeListener *)listener;
127 * AccessibleKeystrokeListener_addCallback:
128 * @listener: the #AccessibleKeystrokeListener instance to modify.
129 * @callback: an #AccessibleKeystrokeListenerCB function pointer.
130 * @user_data: a pointer to data which will be passed to the callback when invoked.
132 * Add an in-process callback function to an existing #AccessibleKeystrokeListener.
134 * Returns: #TRUE if successful, otherwise #FALSE.
138 AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener,
139 AccessibleKeystrokeListenerCB callback,
142 cspi_keystroke_listener_add_callback (listener, callback, user_data);
147 * AccessibleKeystrokeListener_removeCallback:
148 * @listener: the #AccessibleKeystrokeListener instance to modify.
149 * @callback: an #AccessibleKeystrokeListenerCB function pointer.
151 * Remove an in-process callback function from an existing #AccessibleKeystrokeListener.
153 * Returns: #TRUE if successful, otherwise #FALSE.
157 AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener,
158 AccessibleKeystrokeListenerCB callback)
160 cspi_keystroke_listener_remove_callback (listener, callback);
165 * AccessibleKeystrokeListener_unref:
166 * @listener: a pointer to the #AccessibleKeystrokeListener being operated on.
168 * Decrements an #AccessibleKeystrokeListener's reference count.
171 AccessibleKeystrokeListener_unref (AccessibleKeystrokeListener *listener)
173 /* Would prefer this not to be bonobo api */
174 bonobo_object_unref (BONOBO_OBJECT (listener));