/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- * * 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 the Mozilla browser. * * The Initial Developer of the Original Code is Netscape * Communications Corporation. Portions created by Netscape are * Copyright (C) 1999 Netscape Communications Corporation. All * Rights Reserved. * * Original Author: Eric D Vaughan (evaughan@netscape.com) * * Contributor(s): * Aaron Leventhal * John Gaunt */ #include "nsISupports.idl" #include "nsIDOMNode.idl" #include "domstubs.idl" [scriptable, uuid(B26FBE47-9A5F-42a1-822B-082461AE4D6D)] interface nsIAccessible : nsISupports { readonly attribute nsIAccessible accParent; readonly attribute nsIAccessible accNextSibling; readonly attribute nsIAccessible accPreviousSibling; readonly attribute nsIAccessible accFirstChild; readonly attribute nsIAccessible accLastChild; readonly attribute long accChildCount; attribute AString accName; readonly attribute AString accValue; readonly attribute long accId; readonly attribute AString accDescription; readonly attribute AString accKeyboardShortcut; readonly attribute unsigned long accRole; readonly attribute unsigned long accState; readonly attribute unsigned long accExtState; readonly attribute AString accHelp; readonly attribute nsIAccessible accFocused; nsIAccessible accGetAt(in long x, in long y); nsIAccessible accNavigateRight(); nsIAccessible accNavigateLeft(); nsIAccessible accNavigateUp(); nsIAccessible accNavigateDown(); void accGetBounds(out long x, out long y, out long width, out long height); void accAddSelection(); void accRemoveSelection(); void accExtendSelection(); void accTakeSelection(); void accTakeFocus(); readonly attribute PRUint8 accNumActions; AString getAccActionName(in PRUint8 index); void accDoAction(in PRUint8 index); // Action number 0 is the default action nsIDOMNode accGetDOMNode(); // Used by Accessible implementation to save data and speed up accessibility tree walking [noscript] void CacheOptimizations(in nsIAccessible aParent, in PRInt32 aSiblingIndex, in nsIDOMNodeList aSiblingList); // MSAA State flags - used for bitfield. More than 1 allowed. const unsigned long STATE_UNAVAILABLE = 0x00000001; // Disabled, maps to opposite of Java ENABLED, Gnome/ATK SENSITIVE? const unsigned long STATE_SELECTED = 0x00000002; const unsigned long STATE_FOCUSED = 0x00000004; const unsigned long STATE_PRESSED = 0x00000008; const unsigned long STATE_CHECKED = 0x00000010; const unsigned long STATE_MIXED = 0x00000020; // 3-state checkbox or toolbar button const unsigned long STATE_READONLY = 0x00000040; // Maps to opposite of Java/Gnome/ATK EDITABLE state const unsigned long STATE_HOTTRACKED = 0x00000080; const unsigned long STATE_DEFAULT = 0x00000100; const unsigned long STATE_EXPANDED = 0x00000200; const unsigned long STATE_COLLAPSED = 0x00000400; const unsigned long STATE_BUSY = 0x00000800; const unsigned long STATE_FLOATING = 0x00001000; // Children "owned" not "contained" by parent const unsigned long STATE_MARQUEED = 0x00002000; const unsigned long STATE_ANIMATED = 0x00004000; const unsigned long STATE_INVISIBLE = 0x00008000; const unsigned long STATE_OFFSCREEN = 0x00010000; const unsigned long STATE_SIZEABLE = 0x00020000; const unsigned long STATE_MOVEABLE = 0x00040000; const unsigned long STATE_SELFVOICING = 0x00080000; const unsigned long STATE_FOCUSABLE = 0x00100000; const unsigned long STATE_SELECTABLE = 0x00200000; const unsigned long STATE_LINKED = 0x00400000; const unsigned long STATE_TRAVERSED = 0x00800000; const unsigned long STATE_MULTISELECTABLE = 0x01000000; // Supports multiple selection const unsigned long STATE_EXTSELECTABLE = 0x02000000; // Supports extended selection const unsigned long STATE_ALERT_LOW = 0x04000000; // This information is of low priority const unsigned long STATE_ALERT_MEDIUM = 0x08000000; // This information is of medium priority const unsigned long STATE_ALERT_HIGH = 0x10000000; // This information is of high priority const unsigned long STATE_PROTECTED = 0x20000000; // Maps to Gnome's *Role* ATK_ROLE_PASSWD_TEXT, nothing for Java? const unsigned long STATE_HASPOPUP = 0x40000000; // New in MSAA 2.0 // Extended state flags (for now non-MSAA, for Java and Gnome/ATK support) // This is only the states that there isn't already a mapping for in MSAA // See www.accessmozilla.org/article.php?sid=11 for information on the mappings between accessibility API states const unsigned long STATE_INVALID = 0x00200000; // No explanation given const unsigned long STATE_ACTIVE = 0x00400000; // This window is currently the active window const unsigned long STATE_EXPANDABLE = 0x00800000; // An item that can be expanded, such as a tree item with children const unsigned long STATE_MODAL = 0x01000000; // Must do something with control before leaving it const unsigned long STATE_MULTI_LINE = 0x02000000; // Edit control that can take multiple lines const unsigned long STATE_SENSITIVE = 0x04000000; // No explanation given const unsigned long STATE_RESIZABLE = 0x08000000; // Object can be resized const unsigned long STATE_SHOWING = 0x10000000; // This object and all of it's ancestors are visible const unsigned long STATE_SINGLE_LINE = 0x20000000; // This text object can only contain 1 line of text const unsigned long STATE_TRANSIENT = 0x40000000; // Tells accessibility aid "Don't add event listener - this object doesn't generate any". For example, could be used with higher level containers. const unsigned long STATE_VERTICAL = 0x80000000; // Especially used for sliders and scrollbars %{C++ #ifdef MOZ_ACCESSIBILITY_ATK /******************************************************************************* The following nsIAccessible roles are traslated to ATK_ROLE_UNKNOWN ROLE_TITLEBAR, ROLE_SOUND, ROLE_CURSOR, ROLE_CARET, ROLE_BORDER, ROLE_GROUPING, ROLE_EQUATION, ROLE_COLUMN, ROLE_ROW, ROLE_LINK, ROLE_WHITESPACE, ROLE_CLOCK, ROLE_IPADDRESS ROLE_GRIP The object represents a special mouse pointer, which allows a user to manipulate user interface elements such as windows. ROLE_HELPBALLOON The object displays a Help topic in the form of a ToolTip or Help balloon. ROLE_PROPERTYPAGE The object represents a property sheet. ROLE_INDICATOR The object represents an indicator, such as a pointer graphic pointing to the currrent item. ROLE_HOTKEYFIELD The object represents a hot-key field that allow the user to enter a sequence of keystroke. The following ATK roles have no corresponding nsIAccessible roles. Perhaps there are not these types of widget/control in Mozilla, so don't need these ATK roles? Or need add some of them? ATK_ROLE_ARROW An arrow in one of the four cardinal directions. ATK_ROLE_INTERNAL_FRAME A frame-like object that is clipped by a desktop pane. ATK_ROLE_ACCEL_LABEL, ATK_ROLE_CANVAS, ATK_ROLE_CHECK_MENU_ITEM, ATK_ROLE_COLOR_CHOOSER, ATK_ROLE_DATE_EDITOR, ATK_ROLE_DESKTOP_ICON, ATK_ROLE_DESKTOP_FRAME, ATK_ROLE_DIRECTORY_PANE, ATK_ROLE_FILE_CHOOSER, ATK_ROLE_FILLER, ATK_ROLE_FONT_CHOOSER, ATK_ROLE_GLASS_PANE, ATK_ROLE_HTML_CONTAINER, ATK_ROLE_ICON, ATK_ROLE_LAYERED_PANE, ATK_ROLE_POPUP_MENU, ATK_ROLE_OPTION_PANE, ATK_ROLE_PASSWORD_TEXT, ATK_ROLE_RADIO_MENU_ITEM, ATK_ROLE_ROOT_PANE, ATK_ROLE_SCROLL_PANE, ATK_ROLE_SPLIT_PANE, ATK_ROLE_TEAR_OFF_MENU_ITEM, ATK_ROLE_TERMINAL, ATK_ROLE_TOGGLE_BUTTON, ATK_ROLE_TREE_TABLE, ATK_ROLE_VIEWPORT, ATK_ROLE_LABEL Important: Following value should keep synchronization with the definitions in atk.h *******************************************************************************/ enum { ROLE_TITLEBAR = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_MENUBAR = 33U }; // ATK_ROLE_MENU_BAR enum { ROLE_SCROLLBAR = 47U }; // ATK_ROLE_SCROLL_BAR enum { ROLE_GRIP = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_SOUND = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_CURSOR = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_CARET = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_ALERT = 2U }; // ATK_ROLE_ALERT enum { ROLE_WINDOW = 68U }; // ATK_ROLE_WINDOW // An object used for drawing custom user interface elements enum { ROLE_CLIENT = 18U }; // ATK_ROLE_DRAWING_AREA enum { ROLE_MENUPOPUP = 32U }; // ATK_ROLE_MENU enum { ROLE_MENUITEM = 34U }; // ATK_ROLE_MENU_ITEM enum { ROLE_TOOLTIP = 63U }; // ATK_ROLE_TOOL_TIP // The object represents a main window for a application enum { ROLE_APPLICATION = 22U }; // ATK_ROLE_FRAME // The object represents a document window, only for MDI windows enum { ROLE_DOCUMENT = 68U }; // ATK_ROLE_WINDOW enum { ROLE_PANE = 38U }; // ATK_ROLE_PANEL enum { ROLE_CHART = 26U }; // ATK_ROLE_IMAGE enum { ROLE_DIALOG = 16U }; // ATK_ROLE_DIALOG enum { ROLE_BORDER = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_GROUPING = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_SEPARATOR = 49U }; // ATK_ROLE_SEPARATOR enum { ROLE_TOOLBAR = 62U }; // ATK_ROLE_TOOL_BAR enum { ROLE_STATUSBAR = 53U }; // ATK_ROLE_STATUSBAR enum { ROLE_TABLE = 54U }; // ATK_ROLE_TABLE // Or ATK_ROLE_TABLE_COLUMN_HEADER? enum { ROLE_COLUMNHEADER = 10U };// ATK_ROLE_COLUMN_HEADER // Or ATK_ROLE_TABLE_ROW_HEADER ? enum { ROLE_ROWHEADER = 46U }; // ATK_ROLE_ROW_HEADER enum { ROLE_COLUMN = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_ROW = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_CELL = 55U }; // ATK_ROLE_TABLE_CELL enum { ROLE_LINK = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_HELPBALLOON = 66U }; // ATK_ROLE_UNKNOWN // The object represents a cartoon-like graphic object enum { ROLE_CHARACTER = 26U }; // ATK_ROLE_IMAGE enum { ROLE_LIST = 30U }; // ATK_ROLE_LIST enum { ROLE_LISTITEM = 31U }; // ATK_ROLE_LIST_ITEM // The object represents an outline or tree structure enum { ROLE_OUTLINE = 64U }; // ATK_ROLE_TREE // The object represents an item in an outline or tree structure enum { ROLE_OUTLINEITEM = 31U }; // ATK_ROLE_LIST_ITEM enum { ROLE_PAGETAB = 36U }; // ATK_ROLE_PAGE_TAB enum { ROLE_PROPERTYPAGE = 66U };// ATK_ROLE_UNKNOWN enum { ROLE_INDICATOR = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_GRAPHIC = 26U }; // ATK_ROLE_IMAGE // Read-only text, can't be modified or selected enum { ROLE_STATICTEXT = 60U }; // ATK_ROLE_TEXT enum { ROLE_TEXT = 60U }; // ATK_ROLE_TEXT enum { ROLE_PUSHBUTTON = 42U }; // ATK_ROLE_PUSH_BUTTON enum { ROLE_CHECKBUTTON = 7U }; // ATK_ROLE_CHECK_BOX enum { ROLE_RADIOBUTTON = 43U }; // ATK_ROLE_RADIO_BUTTON enum { ROLE_COMBOBOX = 11U }; // ATK_ROLE_COMBO_BOX // Just represents the calender control enum { ROLE_DROPLIST = 5U }; // ATK_ROLE_CALENDAR enum { ROLE_PROGRESSBAR = 41U }; // ATK_ROLE_PROGRESS_BAR enum { ROLE_DIAL = 15U }; // ATK_ROLE_DIAL enum { ROLE_HOTKEYFIELD = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_SLIDER = 50U }; // ATK_ROLE_SLIDER enum { ROLE_SPINBUTTON = 52U }; // ATK_ROLE_SPIN_BUTTON enum { ROLE_DIAGRAM = 26U }; // ATK_ROLE_IMAGE enum { ROLE_ANIMATION = 3U }; // ATK_ROLE_ANIMATION enum { ROLE_EQUATION = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_BUTTONDROPDOWN = 42U }; // ATK_ROLE_PUSH_BUTTON enum { ROLE_BUTTONMENU = 42U }; // ATK_ROLE_PUSH_BUTTON // Represents a button that drops down a grid enum { ROLE_BUTTONDROPDOWNGRID = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_WHITESPACE = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_PAGETABLIST = 37U }; // ATK_ROLE_PAGE_TAB_LIST enum { ROLE_CLOCK = 66U }; // ATK_ROLE_UNKNOWN // Represents a button on the toolbar that has a drop-down list icon // directly adjacent to the button enum { ROLE_SPLITBUTTON = 42U }; // ATK_ROLE_PUSH_BUTTON enum { ROLE_IPADDRESS = 66U }; // ATK_ROLE_UNKNOWN enum { ROLE_NOTHING = 0U }; // ATK_ROLE_INVALID #else // MSAA Roles - only one per nsIAccessible or IAccessible enum { ROLE_TITLEBAR = 1U }; enum { ROLE_MENUBAR = 2U }; enum { ROLE_SCROLLBAR = 3U }; enum { ROLE_GRIP = 4U }; enum { ROLE_SOUND = 5U }; enum { ROLE_CURSOR = 6U }; enum { ROLE_CARET = 7U }; enum { ROLE_ALERT = 8U }; enum { ROLE_WINDOW = 9U }; enum { ROLE_CLIENT = 10U }; enum { ROLE_MENUPOPUP = 11U }; enum { ROLE_MENUITEM = 12U }; enum { ROLE_TOOLTIP = 13U }; enum { ROLE_APPLICATION = 14U }; enum { ROLE_DOCUMENT = 15U }; enum { ROLE_PANE = 16U }; enum { ROLE_CHART = 17U }; enum { ROLE_DIALOG = 18U }; enum { ROLE_BORDER = 19U }; enum { ROLE_GROUPING = 20U }; enum { ROLE_SEPARATOR = 21U }; enum { ROLE_TOOLBAR = 22U }; enum { ROLE_STATUSBAR = 23U }; enum { ROLE_TABLE = 24U }; enum { ROLE_COLUMNHEADER = 25U }; enum { ROLE_ROWHEADER = 26U }; enum { ROLE_COLUMN = 27U }; enum { ROLE_ROW = 28U }; enum { ROLE_CELL = 29U }; enum { ROLE_LINK = 30U }; enum { ROLE_HELPBALLOON = 31U }; enum { ROLE_CHARACTER = 32U }; enum { ROLE_LIST = 33U }; enum { ROLE_LISTITEM = 34U }; enum { ROLE_OUTLINE = 35U }; enum { ROLE_OUTLINEITEM = 36U }; enum { ROLE_PAGETAB = 37U }; enum { ROLE_PROPERTYPAGE = 38U }; enum { ROLE_INDICATOR = 39U }; enum { ROLE_GRAPHIC = 40U }; enum { ROLE_STATICTEXT = 41U }; enum { ROLE_TEXT = 42U }; enum { ROLE_PUSHBUTTON = 43U }; enum { ROLE_CHECKBUTTON = 44U }; enum { ROLE_RADIOBUTTON = 45U }; enum { ROLE_COMBOBOX = 46U }; enum { ROLE_DROPLIST = 47U }; enum { ROLE_PROGRESSBAR = 48U }; enum { ROLE_DIAL = 49U }; enum { ROLE_HOTKEYFIELD = 50U }; enum { ROLE_SLIDER = 51U }; enum { ROLE_SPINBUTTON = 52U }; enum { ROLE_DIAGRAM = 53U }; enum { ROLE_ANIMATION = 54U }; enum { ROLE_EQUATION = 55U }; enum { ROLE_BUTTONDROPDOWN = 56U }; enum { ROLE_BUTTONMENU = 57U }; enum { ROLE_BUTTONDROPDOWNGRID = 58U }; enum { ROLE_WHITESPACE = 59U }; enum { ROLE_PAGETABLIST = 60U }; enum { ROLE_CLOCK = 61U }; enum { ROLE_SPLITBUTTON = 62U }; enum { ROLE_IPADDRESS = 63U }; enum { ROLE_NOTHING = 4294967295U }; #endif %} };