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