1 <?xml version="1.0" encoding="UTF-8"?>
2 <tp:spec xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" xmlns:xi="http://www.w3.org/2001/XInclude">
5 <tp:version>1.24.0</tp:version>
12 !\mainpage AT-SPI Interfaces and Subinterfaces
14 This is the main documentation page for the
15 Assistive Technology Service Provider Interface (AT-SPI).
17 \section apps Applications and Interface Components
18 Namespace Accessibility includes service APIs implemented by
19 participating applications and their user interface components:\n\n
20 Accessibility::Accessible\n
21 Accessibility::Application\n
22 Accessibility::Desktop\n
23 Accessibility::Collecgtion\n
24 Accessibility::Component\n
25 Accessibility::Hypertext\n
26 Accessibility::Image\n
27 Accessibility::Selection\n
28 Accessibility::Table\n
30 Accessibility::EditableText\n
33 \section types Enumerated Types
34 Accessibility defines a number of key enumerated types, including:\n\n
35 Accessibility::RelationType\n
37 Accessibility::StateType\n
38 Accessibility::Event\n
39 Accessibility::EventDetails \n
42 Accessibility also includes Accessibility::Registry,
43 which is the service used by assistive technologies and related
44 AT-SPI clients to register interest in certain classes of events,
45 enumerate the currently available desktop and application list,
46 and to synthesize certain kinds of device events.
48 \section listeners Event Listener Interfaces
49 Accessibility::EventListener\n
50 Accessibility::DeviceEventListener
52 \section helpers Helper Interfaces
54 The following interfaces may be implemented by assistive technologies
55 themselves, in order to export their services in a consistent manner or
56 in order to interoperate with other applications or desktop services.\n
58 Accessibility::LoginHelper : Implemented by adaptive technologies which
59 need to participate in user-authentication or login activities, and which
60 therefore may need negotiation with authentication agents or processes.\n
62 Accessibility::Selector [NEW]: Implemented by user agents or assistive
63 technologies which export lists of choices from which the end-user is
64 expected to make selections. Useful for various types of remote
65 activation or intercommunication between multiple ATs.
68 <!-- Accessibility interfaces and subinterfaces -->
70 <xi:include href="org.freedesktop.atspi.Accessible.xml"/>
71 <xi:include href="org.freedesktop.atspi.Action.xml"/>
72 <xi:include href="org.freedesktop.atspi.Collection.xml"/>
73 <xi:include href="org.freedesktop.atspi.Component.xml"/>
74 <xi:include href="org.freedesktop.atspi.Document.xml"/>
75 <xi:include href="org.freedesktop.atspi.Hyperlink.xml"/>
76 <xi:include href="org.freedesktop.atspi.Image.xml"/>
77 <xi:include href="org.freedesktop.atspi.Selection.xml"/>
78 <xi:include href="org.freedesktop.atspi.Table.xml"/>
79 <xi:include href="org.freedesktop.atspi.Text.xml"/>
80 <xi:include href="org.freedesktop.atspi.Cache.xml"/>
81 <xi:include href="org.freedesktop.atspi.Value.xml"/>
83 <!-- Interfaces derived from Accessibility::Text -->
84 <xi:include href="org.freedesktop.atspi.EditableText.xml"/>
85 <xi:include href="org.freedesktop.atspi.Hypertext.xml"/>
86 <xi:include href="org.freedesktop.atspi.State.xml"/>
88 <!-- Utility interfaces and interfaces derived from Accessibility::Accessible -->
90 <xi:include href="org.freedesktop.atspi.Application.xml"/>
91 <xi:include href="org.freedesktop.atspi.Registry.xml"/>
92 <xi:include href="org.freedesktop.atspi.DeviceEvent.xml"/>
93 <xi:include href="org.freedesktop.atspi.Desktop.xml"/>
94 <xi:include href="org.freedesktop.atspi.DeviceEventController.xml"/>
95 <xi:include href="org.freedesktop.atspi.DeviceEventListener.xml"/>
96 <xi:include href="org.freedesktop.atspi.Relation.xml"/>
97 <xi:include href="org.freedesktop.atspi.Role.xml"/>