2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001-2005 Ximian, Inc. and 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_IDL_
24 #define _ACCESSIBILITY_IDL_
26 #ifndef __ACCESSIBILITY_COMPILATION__
29 #pragma include_defs Accessibility.h
35 #ifndef _BONOBO_IDL_INCLUDED_
36 #define _BONOBO_IDL_INCLUDED_
37 #include <Bonobo_Unknown.idl>
38 #endif /* _BONOBO_IDL_INCLUDED_ */
40 /*!\mainpage AT-SPI Interfaces and Subinterfaces
42 * This is the main documentation page for the
43 * Assistive Technology Service Provider Interface (AT-SPI).
45 * \section apps Applications and Interface Components
46 * Namespace Accessibility includes service APIs implemented by
47 * participating applications and their user interface components:\n\n
48 * Accessibility::Accessible\n
49 * Accessibility::Application\n
50 * Accessibility::Desktop\n
51 * Accessibility::Component\n
52 * Accessibility::Hypertext\n
53 * Accessibility::Image\n
54 * Accessibility::Selection\n
55 * Accessibility::StreamableContent\n
56 * Accessibility::Table\n
57 * Accessibility::Text\n
58 * Accessibility::EditableText\n
59 * Accessibility::Value
61 * \section types Enumerated Types
62 * Accessibility defines a number of key enumerated types, including:\n\n
63 * Accessibility::RelationType\n
64 * Accessibility::Role\n
65 * Accessibility::StateType\n
66 * Accessibility::Event\n
67 * Accessibility::EventDetails \n
70 * Accessibility also includes Accessibility::Registry,
71 * which is the service used by assistive technologies and related
72 * AT-SPI clients to register interest in certain classes of events,
73 * enumerate the currently available desktop and application list,
74 * and to synthesize certain kinds of device events.
76 * \section listeners Event Listener Interfaces
77 * Accessibility::EventListener\n
78 * Accessibility::DeviceEventListener
80 * \section helpers Helper Interfaces
82 * The following interfaces may be implemented by assistive technologies
83 * themselves, in order to export their services in a consistent manner or
84 * in order to interoperate with other applications or desktop services.\n
86 * Accessibility::LoginHelper : Implemented by adaptive technologies which
87 * need to participate in user-authentication or login activities, and which
88 * therefore may need negotiation with authentication agents or processes.\n
90 * Accessibility::Selector [NEW]: Implemented by user agents or assistive
91 * technologies which export lists of choices from which the end-user is
92 * expected to make selections. Useful for various types of remote
93 * activation or intercommunication between multiple ATs.
97 * Accessibility interfaces and subinterfaces
99 #include <Accessibility_Accessible.idl>
100 #include <Accessibility_Action.idl>
101 #include <Accessibility_Component.idl>
102 #include <Accessibility_Hyperlink.idl>
103 #include <Accessibility_Image.idl>
104 #include <Accessibility_Selection.idl>
105 #include <Accessibility_StreamableContent.idl>
106 #include <Accessibility_Table.idl>
107 #include <Accessibility_Text.idl>
108 #include <Accessibility_Value.idl>
111 * Interfaces derived from Accessibility::Text
114 #include <Accessibility_EditableText.idl>
115 #include <Accessibility_Hypertext.idl>
118 * Utility interfaces and interfaces derived from Accessibility::Accessible
121 #include <Accessibility_Relation.idl>
122 #include <Accessibility_State.idl>
123 #include <Accessibility_Application.idl>
124 #include <Accessibility_Desktop.idl>
125 #include <Accessibility_Event.idl>
126 #include <Accessibility_Registry.idl>
127 #include <Accessibility_Role.idl>
128 #include <Accessibility_LoginHelper.idl>
129 #include <Accessibility_Selector.idl>
131 #ifndef __ACCESSIBILITY_COMPILATION__