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