X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fat-spi2-atk.git;a=blobdiff_plain;f=README;h=eb23e8a698ba8c9095ce95a01ada39f8e2495fab;hp=c46a5962c40cbb04d8fb37681a8d544f6370c0fd;hb=cb2523a5b191d6d3a5ee27869c5aec41e0a8213d;hpb=3b18e67baf0ec2af2dc0801d67188d5ca69ffaef diff --git a/README b/README index c46a596..eb23e8a 100644 --- a/README +++ b/README @@ -1,72 +1,86 @@ -at-spi version 1.9.0 +D-Bus AT-SPI +------------ -This version of at-spi requires atk 1.17.0 or later. - -This version of at-spi is a MAJOR break from previous versions. +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. -If you have not already done so, please visit +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: + + git://git.gnome.org/at-spi2-atk + +Code in this repository depends on at-spi2-core resources. The +at-spi2-core repository can be found at: + + git://git.gnome.org/at-spi2-core + +More information +---------------- -http://developer.gnome.org/projects/gap +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. -for background information on accessibility, the Gnome -Accessibility Project, mailing list info, and project status. + http://live.gnome.org/GAP/AtSpiDbusInvestigation/ -Contents of this package ================================== +Other sources of relevant information about AT-SPI and Accessibility +include: + + http://live.gnome.org/Accessibility + http://www.sun.com/software/star/gnome/accessibility/architecture.xml + http://accessibility.kde.org/developer/atk.php + http://www.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. + +Directory structure +------------------- The directories within this package are arranged as follows: - idl : This directory contains the interface definitions - (in Interface Definition Language) for the - accessibility support interfaces exposed by - the AT central registry, accessible applications, - and UI components. - - This is possibly historic. The idl formed the basis - for the XML protocol definitions now located - in the directory "xml". - - xml : This directory contains XML documents describing - the D-Bus protocol in a subset of Telepathy XML. - - tools : Miscellaneous tools. Mostly for converting protocol - XML into D-Bus introspection, 'C' types and documentation. - - 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. - - dbind : Library to ease making D-Bus method calls, contains - marshalling code to convert function arguments - and a provided D-Bus signature into a D-Bus message. - - Used by cspi. - - spi-common : Contains 'C' types derived from the D-Bus - protocol specification. These types are used by - both the registry daemon and the ATK adaptor. - Structures are mainly related to events. - - registryd : This directory contains code specific to the - central accessibility registry, and the registry - executable is built in this directory. - - 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. - - cspi : The client (AT) side interface - 'C' bindings. - - registryd : The registry daemon code. The registry daemon - keeps a register of accessible applications and presents - this to clients (ATs). - It is also responsible for delivering device events. + 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.