-
- cspi : this directory contains the C bindings for use by
- ATs, and the code which adapts the implementation-specific
- code to the C bindings API. The header file
- "spi.h" contains the API declarations used by AT clients.
-
- pyatspi: this directory is an unified python binding used by ATs.
-
- tests : this directory should be called 'examples', since
- it contains not only test programs, but examples
- of how to use the AT-SPI. The sample program
- "simple-at.c" is currently the primary example of
- how the C bindings API should be used.
-
- docs : this directory contains documentation for the AT-SPI.
- Documentation is currently limited to API documentation
- for the C bindings API, and is built from sources
- via the 'gtk-doc' system.
-
-Building the documentation ============================
-
-Pre-built versions of the HTML documentation are available at
-http://developer.gnome.org/projects/gap/tech-docs/at-spi-docs/book1.html.
-However the documentation in the docs directory is the most up-to-date.
-Building the docs requires docbook and jade, see the 'gtk-doc'
-package (from Gnome CVS) for more information.
-
-Use of the AT-SPI ======================================
-
-Accessible applications will register with this registry service
-(via bonobo-activation) and adaptive/assistive technologies will
-register with the service as well, to indicate their interest in
-receiving UI events. ATs can also use the registry's services
-programmatically to query accessible applications.
-
-Running the test programs: ============================
-
-At the moment the only clients and are two test at clients
-('at' and 'simple-at'). There is also a test app ('app) in
-the 'tests' subdirectory.
-
-If you have a working ORBit2/bonobo-activation installation you can
-run the tests after adding the registryd directory to the
-bonobo-activation directory list with bonobo-activation-sysconf,
-or by installing Accessibility_Registry.server in your
-bonobo-activation 'servers' directory.
-
-You can then run './at' and './app' from the 'test' directory, to see
-'app' register as an application, and 'at' as a listening client.
-Bonobo should take care of the job of bootstrapping the registry daemon
-('registryd') for you. These test programs use the bonobo/CORBA
-C bindings directly.
-
-The third test program, "simple-at", is a better illustration of how
-most actual AT should use the at-spi, via the C bindings library
-(documented online at
-http://developer.gnome.org/projects/gap/tech-docs/at-spi-docs/book1.html).
-Though 'simple-at' will work with the test application 'app',
-a better demonstration of the AT-SPI can be made after installing
-libspi and libcspi (via 'make install'). If you set the GTK_MODULES
-environment variable to "gail:atk-bridge", any GTK+2.0
-application run subsequently will register with the at-spi registry,
-and 'simple-at' will register for and receive focus and
-buttonpress events from those applications.
-
-At the moment application and at deregistration are not 100% reliable,
-so if you get you are advised to kill the registry daemon if you exit either 'at' or 'app'
-instances, via the 'bonobo-slay' command. You may run as many instances
-of each application or sample AT client as you like, concurrently -
-you may find it useful to do so in separate terminal windows.
-
-'at' connects to the registry as an event listener, then queries the
-service for the number of virtual desktops (currently always 0 or 1),
-and queries each desktop for the accessible applications it is running.
-It then prints out the name of each such application (as reported by the
-application's accessibility interfaces), and then waits to receive events.
-
-'app' connects to the registry as an application, then dispatches an
-event which the registry should relay to all registered listeners.
-Thus instances of 'app' run after 'at' should cause the 'at' instances
-to receive events.
-
-
--Bill
projects / platform / core / uifw / at-spi2-atk.git / blobdiff