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