summaryrefslogtreecommitdiff
path: root/idl/Accessibility.idl
blob: 63ff91dcb574832ad49e6a550f6c431bc329a0fc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/* 
 * AT-SPI - Assistive Technology Service Provider Interface 
 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
 *
 * Copyright 2001-2005 Ximian, Inc. and Sun Microsystems, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _ACCESSIBILITY_IDL_
#define _ACCESSIBILITY_IDL_

#ifndef  __ACCESSIBILITY_COMPILATION__
#ifdef   __ORBIT_IDL__
%{
#pragma include_defs Accessibility.h
%}
#pragma inhibit push
#endif
#endif

#ifndef _BONOBO_IDL_INCLUDED_
#define _BONOBO_IDL_INCLUDED_
#include <Bonobo_Unknown.idl>
#endif /* _BONOBO_IDL_INCLUDED_ */

/*!\mainpage AT-SPI Interfaces and Subinterfaces
 *
 * This is the main documentation page for the 
 * Assistive Technology Service Provider Interface (AT-SPI). 
 * 
 * \section apps Applications and Interface Components
 * Namespace Accessibility includes service APIs implemented by
 * participating applications and their user interface components:\n\n
 * Accessibility::Accessible\n 
 * Accessibility::Application\n
 * Accessibility::Desktop\n
 * Accessibility::Component\n
 * Accessibility::Hypertext\n
 * Accessibility::Image\n
 * Accessibility::Selection\n
 * Accessibility::StreamableContent\n
 * Accessibility::Table\n
 * Accessibility::Text\n
 * Accessibility::EditableText\n
 * Accessibility::Value
 *
 * \section types Enumerated Types
 * Accessibility defines a number of key enumerated types, including:\n\n
 * Accessibility::RelationType\n
 * Accessibility::Role\n
 * Accessibility::StateType\n
 * Accessibility::Event\n
 * Accessibility::EventDetails \n
 *
 * \section Registry
 * Accessibility also includes Accessibility::Registry,
 * which is the service used by assistive technologies and related
 * AT-SPI clients to register interest in certain classes of events,
 * enumerate the currently available desktop and application list,
 * and to synthesize certain kinds of device events.
 *
 * \section listeners Event Listener Interfaces
 * Accessibility::EventListener\n
 * Accessibility::DeviceEventListener
 *
 * \section helpers Helper Interfaces
 *
 * The following interfaces may be implemented by assistive technologies 
 * themselves, in order to export their services in a consistent manner or
 * in order to interoperate with other applications or desktop services.\n
 *
 * Accessibility::LoginHelper : Implemented by adaptive technologies which 
 * need to participate in user-authentication or login activities, and which
 * therefore may need negotiation with authentication agents or processes.\n
 *
 * Accessibility::Selector [NEW]: Implemented by user agents or assistive 
 * technologies which export lists of choices from which the end-user is 
 * expected to make selections.  Useful for various types of remote
 * activation or intercommunication between multiple ATs.
 **/

/*
 * Accessibility interfaces and subinterfaces
 */
#include <Accessibility_Accessible.idl>
#include <Accessibility_Action.idl>
#include <Accessibility_Component.idl>
#include <Accessibility_Hyperlink.idl>
#include <Accessibility_Image.idl>
#include <Accessibility_Selection.idl>
#include <Accessibility_StreamableContent.idl>
#include <Accessibility_Table.idl>
#include <Accessibility_Text.idl>
#include <Accessibility_Value.idl>

/*
 * Interfaces derived from Accessibility::Text
 */

#include <Accessibility_EditableText.idl>
#include <Accessibility_Hypertext.idl>

/*
 * Utility interfaces and interfaces derived from Accessibility::Accessible
 */

#include <Accessibility_Relation.idl>
#include <Accessibility_State.idl>
#include <Accessibility_Application.idl>
#include <Accessibility_Desktop.idl>
#include <Accessibility_Event.idl>
#include <Accessibility_Registry.idl>
#include <Accessibility_Role.idl>
#include <Accessibility_LoginHelper.idl>
#include <Accessibility_Selector.idl>

#ifndef __ACCESSIBILITY_COMPILATION__
#ifdef  __ORBIT_IDL__
#pragma inhibit pop
#endif
#endif

#endif