README

   1 README
   2
   3 at-spi version 1.17.2
   4
   5 This version of at-spi requires atk 1.17.0 or later.
   6
   7 *** Welcome to the Gnome Accessibility Project! ***
   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         Though IDL is often associated with CORBA, and this
  26         implementation of the at-spi is CORBA-based, these
  27         interfaces are not CORBA-specific, rather they define
  28         the abstract "contract" between accessible application
  29         and client assistive technology.
  30
  31         Assistive Technologies will not normally be concerned
  32         with the underlying implementation details of the IDL.
  33
  34     libspi : this directory contains implementation-specific
  35         code which connects the in-process ATK interfaces
  36         (implemented by GTK+ and, potentially, by other
  37         native-code UI toolkits) to the interprocess SPI.
  38         It also contains implementation code used by the
  39         central accessibility registry. These sources are
  40         used to build libspi.so, a shared object library which
  41         is used by accessibility clients and servers alike.
  42         This interfaces exposed in this library are ordinarily
  43         not directly used by AT, but are used by the C bindings,
  44         thus AT must dynamically link to this library.
  45
  46     registryd : this directory contains code specific to the
  47         central accessibility registry, and the registry
  48         executable is built in this directory.
  49
  50     atk-bridge : this directory contains code that bridges
  51         the at-spi to the GTK+ toolkit, and which is
  52         loaded at runtime by GTK+-based Gnome applications.
  53         The 'bridge' automatically registers GTK+-2.0
  54         applications with the accessibility registry,
  55         and relays UI events from application to registry.
  56         It is also responsible for servicing requests from
  57         the registry to register handlers for specific event
  58         types.
  59
  60     cspi : this directory contains the C bindings for use by
  61         ATs, and the code which adapts the implementation-specific
  62         code to the C bindings API.  The header file
  63         "spi.h" contains the API declarations used by AT clients.
  64
  65     tests : this directory should be called 'examples', since
  66         it contains not only test programs, but examples
  67         of how to use the AT-SPI.  The sample program
  68         "simple-at.c" is currently the primary example of
  69         how the C bindings API should be used.
  70
  71     docs : this directory contains documentation for the AT-SPI.
  72         Documentation is currently limited to API documentation
  73         for the C bindings API, and is built from sources
  74         via the 'gtk-doc' system.
  75
  76 Building the documentation ============================
  77
  78 Pre-built versions of the HTML documentation are available at
  79 http://developer.gnome.org/projects/gap/tech-docs/at-spi-docs/book1.html.
  80 However the documentation in the docs directory is the most up-to-date.
  81 Building the docs requires docbook and jade, see the 'gtk-doc'
  82 package (from Gnome CVS) for more information.
  83
  84 Use of the AT-SPI ======================================
  85
  86 Accessible applications will register with this registry service
  87 (via bonobo-activation) and adaptive/assistive technologies will
  88 register with the service as well, to indicate their interest in
  89 receiving UI events.  ATs can also use the registry's services
  90 programmatically to query accessible applications.
  91
  92 Running the test programs: ============================
  93
  94 At the moment the only clients and are two test at clients
  95 ('at' and 'simple-at').  There is also a test app ('app) in
  96 the 'tests' subdirectory.
  97
  98 If you have a working ORBit2/bonobo-activation installation you can
  99 run the tests after adding the registryd directory to the
 100 bonobo-activation directory list with bonobo-activation-sysconf,
 101 or by installing Accessibility_Registry.server in your
 102 bonobo-activation 'servers' directory.
 103
 104 You can then run './at' and './app' from the 'test' directory, to see
 105 'app' register as an application, and 'at' as a listening client.
 106 Bonobo should take care of the job of bootstrapping the registry daemon
 107 ('registryd') for you.  These test programs use the bonobo/CORBA
 108 C bindings directly.
 109
 110 The third test program, "simple-at", is a better illustration of how
 111 most actual AT should use the at-spi, via the C bindings library
 112 (documented online at
 113 http://developer.gnome.org/projects/gap/tech-docs/at-spi-docs/book1.html).
 114 Though 'simple-at' will work with the test application 'app',
 115 a better demonstration of the AT-SPI can be made after installing
 116 libspi and libcspi (via 'make install').  If you set the GTK_MODULES
 117 environment variable to "gail:atk-bridge", any GTK+2.0
 118 application run subsequently will register with the at-spi registry,
 119 and 'simple-at' will register for and receive focus and
 120 buttonpress events from those applications.
 121
 122 At the moment application and at deregistration are not 100% reliable,
 123 so if you get you are advised to kill the registry daemon if you exit either 'at' or 'app'
 124 instances, via the 'bonobo-slay' command. You may run as many instances
 125 of each application or sample AT client as you like, concurrently -
 126 you may find it useful to do so in separate terminal windows.
 127
 128 'at' connects to the registry as an event listener, then queries the
 129 service for the number of virtual desktops (currently always 0 or 1),
 130 and queries each desktop for the accessible applications it is running.
 131 It then prints out the name of each such application (as reported by the
 132 application's accessibility interfaces), and then waits to receive events.
 133
 134 'app' connects to the registry as an application, then dispatches an
 135 event which the registry should relay to all registered listeners.
 136 Thus instances of 'app' run after 'at' should cause the 'at' instances
 137 to receive events.
 138
 139
 140 -Bill