2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 * AccessibleApplication function prototypes
30 #include <cspi/spi-private.h>
33 * AccessibleApplication_ref:
34 * @obj: a pointer to the #AccessibleApplication on which to operate.
36 * Increment the reference count for an #AccessibleApplication.
39 AccessibleApplication_ref (AccessibleApplication *obj)
41 cspi_object_ref (obj);
45 * AccessibleApplication_unref:
46 * @obj: a pointer to the #AccessibleApplication object on which to operate.
48 * Decrement the reference count for an #AccessibleApplication.
51 AccessibleApplication_unref (AccessibleApplication *obj)
53 cspi_object_unref (obj);
57 * AccessibleApplication_getToolkitName:
58 * @obj: a pointer to the #AccessibleApplication to query.
60 * Get the name of the UI toolkit used by an #AccessibleApplication.
62 * Returns: a UTF-8 string indicating which UI toolkit is
63 * used by an application.
66 AccessibleApplication_getToolkitName (AccessibleApplication *obj)
70 cspi_return_val_if_fail (obj != NULL, NULL);
73 Accessibility_Application__get_toolkitName (CSPI_OBJREF (obj),
76 cspi_return_val_if_ev ("toolkitName", NULL);
82 * AccessibleApplication_getVersion:
83 * @obj: a pointer to the #AccessibleApplication being queried.
85 * Get the version of the at-spi bridge exported by an
86 * #AccessibleApplication instance.
88 * Returns: a UTF-8 string indicating the application's
92 AccessibleApplication_getVersion (AccessibleApplication *obj)
96 cspi_return_val_if_fail (obj != NULL, NULL);
99 Accessibility_Application__get_version (CSPI_OBJREF (obj),
102 cspi_return_val_if_ev ("version", NULL);
108 * AccessibleApplication_getID:
109 * @obj: a pointer to the #AccessibleApplication being queried.
111 * Get the unique ID assigned by the Registry to an
112 * #AccessibleApplication instance.
113 * (Not Yet Implemented by the registry).
115 * Returns: a unique #long integer associated with the application
116 * by the Registry, or 0 if the application is not registered.
119 AccessibleApplication_getID (AccessibleApplication *obj)
123 cspi_return_val_if_fail (obj != NULL, 0);
125 retval = Accessibility_Application__get_id (CSPI_OBJREF (obj),
128 cspi_return_val_if_ev ("id", 0);
134 * AccessibleApplication_pause:
135 * @obj: a pointer to the #Accessible object on which to operate.
137 * Attempt to pause the application (used when client event queue is
139 * Not Yet Implemented.
141 * Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
145 AccessibleApplication_pause (AccessibleApplication *obj)
151 * AccessibleApplication_resume:
152 * @obj: a pointer to the #Accessible object on which to operate.
154 * Attempt to resume the application (used after #AccessibleApplication_pause).
155 * Not Yet Implemented.
157 * Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
161 AccessibleApplication_resume (AccessibleApplication *obj)