toolkit/test/accessibility/help.html

   1 <html><body bgcolor="#fffaf0">
   2 <h1>Help for the AWB v1.7</h1>
   3
   4 <p>The AWB, or <em>A</em>ccessibility <em>W</em>ork <em>B</em>ench, is a tool
   5 for testing the implementation UNO Accessibility API.</p>
   6
   7 <p>The main window is roughly divided into three areas:
   8 <ul>
   9 <li>The <a href="#treeview">tree view</a> on the left shows a part of the
  10 accessibility tree of one or more StarOffice/OpenOffice applications.</li>
  11 <li>The <a href="#graphicalview">graphical view</a> on the right side shows
  12 a graphical representation of the accessibility objects in the tree.  To
  13 make objects missing in the graphical view visible expand the corresponding
  14 nodes in the tree view.</li>
  15
  16 <li>The text window at the bottom logs important messages.</li>
  17 </ul>
  18 </p>
  19
  20 <h2><a name="treeview">Tree View</a></h2>
  21 <p>The tree view has a top-level node for every open
  22   document window of StarOffice/OpenOffice.  Expand those nodes to make them
  23   visible in the <a href="#graphicalview">graphical view</a>.</p>
  24
  25 <h3>Nodes</h3>
  26 <p>The nodes in the tree view belong to different classes, some of which
  27   have children others do not:
  28 <ul>
  29 <li><b>Accessible Object</b><br>
  30   The node represents an accessible object and has corresponding shape in
  31   the graphical view.  Only this kind of node gets highlighted by clicking
  32   on those shapes.</li>
  33 <li><b>Simple Property</b><br>
  34   These leaves represent simple properties of their parent nodes.  Examples
  35   are the position, size, and color of an accessible object.</li>
  36 <li><b>Complex Properties</b><br>
  37   These nodes have children that are not accessible objects.  Examples are
  38   the lists of interfaces or services supported by an accessible object.</li>
  39 </ul>
  40 </p>
  41
  42 <h3>Actions</h3>
  43 <p>The tree view supports the following actions:
  44 <ul><li>Left double click expands the node under the mouse pointer.</li>
  45 <li>Right click shows a context menu.  Entries, when supported, are:
  46 <ul>
  47 <li><b>Expand Shapes</b><br>
  48 Expands all nodes in the sub-tree that lie on a path from the root to a shape.</li>
  49 <li><b>Expand Subtree</b><br>
  50 Expands all nodes in the sub-tree.</li>
  51 <li><b>Select...</b><br>
  52 Show a dialog that gives access to the XAccessibleSelection interface.</li>
  53 <li><b>select...</b>, <b>copy...</b>, <b>cut...</b>, <b>paste...</b>,
  54   <b>edit...</b>, <b>format...</b><br>
  55 Show dialogs that give access to the XAccessibleText and
  56 XAccessibleEditableText interfaces.
  57 </ul></li>
  58 </ul>
  59 </p>
  60
  61
  62
  63 <h2><a name="graphicalview">Graphical View</a></h2>
  64 <p>The graphical view shows several properties of accessibility objects:
  65 <ul>
  66 <li>The bounding box is represented as a rectangle.</li>
  67 <li>The background color of the accessible object is taken to draw the
  68   bounding box rectangle.</li>
  69 <li>The foreground color is used to fill the bounding box.</li>
  70 <li>The accessible name is shown when the menu checkbox Options->Show Name
  71   is check.</li>
  72 <li>The accessible description is shown when the menu checkbox Options->Show
  73   Descriptions is checked.</li>
  74 <li>If the XAccessibleText interface is supported and the menu checkbox
  75   Options->Show Text is checked then the text of the accessible object is
  76   shown.</li>
  77 </ul>
  78 </p>
  79
  80 <h3>Actions</h3>
  81 <p>The graphical view supports three the following actions:
  82 <ul>
  83 <li>Left click (no modifiers) highlights the object under the mouse as well
  84   as the corresponding node in the tree view.</li>
  85 <li>Left click with Control modifier expands the object under the
  86   mouse.</li>
  87 <li>Mouse motion with Shift modifier highlights the object under the mouse
  88   as well as the corresponding node in the tree view.</li>
  89 </ul>
  90
  91 </body></html>