summaryrefslogtreecommitdiff
path: root/docs/atk-docs.sgml
blob: 2d9991e9b8f72156218f0a0e15ede0836415173d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY atk-AtkAction SYSTEM "xml/atkaction.xml">
  <!ENTITY atk-AtkComponent SYSTEM "xml/atkcomponent.xml">
  <!ENTITY atk-AtkDocument SYSTEM "xml/atkdocument.xml">
  <!ENTITY atk-AtkEditabletext SYSTEM "xml/atkeditabletext.xml">
  <!ENTITY atk-AtkGObjectAccessible SYSTEM "xml/atkgobjectaccessible.xml">
  <!ENTITY atk-AtkHyperlink SYSTEM "xml/atkhyperlink.xml">
  <!ENTITY atk-AtkHyperlinkImpl SYSTEM "xml/atkhyperlinkimpl.xml">
  <!ENTITY atk-AtkHypertext SYSTEM "xml/atkhypertext.xml">
  <!ENTITY atk-AtkImage SYSTEM "xml/atkimage.xml">
  <!ENTITY atk-AtkMisc SYSTEM "xml/atkmisc.xml">
  <!ENTITY atk-AtkNoOpObject SYSTEM "xml/atknoopobject.xml">
  <!ENTITY atk-AtkNoOpObjectFactory SYSTEM "xml/atknoopobjectfactory.xml">
  <!ENTITY atk-AtkPlug SYSTEM "xml/atkplug.xml">
  <!ENTITY atk-AtkObject SYSTEM "xml/atkobject.xml">
  <!ENTITY atk-AtkObjectFactory SYSTEM "xml/atkobjectfactory.xml">
  <!ENTITY atk-AtkRange SYSTEM "xml/atkrange.xml">
  <!ENTITY atk-AtkRegistry SYSTEM "xml/atkregistry.xml">
  <!ENTITY atk-AtkRelation SYSTEM "xml/atkrelation.xml">
  <!ENTITY atk-AtkRelationSet SYSTEM "xml/atkrelationset.xml">
  <!ENTITY atk-AtkSelection SYSTEM "xml/atkselection.xml">
  <!ENTITY atk-AtkSocket SYSTEM "xml/atksocket.xml">
  <!ENTITY atk-AtkState SYSTEM "xml/atkstate.xml">
  <!ENTITY atk-AtkStateSet SYSTEM "xml/atkstateset.xml">
  <!ENTITY atk-AtkStreamableContent SYSTEM "xml/atkstreamablecontent.xml">
  <!ENTITY atk-AtkTable SYSTEM "xml/atktable.xml">
  <!ENTITY atk-AtkTableCell SYSTEM "xml/atktablecell.xml">
  <!ENTITY atk-AtkText SYSTEM "xml/atktext.xml">
  <!ENTITY atk-AtkUtil SYSTEM "xml/atkutil.xml">
  <!ENTITY atk-AtkValue SYSTEM "xml/atkvalue.xml">
  <!ENTITY atk-AtkWindow SYSTEM "xml/atkwindow.xml">
  <!ENTITY atk-AtkVersion SYSTEM "xml/atkversion.xml">
  <!ENTITY version SYSTEM "version.xml">
]>

<book>
  <bookinfo>
    <title>ATK - Accessibility Toolkit</title>
    <releaseinfo>for ATK &version;</releaseinfo>
  </bookinfo>

  <chapter id="overview">
    <title>Overview</title>
     <para>
       GNOME provides support for accessibility devices using the ATK
       framework. This framework defines a set of interfaces to which
       graphical interface components adhere. This allows, for instance,
       screen readers to read the text of an interface and interact with its
       controls. ATK support is built into GTK+ and the rest of the GNOME
       platform, so any application using GTK+ will have reasonable
       accessibility support for free.
     </para>

     <para>
     Nonetheless, you should be aware of accessibility issues when when
     developing your applications. Although GTK+ interfaces provide
     reasonable accessibility by default, you can often improve how well
     your program behaves with accessibility tools by providing additional
     information to ATK. If you develop custom widgets, you should ensure
     that they expose their properties to ATK
     </para>

  </chapter>

  <chapter id="base-object">
    <title>Base accessibility object</title>
    &atk-AtkObject;
  </chapter>

  <chapter id="toolkit">
    <title>Event and toolkit support</title>
    &atk-AtkUtil;
  </chapter>

  <chapter id="interfaces">
    <title>ATK Interfaces</title>
    &atk-AtkAction;
    &atk-AtkComponent;
    &atk-AtkDocument;
    &atk-AtkEditabletext;
    &atk-AtkHyperlinkImpl;
    &atk-AtkHypertext;
    &atk-AtkImage;
    &atk-AtkSelection;
    &atk-AtkStreamableContent;
    &atk-AtkTable;
    &atk-AtkTableCell;
    &atk-AtkText;
    &atk-AtkValue;
    &atk-AtkWindow;
  </chapter>

  <chapter id="data">
    <title>Basic accessible data types</title>
    &atk-AtkRange;
    &atk-AtkRelation;
    &atk-AtkRelationSet;
    &atk-AtkState;
    &atk-AtkStateSet;
  </chapter>

  <chapter id="accessibles">
    <title>Custom accessible objects</title>
    &atk-AtkGObjectAccessible;
    &atk-AtkHyperlink;
    &atk-AtkNoOpObject;
    &atk-AtkPlug;
    &atk-AtkSocket;
  </chapter>

  <chapter id="utilities">
    <title>Utilities</title>
    &atk-AtkNoOpObjectFactory;
    &atk-AtkObjectFactory;
    &atk-AtkRegistry;
    &atk-AtkVersion;
  </chapter>

  <chapter id="deprecated">
    <title>Deprecated Interfaces</title>
    &atk-AtkMisc;
  </chapter>

  <index id="api-index-full">
    <title>Index of all symbols</title>
  </index>
  <index id="api-index-deprecated" role="deprecated">
    <title>Index of deprecated symbols</title>
  </index>
  <index id="api-index-1-3" role="1.3">
    <title>Index of new symbols in 1.3</title>
  </index>
  <index id="api-index-1-4" role="1.4">
    <title>Index of new symbols in 1.4</title>
  </index>
  <index id="api-index-1-6" role="1.6">
    <title>Index of new symbols in 1.6</title>
  </index>
  <index id="api-index-1-9" role="1.9">
    <title>Index of new symbols in 1.9</title>
  </index>
  <index id="api-index-1-12" role="1.12">
    <title>Index of new symbols in 1.12</title>
  </index>
  <index id="api-index-1-13" role="1.13">
    <title>Index of new symbols in 1.13</title>
  </index>
  <index id="api-index-1-20" role="1.20">
    <title>Index of new symbols in 1.20</title>
  </index>
  <index id="api-index-1-22" role="1.22">
    <title>Index of new symbols in 1.22</title>
  </index>
  <index id="api-index-1-30" role="1.30">
    <title>Index of new symbols in 1.30</title>
  </index>
  <index id="api-index-2-2" role="2.2">
    <title>Index of new symbols in 2.2</title>
  </index>
  <index id="api-index-2-8" role="2.8">
    <title>Index of new symbols in 2.8</title>
  </index>
  <index id="api-index-2-10" role="2.10">
    <title>Index of new symbols in 2.10</title>
  </index>
  <index id="api-index-2-12" role="2.12">
    <title>Index of new symbols in 2.12</title>
  </index>
</book>