docs/atk-docs.sgml

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