| /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 2003 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Original Author: Eric D Vaughan (evaughan@netscape.com) |
| * Contributor(s): Aaron Leventhal (aaronl@netscape.com) |
| * John Gaunt (jgaunt@netscape.com) |
| * Kyle Yuan (kyle.yuan@sun.com) |
| * HÃ¥kan Waara (hwaara@gmail.com) |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| #include "nsIArray.idl" |
| |
| interface nsIPersistentProperties; |
| interface nsIDOMDOMStringList; |
| interface nsIAccessibleRelation; |
| |
| /** |
| * A cross-platform interface that supports platform-specific |
| * accessibility APIs like MSAA and ATK. Contains the sum of what's needed |
| * to support IAccessible as well as ATK's generic accessibility objects. |
| * Can also be used by in-process accessibility clients to get information |
| * about objects in the accessible tree. The accessible tree is a subset of |
| * nodes in the DOM tree -- such as documents, focusable elements and text. |
| * Mozilla creates the implementations of nsIAccessible on demand. |
| * See http://www.mozilla.org/projects/ui/accessibility for more information. |
| * |
| * @status UNDER_REVIEW |
| */ |
| [scriptable, uuid(004b6882-2df1-49df-bb5f-0fb81a5b1edf)] |
| interface nsIAccessible : nsISupports |
| { |
| /** |
| * Parent node in accessible tree. |
| */ |
| readonly attribute nsIAccessible parent; |
| |
| /** |
| * Next sibling in accessible tree |
| */ |
| readonly attribute nsIAccessible nextSibling; |
| |
| /** |
| * Previous sibling in accessible tree |
| */ |
| readonly attribute nsIAccessible previousSibling; |
| |
| /** |
| * First child in accessible tree |
| */ |
| readonly attribute nsIAccessible firstChild; |
| |
| /** |
| * Last child in accessible tree |
| */ |
| readonly attribute nsIAccessible lastChild; |
| |
| /** |
| * Array of all this element's children. |
| */ |
| readonly attribute nsIArray children; |
| |
| /** |
| * Number of accessible children |
| */ |
| readonly attribute long childCount; |
| |
| /** |
| * The 0-based index of this accessible in its parent's list of children, |
| * or -1 if this accessible does not have a parent. |
| */ |
| readonly attribute long indexInParent; |
| |
| /** |
| * Accessible name -- the main text equivalent for this node |
| */ |
| attribute AString name; |
| |
| /** |
| * Accessible value -- a number or a secondary text equivalent for this node |
| * Widgets that use role attribute can force a value using the valuenow attribute |
| */ |
| readonly attribute AString value; |
| |
| /** |
| * Accessible description -- long text associated with this node |
| */ |
| readonly attribute AString description; |
| |
| /** |
| * Provides localized string of accesskey name, such as Alt+D. |
| * The modifier may be affected by user and platform preferences. |
| * Usually alt+letter, or just the letter alone for menu items. |
| */ |
| readonly attribute AString keyboardShortcut; |
| |
| /** |
| * Provides localized string of global keyboard accelerator for default |
| * action, such as Ctrl+O for Open file |
| */ |
| readonly attribute AString defaultKeyBinding; |
| |
| /** |
| * Provides array of localized string of global keyboard accelerator for |
| * the given action index supported by accessible. |
| * |
| * @param aActionIndex - index of the given action |
| */ |
| nsIDOMDOMStringList getKeyBindings(in PRUint8 aActionIndex); |
| |
| /** |
| * Natural enumerated accessible role for the associated element. |
| * The values depend on platform because of variations. |
| * See the ROLE_* constants defined in nsIAccessibleRole. |
| * This does not take into account role attribute as the finalRole does. |
| */ |
| readonly attribute unsigned long role; |
| |
| /** |
| * Enumerated accessible role. The values depend on platform because of variations. |
| * See the ROLE_* constants defined in nsIAccessibleRole. |
| * Widgets can use role attribute to force the final role |
| */ |
| readonly attribute unsigned long finalRole; |
| |
| /** |
| * Accessible states -- bit fields which describe boolean properties of node. |
| * Many states are only valid given a certain role attribute that supports |
| * them. |
| * |
| * @param aState - the first bit field (see nsIAccessibleStates::STATE_* |
| * constants) |
| * @param aExtraState - the second bit field |
| * (see nsIAccessibleStates::EXT_STATE_* constants) |
| */ |
| void getFinalState(out unsigned long aState, out unsigned long aExtraState); |
| |
| /** |
| * Help text associated with node |
| */ |
| readonly attribute AString help; |
| |
| /** |
| * Focused accessible child of node |
| */ |
| readonly attribute nsIAccessible focusedChild; |
| |
| /** |
| * Attributes of accessible |
| */ |
| readonly attribute nsIPersistentProperties attributes; |
| |
| /** |
| * Returns grouping information. Used for tree items, list items, tab panel |
| * labels, radio buttons, etc. Also used for collectons of non-text objects. |
| * |
| * @param groupLevel - 1-based, similar to ARIA 'level' property |
| * @param similarItemsInGroup - 1-based, similar to ARIA 'setsize' property, |
| * inclusive of the current item |
| * @param positionInGroup - 1-based, similar to ARIA 'posinset' property |
| */ |
| void groupPosition(out long aGroupLevel, out long aSimilarItemsInGroup, |
| out long aPositionInGroup); |
| |
| /** |
| * Accessible child which contains the coordinate at (x, y) in screen pixels. |
| * If the point is in the current accessible but not in a child, the |
| * current accessible will be returned. |
| * If the point is in neither the current accessible or a child, then |
| * null will be returned. |
| */ |
| nsIAccessible getChildAtPoint(in long x, in long y); |
| |
| /** |
| * Nth accessible child using zero-based index or last child if index less than zero |
| */ |
| nsIAccessible getChildAt(in long aChildIndex); |
| |
| /** |
| * Accessible node geometrically to the right of this one |
| */ |
| nsIAccessible getAccessibleToRight(); |
| |
| /** |
| * Accessible node geometrically to the left of this one |
| */ |
| nsIAccessible getAccessibleToLeft(); |
| |
| /** |
| * Accessible node geometrically above this one |
| */ |
| nsIAccessible getAccessibleAbove(); |
| |
| /** |
| * Accessible node geometrically below this one |
| */ |
| nsIAccessible getAccessibleBelow(); |
| |
| /** |
| * Return accessible related to this one by the given relation type (see. |
| * constants defined in nsIAccessibleRelation). |
| */ |
| nsIAccessible getAccessibleRelated(in unsigned long aRelationType); |
| |
| /** |
| * Returns the number of accessible relations for this object. |
| */ |
| readonly attribute unsigned long relationsCount; |
| |
| /** |
| * Returns one accessible relation for this object. |
| * |
| * @param index - relation index (0-based) |
| */ |
| nsIAccessibleRelation getRelation(in unsigned long index); |
| |
| /** |
| * Returns multiple accessible relations for this object. |
| */ |
| nsIArray getRelations(); |
| |
| /** |
| * Return accessible's x and y coordinates relative to the screen and |
| * accessible's width and height. |
| */ |
| void getBounds(out long x, out long y, out long width, out long height); |
| |
| /** |
| * Add or remove this accessible to the current selection |
| */ |
| void setSelected(in boolean isSelected); |
| |
| /** |
| * Extend the current selection from its current accessible anchor node |
| * to this accessible |
| */ |
| void extendSelection(); |
| |
| /** |
| * Select this accessible node only |
| */ |
| void takeSelection(); |
| |
| /** |
| * Focus this accessible node, |
| * The state STATE_FOCUSABLE indicates whether this node is normally focusable. |
| * It is the callers responsibility to determine whether this node is focusable. |
| * accTakeFocus on a node that is not normally focusable (such as a table), |
| * will still set focus on that node, although normally that will not be visually |
| * indicated in most style sheets. |
| */ |
| void takeFocus(); |
| |
| /** |
| * The number of accessible actions associated with this accessible |
| */ |
| readonly attribute PRUint8 numActions; |
| |
| /** |
| * The name of the accessible action at the given zero-based index |
| */ |
| AString getActionName(in PRUint8 index); |
| |
| /** |
| * The description of the accessible action at the given zero-based index |
| */ |
| AString getActionDescription(in PRUint8 aIndex); |
| |
| /** |
| * Perform the accessible action at the given zero-based index |
| * Action number 0 is the default action |
| */ |
| void doAction(in PRUint8 index); |
| |
| /** |
| * Get a pointer to accessibility interface for this node, which is specific |
| * to the OS/accessibility toolkit we're running on. |
| */ |
| [noscript] void getNativeInterface(out voidPtr aOutAccessible); |
| }; |
| |