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.
30 * Create a new #AccessibleEventListener with a specified (in-process) callback function.
32 * Returns: a pointer to a newly-created #AccessibleEventListener.
35 AccessibleEventListener *
36 createAccessibleEventListener (AccessibleEventListenerCB callback,
39 AccessibleEventListener *listener = cspi_event_listener_new ();
42 AccessibleEventListener_addCallback (listener, callback, user_data);
48 * AccessibleEventListener_addCallback:
49 * @listener: the #AccessibleEventListener instance to modify.
50 * @callback: an #AccessibleEventListenerCB function pointer.
52 * Add an in-process callback function to an existing AccessibleEventListener.
53 * Note that the callback function must live in the same address
54 * space as the AccessibleEventListener implementation code, thus one should not
55 * use this function to attach callbacks to a 'remote' event listener
56 * (that is, one that was not created by a client call to
57 * createAccessibleEventListener ();
59 * Returns: #TRUE if successful, otherwise #FALSE.
63 AccessibleEventListener_addCallback (AccessibleEventListener *listener,
64 AccessibleEventListenerCB callback,
67 cspi_event_listener_add_callback (listener, callback, user_data);
72 * AccessibleEventListener_removeCallback:
73 * @listener: the #AccessibleEventListener instance to modify.
74 * @callback: an #AccessibleEventListenerCB function pointer.
76 * Remove an in-process callback function from an existing AccessibleEventListener.
78 * Returns: #TRUE if successful, otherwise #FALSE.
82 AccessibleEventListener_removeCallback (AccessibleEventListener *listener,
83 AccessibleEventListenerCB callback)
85 cspi_event_listener_remove_callback (listener, callback);
90 * createAccessibleKeystrokeListener:
91 * @callback : an #AccessibleKeystrokeListenerCB callback function, or NULL.
93 * Create a new #AccessibleKeystrokeListener with a specified callback function.
95 * Returns: a pointer to a newly-created #AccessibleKeystrokeListener.
98 AccessibleKeystrokeListener *
99 createAccessibleKeystrokeListener (AccessibleKeystrokeListenerCB callback,
102 CSpiKeystrokeListener *listener = cspi_keystroke_listener_new ();
105 AccessibleKeystrokeListener_addCallback (listener, callback, user_data);
107 return (AccessibleKeystrokeListener *)listener;
111 * AccessibleKeystrokeListener_addCallback:
112 * @listener: the #AccessibleKeystrokeListener instance to modify.
113 * @callback: an #AccessibleKeystrokeListenerCB function pointer.
115 * Add an in-process callback function to an existing #AccessibleKeystrokeListener.
117 * Returns: #TRUE if successful, otherwise #FALSE.
121 AccessibleKeystrokeListener_addCallback (AccessibleKeystrokeListener *listener,
122 AccessibleKeystrokeListenerCB callback,
125 cspi_keystroke_listener_add_callback (listener, callback, user_data);
130 * AccessibleKeystrokeListener_removeCallback:
131 * @listener: the #AccessibleKeystrokeListener instance to modify.
132 * @callback: an #AccessibleKeystrokeListenerCB function pointer.
134 * Remove an in-process callback function from an existing #AccessibleKeystrokeListener.
136 * Returns: #TRUE if successful, otherwise #FALSE.
140 AccessibleKeystrokeListener_removeCallback (AccessibleKeystrokeListener *listener,
141 AccessibleKeystrokeListenerCB callback)
143 cspi_keystroke_listener_remove_callback (listener, callback);
148 * AccessibleKeystrokeListener_unref:
149 * @listener: a pointer to the #AccessibleKeystrokeListener being operated on.
151 * Decrements an #AccessibleKeystrokeListener's reference count.
154 AccessibleKeystrokeListener_unref (AccessibleKeystrokeListener *listener)
156 /* Would prefer this not to be bonobo api */
157 bonobo_object_unref (BONOBO_OBJECT (listener));