Fix an errant g_object_unref
[platform/core/uifw/at-spi2-atk.git] / README
1 D-Bus AT-SPI
2 ------------
3
4 This version of at-spi is a major break from previous versions.
5 It has been completely rewritten to use D-Bus rather than
6 ORBIT / CORBA for its transport protocol.
7
8 A page including instructions for testing, project status and
9 TODO items is kept up to date at:
10
11         http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus
12
13 The mailing list used for general questions is:
14
15         accessibility-atspi@lists.linux-foundation.org
16
17 For bug reports, feature requests, patches or enhancements please use
18 bugzilla. The freedesktop project name is at-spi2.
19
20         http://bugs.freedesktop.org
21
22 A git repository with the latest development code is available at:
23
24         git://anongit.freedesktop.org/git/at-spi2/att-spi2-atk
25
26 Code in this repository depends on at-spi2-core resources. The
27 at-spi2-core repository can be found at:
28
29         git://anongit.freedesktop.org/git/at-spi2/att-spi2-core
30
31 More information
32 ----------------
33
34 The project was started with a D-Bus performance review
35 the results of which are available on the GNOME wiki. Keep in
36 mind that the D-Bus AT-SPI design documents on this page
37 have not been kept up to date.
38
39         http://live.gnome.org/GAP/AtSpiDbusInvestigation/
40
41 Other sources of relevant information about AT-SPI and Accessibility
42 include:
43
44         http://live.gnome.org/Accessibility
45         http://www.sun.com/software/star/gnome/accessibility/architecture.xml
46         http://accessibility.kde.org/developer/atk.php
47         http://www.gnome.org/~billh/at-spi-idl/html/
48
49
50
51 Contents of this package
52 ------------------------
53
54 This package includes a gtk-module that bridges ATK to the new D-Bus based AT-SPI
55 as well as 'C' and Python client libraries.
56
57 These libraries depend on the at-spi2-core code that contains the daemon for
58 registering applications, D-Bus helper libraries and te AT-SPI D-Bus specifications.
59
60 Directory structure
61 -------------------
62
63 The directories within this package are arranged as follows:
64
65     common
66
67         Contains 'C' types derived from the D-Bus
68         protocol specification. These types are used by 
69         the ATK adaptor and 'Cspi'.
70         Structures are mainly related to events.
71
72     droute
73
74         Contains a framework for registering objects
75         with a D-Bus connection and for routing messages to
76         the implementing object.
77
78         Used by the ATK adaptor.
79
80     dbind
81
82         Library to ease making D-Bus method calls, contains
83         marshalling code to convert function arguments
84         and a provided D-Bus signature into a D-Bus message.
85
86         Used by cspi.
87
88     atk-adaptor
89
90         This directory contains code that bridges 
91         the at-spi to the GTK+ toolkit, and which is
92         loaded at runtime by GTK+-based Gnome applications.
93         The 'bridge' automatically registers GTK+-2.0
94         applications with the accessibility registry, 
95         and relays UI events from application to registry.
96         It is also responsible for servicing requests from
97         the registry to register handlers for specific event
98         types.
99
100     cspi
101
102         The client (AT) side interface - 'C' bindings.
103
104     pyatspi
105
106         The python client library for accessing D-Bus accessibility.