GTK+ module for bridging AT-SPI to ATK

Mike Gorse ae46f8893b 2.29.1 1 month ago
atk-adaptor ddcecf6fa3 Use a consistent include for config.h 3 months ago
config 6ffdf18338 Add a NONCE file to the config diretory, ensuring its existence on checkout. 8 years ago
droute 37d6e4cb96 Add missing return on error 3 months ago
tests 7d97d8e691 Do not run tests 3 months ago
.gitignore 2907a9c4e6 Remove Autotools files from the ignored list 3 months ago
AUTHORS 1f92a759f0 Updated AUTHORS/MAINTAINERS/doap 3 years ago
COPYING c0a98e7b30 2008-11-13 Mark Doffman <mark.doffman@codethink.co.uk> 9 years ago
MAINTAINERS 8f9537dda9 Update email address in MAINTAINERS 11 months ago
NEWS ae46f8893b 2.29.1 1 month ago
README 0415628d74 docs: Merge INSTALL into the README 3 months ago
at-spi2-atk.desktop 6f7ca3f9b4 Change accessibility key name 7 years ago
at-spi2-atk.doap 68662a3bb1 Release v2.17.1 3 years ago
meson.build ae46f8893b 2.29.1 1 month ago
meson_options.txt d2763f29cb Add Meson build system 1 year ago

README

D-Bus AT-SPI
------------

This version of at-spi is a major break from version 1.x.
It has been completely rewritten to use D-Bus rather than
ORBIT / CORBA for its transport protocol.

A page including instructions for testing, project status and
TODO items is kept up to date at:

http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus

The mailing list used for general questions is:

accessibility-atspi@lists.linux-foundation.org

For bug reports, feature requests, patches or enhancements please use
the AT-SPI project on bugzilla.gnome.org. Use the at-spi2-atk component for
bugs specific to this module.

http://bugzilla.gnome.org

A git repository with the latest development code is available at:

https://git.gnome.org/browse/at-spi2-atk

Code in this repository depends on at-spi2-core resources. The
at-spi2-core repository can be found at:

https://git.gnome.org/browse/at-spi2-core

More information
----------------

The project was started with a D-Bus performance review
the results of which are available on the GNOME wiki. Keep in
mind that the D-Bus AT-SPI design documents on this page
have not been kept up to date.

https://wiki.gnome.org/Accessibility/Documentation/GNOME2/ATSPI2-Investigation

Other sources of relevant information about AT-SPI and Accessibility
include:

https://wiki.gnome.org/Accessibility
https://accessibility.kde.org/developer/atk.php
https://people.gnome.org/~billh/at-spi-idl/html/



Contents of this package
------------------------

This package includes libatk-bridge, a library that bridges ATK to the new
D-Bus based AT-SPI, as well as a corresponding module for gtk+ 2.x. Gtk+ 3.x
now links against libatk-bridge directly rather than requiring it to be loaded
as a module.

These libraries depend on the at-spi2-core code that contains the daemon for
registering applications, D-Bus helper libraries and the AT-SPI D-Bus specifications.

Building this package
---------------------

In order to build at-spi2-atk you will need:

- Python 3.5
- Meson
- Ninja

Additionally, you will need the development files for:

- libdbus
- GLib
- GTK+ 3.x
- ATK
- AT-SPI

To build and install this package, you will typically need to run `meson` to
configure the build process, and Ninja to run the compilation and installation
instructions:

# Configure the build and initialize the build directory
meson _build .

# Enter the build directory
cd _build

# Build the project
ninja

# Install the project
sudo ninja install

Tests
-----

To run the test suite, use `meson test` from the build directory.

Directory structure
-------------------

The directories within this package are arranged as follows:

droute

Contains a framework for registering objects
with a D-Bus connection and for routing messages to
the implementing object.

Used by the ATK adaptor.

atk-adaptor

This directory contains code that bridges
the at-spi to the GTK+ toolkit, and which is
loaded at runtime by GTK+-based Gnome applications.
The 'bridge' automatically registers GTK+-2.0
applications with the accessibility registry,
and relays UI events from application to registry.
It is also responsible for servicing requests from
the registry to register handlers for specific event
types.

tests

Contains tests for atspi.
More details in tests/README