2008-07-23 Mark Doffman <mark.doffman@codethink.co.uk>
[platform/core/uifw/at-spi2-atk.git] / README
1 at-spi version 1.9.0
2
3 This version of at-spi requires atk 1.17.0 or later.
4
5 This version of at-spi is a MAJOR break from previous versions.
6 It has been completely rewritten to use D-Bus rather than
7 ORBIT / CORBA for its transport protocol.
8
9 If you have not already done so, please visit 
10
11 http://developer.gnome.org/projects/gap 
12
13 for background information on accessibility, the Gnome 
14 Accessibility Project, mailing list info, and project status.
15
16 Contents of this package ==================================
17
18 The directories within this package are arranged as follows:
19
20     idl : This directory contains the interface definitions
21         (in Interface Definition Language) for the
22         accessibility support interfaces exposed by
23         the AT central registry, accessible applications,
24         and UI components.
25
26         This is possibly historic. The idl formed the basis
27         for the XML protocol definitions now located
28         in the directory "xml".
29
30     xml : This directory contains XML documents describing
31         the D-Bus protocol in a subset of Telepathy XML.
32
33     tools : Miscellaneous tools. Mostly for converting protocol
34         XML into D-Bus introspection, 'C' types and documentation.
35
36     droute : Contains a framework for registering objects
37         with a D-Bus connection and for routing messages to
38         the implementing object.
39
40         Used by the ATK adaptor.
41
42     dbind : Library to ease making D-Bus method calls, contains
43         marshalling code to convert function arguments
44         and a provided D-Bus signature into a D-Bus message.
45         
46         Used by cspi.
47
48     spi-common : Contains 'C' types derived from the D-Bus
49         protocol specification. These types are used by 
50         both the registry daemon and the ATK adaptor.
51         Structures are mainly related to events.
52
53     registryd : This directory contains code specific to the
54         central accessibility registry, and the registry
55         executable is built in this directory.
56
57     atk-adaptor : This directory contains code that bridges 
58         the at-spi to the GTK+ toolkit, and which is
59         loaded at runtime by GTK+-based Gnome applications.
60         The 'bridge' automatically registers GTK+-2.0
61         applications with the accessibility registry, 
62         and relays UI events from application to registry.
63         It is also responsible for servicing requests from
64         the registry to register handlers for specific event
65         types.
66
67     cspi : The client (AT) side interface - 'C' bindings.
68
69     registryd : The registry daemon code. The registry daemon
70         keeps a register of accessible applications and presents
71         this to clients (ATs).
72         It is also responsible for delivering device events.