2001-08-15 Mark McLoughlin <mark@skynet.ie>
[platform/core/uifw/at-spi2-atk.git] / README
1 This is the initial CVS checkin of the Gnome Accessibility Project's
2 Assistive Technology Service Provider Interface.
3
4 At the moment it does not include IDL for all of the SPI, but it does
5 provide a prototype implementation of the core of the out-of-process
6 accessibility service, the 'registry'.
7
8 Accessible applications will register with this registry service (via OAF)
9 and adaptive/assistive technologies will register with the service as
10 well, to indicate their interest in receiving UI events.  ATs can also use
11 the registry's services programmatically to query accessible applications.
12
13
14 Running the test programs: ============================
15
16 At the moment the only clients and 'apps' are the test at client and
17 test app in the 'tests' subdirectory.
18
19 If you have a working ORBit2/OAF installation you can run the tests after
20 adding the registryd directory to OAF's directory list with oaf-sysconf,
21 or by installing Accessibility_Registry.oaf in your 'oafinfo' directory.
22
23 You can then run './at' and './app' from the 'test' directory, to see
24 'app' register as an application, and 'at' as a listening client.
25 OAF should take care of the job of bootstrapping the registry daemon
26 ('registryd') for you.
27
28 At the moment app and at deregistration are broken, so you are advised
29 to kill the registry daemon if you exit either 'at' or 'app' instances.
30 You may run as many instances of each as you like, concurrently - you
31 may find it useful to do so in separate terminal windows.
32
33
34 'at' connects to the registry as an event listener, then queries the
35 service for the number of virtual desktops (currently always 0 or 1),
36 and queries each desktop for the accessible applications it is running.
37 It then prints out the name of each such application (as reported by the
38 application's accessibility interfaces), and then waits to receive events.
39
40 'app' connects to the registry as an application, then dispatches an
41 event which the registry should relay to all registered listeners.
42 Thus instances of 'app' run after 'at' should cause the 'at' instances
43 to receive events.
44
45
46 -Bill