1<!--***********************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 ***********************************************************-->
21<html><body bgcolor="#fffaf0">
22<h1>Help for the AWB v1.7</h1>
23
24<p>The AWB, or <em>A</em>ccessibility <em>W</em>ork <em>B</em>ench, is a tool
25for testing the implementation UNO Accessibility API.</p>
26
27<p>The main window is roughly divided into three areas:
28<ul>
29<li>The <a href="#treeview">tree view</a> on the left shows a part of the
30accessibility tree of one or more StarOffice/OpenOffice applications.</li>
31<li>The <a href="#graphicalview">graphical view</a> on the right side shows
32a graphical representation of the accessibility objects in the tree.  To
33make objects missing in the graphical view visible expand the corresponding
34nodes in the tree view.</li>
35
36<li>The text window at the bottom logs important messages.</li>
37</ul>
38</p>
39
40<h2><a name="treeview">Tree View</a></h2>
41<p>The tree view has a top-level node for every open
42  document window of StarOffice/OpenOffice.  Expand those nodes to make them
43  visible in the <a href="#graphicalview">graphical view</a>.</p>
44
45<h3>Nodes</h3>
46<p>The nodes in the tree view belong to different classes, some of which
47  have children others do not:
48<ul>
49<li><b>Accessible Object</b><br>
50  The node represents an accessible object and has corresponding shape in
51  the graphical view.  Only this kind of node gets highlighted by clicking
52  on those shapes.</li>
53<li><b>Simple Property</b><br>
54  These leaves represent simple properties of their parent nodes.  Examples
55  are the position, size, and color of an accessible object.</li>
56<li><b>Complex Properties</b><br>
57  These nodes have children that are not accessible objects.  Examples are
58  the lists of interfaces or services supported by an accessible object.</li>
59</ul>
60</p>
61
62<h3>Actions</h3>
63<p>The tree view supports the following actions:
64<ul><li>Left double click expands the node under the mouse pointer.</li>
65<li>Right click shows a context menu.  Entries, when supported, are:
66<ul>
67<li><b>Expand Shapes</b><br>
68Expands all nodes in the sub-tree that lie on a path from the root to a shape.</li>
69<li><b>Expand Subtree</b><br>
70Expands all nodes in the sub-tree.</li>
71<li><b>Select...</b><br>
72Show a dialog that gives access to the XAccessibleSelection interface.</li>
73<li><b>select...</b>, <b>copy...</b>, <b>cut...</b>, <b>paste...</b>,
74  <b>edit...</b>, <b>format...</b><br>
75Show dialogs that give access to the XAccessibleText and
76XAccessibleEditableText interfaces.
77</ul></li>
78</ul>
79</p>
80
81
82
83<h2><a name="graphicalview">Graphical View</a></h2>
84<p>The graphical view shows several properties of accessibility objects:
85<ul>
86<li>The bounding box is represented as a rectangle.</li>
87<li>The background color of the accessible object is taken to draw the
88  bounding box rectangle.</li>
89<li>The foreground color is used to fill the bounding box.</li>
90<li>The accessible name is shown when the menu checkbox Options->Show Name
91  is check.</li>
92<li>The accessible description is shown when the menu checkbox Options->Show
93  Descriptons is checked.</li>
94<li>If the XAccessibleText interface is supported and the menu checkbox
95  Options->Show Text is checked then the text of the accessible object is
96  shown.</li>
97</ul>
98</p>
99
100<h3>Actions</h3>
101<p>The graphical view supports three the following actions:
102<ul>
103<li>Left click (no modifiers) highlights the object under the mouse as well
104  as the corresponding node in the tree view.</li>
105<li>Left click with Control modifier expands the object under the
106  mouse.</li>
107<li>Mouse motion with Shift modifier highlights the object under the mouse
108  as well as the corresponding node in the tree view.</li>
109</ul>
110
111</body></html>
112