README

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