accessible/public/nsIAccessible.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Original Author: Eric D Vaughan (evaughan@netscape.com)
  23  * Contributor(s): Aaron Leventhal (aaronl@netscape.com)
  24  *                 John Gaunt (jgaunt@netscape.com)
  25  *                 Kyle Yuan (kyle.yuan@sun.com)
  26  *                 Håkan Waara (hwaara@gmail.com)
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * either the GNU General Public License Version 2 or later (the "GPL"), or
  30  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31  * in which case the provisions of the GPL or the LGPL are applicable instead
  32  * of those above. If you wish to allow use of your version of this file only
  33  * under the terms of either the GPL or the LGPL, and not to allow others to
  34  * use your version of this file under the terms of the MPL, indicate your
  35  * decision by deleting the provisions above and replace them with the notice
  36  * and other provisions required by the GPL or the LGPL. If you do not delete
  37  * the provisions above, a recipient may use your version of this file under
  38  * the terms of any one of the MPL, the GPL or the LGPL.
  39  *
  40  * ***** END LICENSE BLOCK ***** */
  41
  42 #include "nsISupports.idl"
  43 #include "nsIArray.idl"
  44
  45 interface nsIPersistentProperties;
  46 interface nsIDOMDOMStringList;
  47 interface nsIAccessibleRelation;
  48
  49 /**
  50  * A cross-platform interface that supports platform-specific
  51  * accessibility APIs like MSAA and ATK. Contains the sum of what's needed
  52  * to support IAccessible as well as ATK's generic accessibility objects.
  53  * Can also be used by in-process accessibility clients to get information
  54  * about objects in the accessible tree. The accessible tree is a subset of
  55  * nodes in the DOM tree -- such as documents, focusable elements and text.
  56  * Mozilla creates the implementations of nsIAccessible on demand.
  57  * See http://www.mozilla.org/projects/ui/accessibility for more information.
  58  *
  59  * @status UNDER_REVIEW
  60  */
  61 [scriptable, uuid(c7520419-87ec-42bc-98cc-04c0bf173530)]
  62 interface nsIAccessible : nsISupports
  63 {
  64   /**
  65    * Parent node in accessible tree.
  66    */
  67   readonly attribute nsIAccessible parent;
  68
  69   /**
  70    * Next sibling in accessible tree
  71    */
  72   readonly attribute nsIAccessible nextSibling;
  73
  74   /**
  75    * Previous sibling in accessible tree
  76    */
  77   readonly attribute nsIAccessible previousSibling;
  78
  79   /**
  80    * First child in accessible tree
  81    */
  82   readonly attribute nsIAccessible firstChild;
  83
  84   /**
  85    * Last child in accessible tree
  86    */
  87   readonly attribute nsIAccessible lastChild;
  88
  89   /**
  90    * Array of all this element's children.
  91    */
  92   readonly attribute nsIArray children;
  93
  94   /**
  95    * Number of accessible children
  96    */
  97   readonly attribute long childCount;
  98
  99   /**
 100    * The 0-based index of this accessible in its parent's list of children,
 101    * or -1 if this accessible does not have a parent.
 102    */
 103   readonly attribute long indexInParent;
 104
 105   /**
 106    * Accessible name -- the main text equivalent for this node
 107    */
 108   attribute AString name;
 109
 110   /**
 111    * Accessible value -- a number or a secondary text equivalent for this node
 112    * Widgets that use role attribute can force a value using the valuenow attribute
 113    */
 114   readonly attribute AString value;
 115
 116   /**
 117    * Accessible description -- long text associated with this node
 118    */
 119   readonly attribute AString description;
 120
 121   /**
 122    * Provides localized string of accesskey name, such as Alt+D.
 123    * The modifier may be affected by user and platform preferences.
 124    * Usually alt+letter, or just the letter alone for menu items.
 125    */
 126   readonly attribute AString keyboardShortcut;
 127
 128   /**
 129    * Provides localized string of global keyboard accelerator for default
 130    * action, such as Ctrl+O for Open file
 131    */
 132   readonly attribute AString defaultKeyBinding;
 133
 134   /**
 135    * Provides array of localized string of global keyboard accelerator for
 136    * the given action index supported by accessible.
 137    *
 138    * @param aActionIndex - index of the given action
 139    */
 140   nsIDOMDOMStringList getKeyBindings(in PRUint8 aActionIndex);
 141
 142   /**
 143    * Natural enumerated accessible role for the associated element.
 144    * The values depend on platform because of variations.
 145    * See the ROLE_* constants defined in nsIAccessibleRole.
 146    * This does not take into account role attribute as the finalRole does.
 147    */
 148   readonly attribute unsigned long role;
 149
 150   /**
 151    * Enumerated accessible role. The values depend on platform because of variations.
 152    * See the ROLE_* constants defined in nsIAccessibleRole.
 153    * Widgets can use role attribute to force the final role
 154    */
 155   readonly attribute unsigned long finalRole;
 156
 157   /**
 158    * Accessible states -- bit fields which describe boolean properties of node.
 159    * Many states are only valid given a certain role attribute that supports
 160    * them.
 161    *
 162    * @param aState - the first bit field (see nsIAccessibleStates::STATE_*
 163    *                 constants)
 164    * @param aExtraState - the second bit field
 165    *                      (see nsIAccessibleStates::EXT_STATE_* constants)
 166    */
 167   void getFinalState(out unsigned long aState, out unsigned long aExtraState);
 168
 169   /**
 170    * Help text associated with node
 171    */
 172   readonly attribute AString help;
 173
 174   /**
 175    * Focused accessible child of node
 176    */
 177   readonly attribute nsIAccessible focusedChild;
 178
 179   /**
 180    * Attributes of accessible
 181    */
 182   readonly attribute nsIPersistentProperties attributes;
 183
 184   /**
 185    * Returns grouping information. Used for tree items, list items, tab panel
 186    * labels, radio buttons, etc. Also used for collectons of non-text objects.
 187    *
 188    * @param groupLevel - 1-based, similar to ARIA 'level' property
 189    * @param similarItemsInGroup - 1-based, similar to ARIA 'setsize' property,
 190    *                              inclusive of the current item
 191    * @param positionInGroup - 1-based, similar to ARIA 'posinset' property
 192    */
 193   void groupPosition(out long aGroupLevel, out long aSimilarItemsInGroup,
 194                      out long aPositionInGroup);
 195
 196   /**
 197    * Accessible child which contains the coordinate at (x, y) in screen pixels.
 198    * If the point is in the current accessible but not in a child, the
 199    * current accessible will be returned.
 200    * If the point is in neither the current accessible or a child, then
 201    * null will be returned.
 202    *
 203    * @param x  screen's x coordinate
 204    * @param y  screen's y coordinate
 205    * @return   the deepest accessible child containing the given point
 206    */
 207   nsIAccessible getChildAtPoint(in long x, in long y);
 208
 209   /**
 210    * Deepest accessible child which contains the coordinate at (x, y) in screen
 211    * pixels. If the point is in the current accessible but not in a child, the
 212    * current accessible will be returned. If the point is in neither the current
 213    * accessible or a child, then null will be returned.
 214    *
 215    * @param x  screen's x coordinate
 216    * @param y  screen's y coordinate
 217    * @return   the deepest accessible child containing the given point
 218    */
 219   nsIAccessible getDeepestChildAtPoint(in long x, in long y);
 220
 221   /**
 222    * Nth accessible child using zero-based index or last child if index less than zero
 223    */
 224   nsIAccessible getChildAt(in long aChildIndex);
 225
 226   /**
 227    * Accessible node geometrically to the right of this one
 228    */
 229   nsIAccessible getAccessibleToRight();
 230
 231   /**
 232    * Accessible node geometrically to the left of this one
 233    */
 234   nsIAccessible getAccessibleToLeft();
 235
 236   /**
 237    * Accessible node geometrically above this one
 238    */
 239   nsIAccessible getAccessibleAbove();
 240
 241   /**
 242    * Accessible node geometrically below this one
 243    */
 244   nsIAccessible getAccessibleBelow();
 245
 246   /**
 247    * Return accessible related to this one by the given relation type (see.
 248    * constants defined in nsIAccessibleRelation).
 249    */
 250   nsIAccessible getAccessibleRelated(in unsigned long aRelationType);
 251
 252   /**
 253    * Returns the number of accessible relations for this object.
 254    */
 255   readonly attribute unsigned long relationsCount;
 256
 257   /**
 258    * Returns one accessible relation for this object.
 259    *
 260    * @param index - relation index (0-based)
 261    */
 262   nsIAccessibleRelation getRelation(in unsigned long index);
 263
 264   /**
 265    * Returns multiple accessible relations for this object.
 266    */
 267   nsIArray getRelations();
 268
 269   /**
 270    * Return accessible's x and y coordinates relative to the screen and
 271    * accessible's width and height.
 272    */
 273   void getBounds(out long x, out long y, out long width, out long height);
 274
 275   /**
 276    * Add or remove this accessible to the current selection
 277    */
 278   void setSelected(in boolean isSelected);
 279
 280   /**
 281    * Extend the current selection from its current accessible anchor node
 282    * to this accessible
 283    */
 284   void extendSelection();
 285
 286   /**
 287    * Select this accessible node only
 288    */
 289   void takeSelection();
 290
 291   /**
 292    * Focus this accessible node,
 293    * The state STATE_FOCUSABLE indicates whether this node is normally focusable.
 294    * It is the callers responsibility to determine whether this node is focusable.
 295    * accTakeFocus on a node that is not normally focusable (such as a table),
 296    * will still set focus on that node, although normally that will not be visually
 297    * indicated in most style sheets.
 298    */
 299   void takeFocus();
 300
 301   /**
 302    * The number of accessible actions associated with this accessible
 303    */
 304   readonly attribute PRUint8 numActions;
 305
 306   /**
 307    * The name of the accessible action at the given zero-based index
 308    */
 309   AString getActionName(in PRUint8 index);
 310
 311   /**
 312    * The description of the accessible action at the given zero-based index
 313    */
 314   AString getActionDescription(in PRUint8 aIndex);
 315
 316   /**
 317    * Perform the accessible action at the given zero-based index
 318    * Action number 0 is the default action
 319    */
 320   void doAction(in PRUint8 index);
 321
 322   /**
 323    * Get a pointer to accessibility interface for this node, which is specific
 324    * to the OS/accessibility toolkit we're running on.
 325    */
 326   [noscript] void getNativeInterface(out voidPtr aOutAccessible);
 327 };
 328