2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001-2004 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 #ifndef __ACCESSIBILITY_APPLICATION_DEFINED__
24 #define __ACCESSIBILITY_APPLICATION_DEFINED__
26 #include <Accessibility_Accessible.idl>
28 module Accessibility {
31 * An interface identifying an object which is the root of the
32 * user interface Accessible hierarchy associated with a running application.
33 * Children of Application are typically, but not exclusively,
35 * @note It is possible for an element deeper in an Accessibility stack to
36 * implement Application, for instance in the case of "embedded applications"
37 * which draw into toplevel windows associated with other applications
38 * from the user's point of view.
40 interface Application : Accessible {
43 * A string indicating the type of user interface toolkit
44 * which is used by the application.
45 * @note Ordinarily clients of ::Application should be
46 * toolkit-agnostic, dependencies on this property should
47 * be avoided where possible.
49 readonly attribute string toolkitName;
52 * A string indicating the version number of the application's
53 * accessibility bridge implementation.
55 readonly attribute string version;
58 * The application instance's unique ID as assigned by the registry.
63 * @param listener: an ::EventListener object which will receive the requested
64 * events from the application's toolkits via toolit 'bridges'
65 * @param eventName: a UTF-8 string indicating the type of (toolkit-specific) event
66 * being requested. Not all applications can generate toolkit events of
69 * Register with this application's toolkit for "toolkit-specific" event notifications.
71 * For most event support, clients should use non-toolkit-specific events
72 * whenever possible, via ::Registry::registerGlobalEventListener - this method
73 * is provided as a 'back door' when generic names do not exist for the events in
76 void registerToolkitEventListener (in EventListener listener, in string eventName);
79 * registerObjectEventListener:
80 * @param listener: an ::EventListener object which will receive the requested
82 * @param eventName: a UTF-8 string indicating the type of (toolkit-specific) event
84 * Register with this application toolkit for "Accessibility::Accessible"
85 * event notifications.
86 * @note: SUBJECT TO DEPRECATION.
88 void registerObjectEventListener (in EventListener listener, in string eventName);
91 * Request that the application temporarily stop sending events.
92 * In most cases this should pause the application's main event loop.
94 * @returns: \c true if the request succeeded, \c false otherwise.
96 * @note: This method is not implemented in most toolkits, and therefore should be treated with caution.
101 * Request that the application resume sending events.
103 * @returns: \c True if the request succeeded, \c False otherwise.
108 * Gets the locale in which the application is currently operating.
109 * For the current message locale, use \a lctype LOCALE_TYPE_MESSAGES.
111 * @param lctype The LocaleType for which the locale is queried.
112 * @returns a string compliant with the POSIX standard for locale description.
114 string getLocale (in LOCALE_TYPE lctype);
116 /**\cond (This comment tells doxygen not to document these) */
117 void unImplemented_ ();
118 void unImplemented2_ ();
119 void unImplemented3_ ();