docs/atk-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
   4 [
   5   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
   6   <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
   7   %gtkdocentities;
   8 ]>
   9
  10 <book>
  11   <bookinfo>
  12     <title>ATK - Accessibility Toolkit</title>
  13     <releaseinfo>for ATK &package_version;</releaseinfo>
  14   </bookinfo>
  15
  16   <chapter id="overview">
  17     <title>Overview</title>
  18      <para>
  19        GNOME provides support for accessibility devices using the ATK
  20        framework. This framework defines a set of interfaces to which
  21        graphical interface components adhere. This allows, for instance,
  22        screen readers to read the text of an interface and interact with its
  23        controls. ATK support is built into GTK+ and the rest of the GNOME
  24        platform, so any application using GTK+ will have reasonable
  25        accessibility support for free.
  26      </para>
  27
  28      <para>
  29      Nonetheless, you should be aware of accessibility issues when when
  30      developing your applications. Although GTK+ interfaces provide
  31      reasonable accessibility by default, you can often improve how well
  32      your program behaves with accessibility tools by providing additional
  33      information to ATK. If you develop custom widgets, you should ensure
  34      that they expose their properties to ATK
  35      </para>
  36
  37   </chapter>
  38
  39   <chapter id="base-object">
  40     <title>Base accessibility object</title>
  41     <xi:include href="xml/atkobject.xml"/>
  42   </chapter>
  43
  44   <chapter id="toolkit">
  45     <title>Event and toolkit support</title>
  46     <xi:include href="xml/atkutil.xml"/>
  47   </chapter>
  48
  49   <chapter id="interfaces">
  50     <title>ATK Interfaces</title>
  51     <xi:include href="xml/atkaction.xml"/>
  52     <xi:include href="xml/atkcomponent.xml"/>
  53     <xi:include href="xml/atkdocument.xml"/>
  54     <xi:include href="xml/atkeditabletext.xml"/>
  55     <xi:include href="xml/atkhyperlinkimpl.xml"/>
  56     <xi:include href="xml/atkhypertext.xml"/>
  57     <xi:include href="xml/atkimage.xml"/>
  58     <xi:include href="xml/atkselection.xml"/>
  59     <xi:include href="xml/atkstreamablecontent.xml"/>
  60     <xi:include href="xml/atktable.xml"/>
  61     <xi:include href="xml/atktablecell.xml"/>
  62     <xi:include href="xml/atktext.xml"/>
  63     <xi:include href="xml/atkvalue.xml"/>
  64     <xi:include href="xml/atkwindow.xml"/>
  65   </chapter>
  66
  67   <chapter id="data">
  68     <title>Basic accessible data types</title>
  69     <xi:include href="xml/atkrange.xml"/>
  70     <xi:include href="xml/atkrelation.xml"/>
  71     <xi:include href="xml/atkrelationset.xml"/>
  72     <xi:include href="xml/atkstate.xml"/>
  73     <xi:include href="xml/atkstateset.xml"/>
  74   </chapter>
  75
  76   <chapter id="accessibles">
  77     <title>Custom accessible objects</title>
  78     <xi:include href="xml/atkgobjectaccessible.xml"/>
  79     <xi:include href="xml/atkhyperlink.xml"/>
  80     <xi:include href="xml/atknoopobject.xml"/>
  81     <xi:include href="xml/atkplug.xml"/>
  82     <xi:include href="xml/atksocket.xml"/>
  83   </chapter>
  84
  85   <chapter id="utilities">
  86     <title>Utilities</title>
  87     <xi:include href="xml/atknoopobjectfactory.xml"/>
  88     <xi:include href="xml/atkobjectfactory.xml"/>
  89     <xi:include href="xml/atkregistry.xml"/>
  90     <xi:include href="xml/atkversion.xml"/>
  91   </chapter>
  92
  93   <chapter id="deprecated">
  94     <title>Deprecated Interfaces</title>
  95     <xi:include href="xml/atkmisc.xml"/>
  96   </chapter>
  97
  98   <index id="api-index-full">
  99     <title>Index of all symbols</title>
 100   </index>
 101   <index id="api-index-deprecated" role="deprecated">
 102     <title>Index of deprecated symbols</title>
 103   </index>
 104   <index id="api-index-1-3" role="1.3">
 105     <title>Index of new symbols in 1.3</title>
 106   </index>
 107   <index id="api-index-1-4" role="1.4">
 108     <title>Index of new symbols in 1.4</title>
 109   </index>
 110   <index id="api-index-1-6" role="1.6">
 111     <title>Index of new symbols in 1.6</title>
 112   </index>
 113   <index id="api-index-1-9" role="1.9">
 114     <title>Index of new symbols in 1.9</title>
 115   </index>
 116   <index id="api-index-1-12" role="1.12">
 117     <title>Index of new symbols in 1.12</title>
 118   </index>
 119   <index id="api-index-1-13" role="1.13">
 120     <title>Index of new symbols in 1.13</title>
 121   </index>
 122   <index id="api-index-1-20" role="1.20">
 123     <title>Index of new symbols in 1.20</title>
 124   </index>
 125   <index id="api-index-1-22" role="1.22">
 126     <title>Index of new symbols in 1.22</title>
 127   </index>
 128   <index id="api-index-1-30" role="1.30">
 129     <title>Index of new symbols in 1.30</title>
 130   </index>
 131   <index id="api-index-2-2" role="2.2">
 132     <title>Index of new symbols in 2.2</title>
 133   </index>
 134   <index id="api-index-2-8" role="2.8">
 135     <title>Index of new symbols in 2.8</title>
 136   </index>
 137   <index id="api-index-2-10" role="2.10">
 138     <title>Index of new symbols in 2.10</title>
 139   </index>
 140   <index id="api-index-2-12" role="2.12">
 141     <title>Index of new symbols in 2.12</title>
 142   </index>
 143
 144   <xi:include href="xml/annotation-glossary.xml"><xi:fallback/></xi:include>
 145 </book>
 146