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>
34 * AccessibleApplication_ref:
35 * @obj: a pointer to the #AccessibleApplication on which to operate.
37 * Increment the reference count for an #AccessibleApplication.
40 AccessibleApplication_ref (AccessibleApplication *obj)
42 cspi_object_ref (obj);
46 * AccessibleApplication_unref:
47 * @obj: a pointer to the #AccessibleApplication object on which to operate.
49 * Decrement the reference count for an #AccessibleApplication.
52 AccessibleApplication_unref (AccessibleApplication *obj)
54 cspi_object_unref (obj);
58 * AccessibleApplication_getToolkitName:
59 * @obj: a pointer to the #AccessibleApplication to query.
61 * Get the name of the UI toolkit used by an #AccessibleApplication.
63 * Returns: a UTF-8 string indicating which UI toolkit is
64 * used by an application.
67 AccessibleApplication_getToolkitName (AccessibleApplication *obj)
71 cspi_return_val_if_fail (obj != NULL, NULL);
74 Accessibility_Application__get_toolkitName (CSPI_OBJREF (obj),
77 cspi_return_val_if_ev ("toolkitName", NULL);
83 * AccessibleApplication_getVersion:
84 * @obj: a pointer to the #AccessibleApplication being queried.
86 * Get the version of the at-spi bridge exported by an
87 * #AccessibleApplication instance.
89 * Returns: a UTF-8 string indicating the application's
93 AccessibleApplication_getVersion (AccessibleApplication *obj)
97 cspi_return_val_if_fail (obj != NULL, NULL);
100 Accessibility_Application__get_version (CSPI_OBJREF (obj),
103 cspi_return_val_if_ev ("version", NULL);
109 * AccessibleApplication_getID:
110 * @obj: a pointer to the #AccessibleApplication being queried.
112 * Get the unique ID assigned by the Registry to an
113 * #AccessibleApplication instance.
114 * (Not Yet Implemented by the registry).
116 * Returns: a unique #long integer associated with the application
117 * by the Registry, or 0 if the application is not registered.
120 AccessibleApplication_getID (AccessibleApplication *obj)
124 cspi_return_val_if_fail (obj != NULL, 0);
126 retval = Accessibility_Application__get_id (CSPI_OBJREF (obj),
129 cspi_return_val_if_ev ("id", 0);
135 * AccessibleApplication_getLocale:
136 * @obj: a pointer to the #AccessibleApplication being queried.
137 * @lc_category: one of the POSIX LC_TYPE enumeration, for instance
140 * Get a POSIX-compliant string describing the application's current
141 * locale setting for a particular @lctype category.
145 * Returns: a POSIX-compliant locale string, e.g. "C", "pt_BR", "sr@latn", etc.
148 AccessibleApplication_getLocale (AccessibleApplication *obj, int lc_category)
151 Accessibility_LOCALE_TYPE lctype;
153 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup (""));
158 lctype = Accessibility_LOCALE_TYPE_COLLATE;
161 lctype = Accessibility_LOCALE_TYPE_CTYPE;
164 lctype = Accessibility_LOCALE_TYPE_NUMERIC;
167 lctype = Accessibility_LOCALE_TYPE_MONETARY;
171 lctype = Accessibility_LOCALE_TYPE_MESSAGES;
175 retval = Accessibility_Application_getLocale (CSPI_OBJREF (obj),
179 cspi_return_val_if_ev ("id", CORBA_string_dup (""));
181 return CORBA_string_dup (retval);
185 * AccessibleApplication_pause:
186 * @obj: a pointer to the #Accessible object on which to operate.
188 * Attempt to pause the application (used when client event queue is
190 * Not Yet Implemented.
192 * Returns: #TRUE if the application was paused successfully, #FALSE otherwise.
196 AccessibleApplication_pause (AccessibleApplication *obj)
202 * AccessibleApplication_resume:
203 * @obj: a pointer to the #Accessible object on which to operate.
205 * Attempt to resume the application (used after #AccessibleApplication_pause).
206 * Not Yet Implemented.
208 * Returns: #TRUE if application processing resumed successfully, #FALSE otherwise.
212 AccessibleApplication_resume (AccessibleApplication *obj)