Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions | Public Attributes
nsIAccessible Interface Reference

A cross-platform interface that supports platform-specific accessibility APIs like MSAA and ATK. More...

import "nsIAccessible.idl";

Inheritance diagram for nsIAccessible:
Inheritance graph
[legend]
Collaboration diagram for nsIAccessible:
Collaboration graph
[legend]

List of all members.

Public Types

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_RADIO_MENU_ITEM = 12U }
enum  { ROLE_CHECK_MENU_ITEM = 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_TREE_TABLE = 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 }
enum  { ROLE_ICON = ROLE_NOTHING }
enum  { ROLE_PASSWORD_TEXT = ROLE_TEXT }
enum  { ROLE_AUTOCOMPLETE = ROLE_COMBOBOX }
enum  { ROLE_EDITBAR = ROLE_NOTHING }
enum  { ROLE_EMBEDDED = ROLE_NOTHING }
enum  { ROLE_ENTRY = ROLE_NOTHING }
enum  { ROLE_CAPTION = ROLE_NOTHING }
enum  { ROLE_DOCUMENT_FRAME = ROLE_NOTHING }
enum  { ROLE_HEADING = ROLE_NOTHING }
enum  { ROLE_PAGE = ROLE_NOTHING }
enum  { ROLE_SECTION = ROLE_NOTHING }
enum  { ROLE_REDUNDANT_OBJECT = ROLE_NOTHING }
enum  { NAVRELATION_CONTROLLED_BY = 0x1000 }
enum  { NAVRELATION_CONTROLLER_FOR = 0x1001 }
enum  { NAVRELATION_LABEL_FOR = 0x1002 }
enum  { NAVRELATION_LABELLED_BY = 0x1003 }
enum  { NAVRELATION_MEMBER_OF = 0x1004 }
enum  { NAVRELATION_NODE_CHILD_OF = 0x1005 }
enum  { NAVRELATION_FLOWS_TO = 0x1006 }
enum  { NAVRELATION_FLOWS_FROM = 0x1007 }
enum  { NAVRELATION_SUBWINDOW_OF = 0x1008 }
enum  { NAVRELATION_EMBEDS = 0x1009 }
enum  { NAVRELATION_EMBEDDED_BY = 0x100a }
enum  { NAVRELATION_POPUP_FOR = 0x100b }
enum  { NAVRELATION_PARENT_WINDOW_OF = 0x100c }
enum  { NAVRELATION_DEFAULT_BUTTON = 0x100d }
enum  { NAVRELATION_DESCRIBED_BY = 0x100e }
enum  { NAVRELATION_DESCRIPTION_FOR = 0x100f }

Public Member Functions

nsIAccessible getChildAtPoint (in long x, in long y)
 Accessible child which contains the coordinate at x,y.
nsIAccessible getChildAt (in long aChildIndex)
 Nth accessible child using zero-based index or last child if index less than zero.
nsIAccessible getAccessibleToRight ()
 Accessible node geometrically to the right of this one.
nsIAccessible getAccessibleToLeft ()
 Accessible node geometrically to the left of this one.
nsIAccessible getAccessibleAbove ()
 Accessible node geometrically above this one.
nsIAccessible getAccessibleBelow ()
 Accessible node geometrically below this one.
nsIAccessible getAccessibleRelated (in unsigned long aRelationType)
 Accessible node related to this one.
void getBounds (out long x, out long y, out long width, out long height)
void addSelection ()
 Add this accessible to the current selection.
void removeSelection ()
 Remove this accessible from the current selection.
void extendSelection ()
 Extend the current selection from its current accessible anchor node to this accessible.
void takeSelection ()
 Select this accessible node only.
void takeFocus ()
 Focus this accessible node, The state STATE_FOCUSABLE indicates whether this node is normally focusable.
AString getActionName (in PRUint8 index)
 The name of the accessible action at the given zero-based index.
void doAction (in PRUint8 index)
 Perform the accessible action at the given zero-based index Action number 0 is the default action.
void getNativeInterface (out voidPtr aOutAccessible)
 Get a pointer to accessibility interface for this node, which is specific to the OS/accessibility toolkit we're running on.

Public Attributes

readonly attribute nsIAccessible parent
 Parent node in accessible tree.
readonly attribute nsIAccessible nextSibling
 Next sibling in accessible tree.
readonly attribute nsIAccessible previousSibling
 Previous sibling in accessible tree.
readonly attribute nsIAccessible firstChild
 First child in accessible tree.
readonly attribute nsIAccessible lastChild
 Last child in accessible tree.
readonly attribute long childCount
 Number of accessible children.
readonly attribute long indexInParent
 The 0-based index of this accessible in its parent's list of children, or -1 if this accessible does not have a parent.
attribute AString name
 Accessible name -- the main text equivalent for this node.
readonly attribute AString finalValue
 Accessible value -- a number or a secondary text equivalent for this node Widgets that use a role attribute can force a value using the valuenow attribute.
readonly attribute AString description
 Accessible description -- long text associated with this node.
readonly attribute AString keyboardShortcut
 Provides localized string of accesskey name, such as Alt+D.
readonly attribute AString keyBinding
 Provides localized string of global keyboard accelerator, such as Ctrl+O for Open file.
readonly attribute unsigned long role
 Natural enumerated accessible role for the associated element.
readonly attribute unsigned long finalRole
 Enumerated accessible role.
readonly attribute unsigned long finalState
 Accessible states -- bit field which describes boolean properties of node.
readonly attribute unsigned long extState
 Extended accessible states -- second bit field describing node.
readonly attribute AString help
 Help text associated with node.
readonly attribute nsIAccessible focusedChild
 Focused accessible child of node.
readonly attribute PRUint8 numActions
 The number of accessible actions associated with this accessible.
const unsigned long STATE_UNAVAILABLE = 0x00000001
 MSAA State flags - used for bitfield.
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
const unsigned long STATE_READONLY = 0x00000040
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
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
const unsigned long STATE_EXTSELECTABLE = 0x02000000
const unsigned long STATE_ALERT_LOW = 0x04000000
const unsigned long STATE_ALERT_MEDIUM = 0x08000000
const unsigned long STATE_ALERT_HIGH = 0x10000000
const unsigned long STATE_PROTECTED = 0x20000000
const unsigned long STATE_HASPOPUP = 0x40000000
const unsigned long STATE_REQUIRED = STATE_ALERT_LOW
const unsigned long STATE_IMPORTANT = STATE_ALERT_MEDIUM
const unsigned long STATE_INVALID = STATE_ALERT_HIGH
const unsigned long STATE_CHECKABLE = STATE_MARQUEED
const unsigned long EXT_STATE_EDITABLE = 0x00200000
 Extended state flags (for now non-MSAA, for Java and Gnome/ATK support) "Extended state flags" has seperate value space from "MSAA State flags".
const unsigned long EXT_STATE_ACTIVE = 0x00400000
const unsigned long EXT_STATE_EXPANDABLE = 0x00800000
const unsigned long EXT_STATE_MODAL = 0x01000000
const unsigned long EXT_STATE_MULTI_LINE = 0x02000000
const unsigned long EXT_STATE_SENSITIVE = 0x04000000
const unsigned long EXT_STATE_SHOWING = 0x10000000
const unsigned long EXT_STATE_SINGLE_LINE = 0x20000000
const unsigned long EXT_STATE_TRANSIENT = 0x40000000
const unsigned long EXT_STATE_VERTICAL = 0x80000000
const unsigned long RELATION_NUL = 0x00
 Relation Types -- most of these come from ATK's atkrelationtype.h RELATION_NULL: RELATION_CONTROLLED_BY: Controlled by one or more target objects.
const unsigned long RELATION_CONTROLLED_BY = 0x01
const unsigned long RELATION_CONTROLLER_FOR = 0x02
const unsigned long RELATION_LABEL_FOR = 0x03
const unsigned long RELATION_LABELLED_BY = 0x04
const unsigned long RELATION_MEMBER_OF = 0x05
const unsigned long RELATION_NODE_CHILD_OF = 0x06
const unsigned long RELATION_FLOWS_TO = 0x07
const unsigned long RELATION_FLOWS_FROM = 0x08
const unsigned long RELATION_SUBWINDOW_OF = 0x09
const unsigned long RELATION_EMBEDS = 0x0a
const unsigned long RELATION_EMBEDDED_BY = 0x0b
const unsigned long RELATION_POPUP_FOR = 0x0c
const unsigned long RELATION_PARENT_WINDOW_OF = 0x0d
const unsigned long RELATION_DEFAULT_BUTTON = 0x4000
const unsigned long RELATION_DESCRIBED_BY = 0x4001
const unsigned long RELATION_DESCRIPTION_FOR = 0x4002

Detailed Description

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.

UNDER_REVIEW

Definition at line 56 of file nsIAccessible.idl.


Member Enumeration Documentation

anonymous enum
Enumerator:
ROLE_TITLEBAR 

Definition at line 539 of file nsIAccessible.idl.

{ ROLE_TITLEBAR = 1U };
anonymous enum
Enumerator:
ROLE_MENUBAR 

Definition at line 540 of file nsIAccessible.idl.

{ ROLE_MENUBAR = 2U };
anonymous enum
Enumerator:
ROLE_MENUPOPUP 

Definition at line 549 of file nsIAccessible.idl.

{ ROLE_MENUPOPUP = 11U };
anonymous enum
Enumerator:
ROLE_MENUITEM 

Definition at line 550 of file nsIAccessible.idl.

{ ROLE_MENUITEM = 12U };
anonymous enum
Enumerator:
ROLE_RADIO_MENU_ITEM 

Definition at line 551 of file nsIAccessible.idl.

{ ROLE_RADIO_MENU_ITEM = 12U }; // Same as ROLE_MENUITEM
anonymous enum
Enumerator:
ROLE_CHECK_MENU_ITEM 

Definition at line 552 of file nsIAccessible.idl.

{ ROLE_CHECK_MENU_ITEM = 12U }; // Same as ROLE_MENUITEM
anonymous enum
Enumerator:
ROLE_TOOLTIP 

Definition at line 553 of file nsIAccessible.idl.

{ ROLE_TOOLTIP = 13U };
anonymous enum
Enumerator:
ROLE_APPLICATION 

Definition at line 554 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_DOCUMENT 

Definition at line 555 of file nsIAccessible.idl.

{ ROLE_DOCUMENT = 15U };
anonymous enum
Enumerator:
ROLE_PANE 

Definition at line 556 of file nsIAccessible.idl.

{ ROLE_PANE = 16U };
anonymous enum
Enumerator:
ROLE_CHART 

Definition at line 557 of file nsIAccessible.idl.

{ ROLE_CHART = 17U };
anonymous enum
Enumerator:
ROLE_DIALOG 

Definition at line 558 of file nsIAccessible.idl.

{ ROLE_DIALOG = 18U };
anonymous enum
Enumerator:
ROLE_SCROLLBAR 

Definition at line 541 of file nsIAccessible.idl.

{ ROLE_SCROLLBAR = 3U };
anonymous enum
Enumerator:
ROLE_BORDER 

Definition at line 559 of file nsIAccessible.idl.

{ ROLE_BORDER = 19U };
anonymous enum
Enumerator:
ROLE_GROUPING 

Definition at line 560 of file nsIAccessible.idl.

{ ROLE_GROUPING = 20U };
anonymous enum
Enumerator:
ROLE_SEPARATOR 

Definition at line 561 of file nsIAccessible.idl.

{ ROLE_SEPARATOR = 21U };
anonymous enum
Enumerator:
ROLE_TOOLBAR 

Definition at line 562 of file nsIAccessible.idl.

{ ROLE_TOOLBAR = 22U };
anonymous enum
Enumerator:
ROLE_STATUSBAR 

Definition at line 563 of file nsIAccessible.idl.

{ ROLE_STATUSBAR = 23U };
anonymous enum
Enumerator:
ROLE_TABLE 

Definition at line 564 of file nsIAccessible.idl.

{ ROLE_TABLE = 24U };
anonymous enum
Enumerator:
ROLE_COLUMNHEADER 

Definition at line 565 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_ROWHEADER 

Definition at line 566 of file nsIAccessible.idl.

{ ROLE_ROWHEADER = 26U };
anonymous enum
Enumerator:
ROLE_COLUMN 

Definition at line 567 of file nsIAccessible.idl.

{ ROLE_COLUMN = 27U };
anonymous enum
Enumerator:
ROLE_ROW 

Definition at line 568 of file nsIAccessible.idl.

{ ROLE_ROW = 28U };
anonymous enum
Enumerator:
ROLE_GRIP 

Definition at line 542 of file nsIAccessible.idl.

{ ROLE_GRIP = 4U };
anonymous enum
Enumerator:
ROLE_CELL 

Definition at line 569 of file nsIAccessible.idl.

{ ROLE_CELL = 29U };
anonymous enum
Enumerator:
ROLE_LINK 

Definition at line 570 of file nsIAccessible.idl.

{ ROLE_LINK = 30U };
anonymous enum
Enumerator:
ROLE_HELPBALLOON 

Definition at line 571 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_CHARACTER 

Definition at line 572 of file nsIAccessible.idl.

{ ROLE_CHARACTER = 32U };
anonymous enum
Enumerator:
ROLE_LIST 

Definition at line 573 of file nsIAccessible.idl.

{ ROLE_LIST = 33U };
anonymous enum
Enumerator:
ROLE_LISTITEM 

Definition at line 574 of file nsIAccessible.idl.

{ ROLE_LISTITEM = 34U };
anonymous enum
Enumerator:
ROLE_OUTLINE 

Definition at line 575 of file nsIAccessible.idl.

{ ROLE_OUTLINE = 35U };
anonymous enum
Enumerator:
ROLE_TREE_TABLE 

Definition at line 576 of file nsIAccessible.idl.

{ ROLE_TREE_TABLE = 35U }; // Same as ROLE_OUTLINE
anonymous enum
Enumerator:
ROLE_OUTLINEITEM 

Definition at line 577 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_PAGETAB 

Definition at line 578 of file nsIAccessible.idl.

{ ROLE_PAGETAB = 37U };
anonymous enum
Enumerator:
ROLE_SOUND 

Definition at line 543 of file nsIAccessible.idl.

{ ROLE_SOUND = 5U };
anonymous enum
Enumerator:
ROLE_PROPERTYPAGE 

Definition at line 579 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_INDICATOR 

Definition at line 580 of file nsIAccessible.idl.

{ ROLE_INDICATOR = 39U };
anonymous enum
Enumerator:
ROLE_GRAPHIC 

Definition at line 581 of file nsIAccessible.idl.

{ ROLE_GRAPHIC = 40U };
anonymous enum
Enumerator:
ROLE_STATICTEXT 

Definition at line 582 of file nsIAccessible.idl.

{ ROLE_STATICTEXT = 41U };
anonymous enum
Enumerator:
ROLE_TEXT 

Definition at line 583 of file nsIAccessible.idl.

{ ROLE_TEXT = 42U };
anonymous enum
Enumerator:
ROLE_PUSHBUTTON 

Definition at line 584 of file nsIAccessible.idl.

{ ROLE_PUSHBUTTON = 43U };
anonymous enum
Enumerator:
ROLE_CHECKBUTTON 

Definition at line 585 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_RADIOBUTTON 

Definition at line 586 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_COMBOBOX 

Definition at line 587 of file nsIAccessible.idl.

{ ROLE_COMBOBOX = 46U };
anonymous enum
Enumerator:
ROLE_DROPLIST 

Definition at line 588 of file nsIAccessible.idl.

{ ROLE_DROPLIST = 47U };
anonymous enum
Enumerator:
ROLE_CURSOR 

Definition at line 544 of file nsIAccessible.idl.

{ ROLE_CURSOR = 6U };
anonymous enum
Enumerator:
ROLE_PROGRESSBAR 

Definition at line 589 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_DIAL 

Definition at line 590 of file nsIAccessible.idl.

{ ROLE_DIAL = 49U };
anonymous enum
Enumerator:
ROLE_HOTKEYFIELD 

Definition at line 591 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_SLIDER 

Definition at line 592 of file nsIAccessible.idl.

{ ROLE_SLIDER = 51U };
anonymous enum
Enumerator:
ROLE_SPINBUTTON 

Definition at line 593 of file nsIAccessible.idl.

{ ROLE_SPINBUTTON = 52U };
anonymous enum
Enumerator:
ROLE_DIAGRAM 

Definition at line 594 of file nsIAccessible.idl.

{ ROLE_DIAGRAM = 53U };
anonymous enum
Enumerator:
ROLE_ANIMATION 

Definition at line 595 of file nsIAccessible.idl.

{ ROLE_ANIMATION = 54U };
anonymous enum
Enumerator:
ROLE_EQUATION 

Definition at line 596 of file nsIAccessible.idl.

{ ROLE_EQUATION = 55U };
anonymous enum
Enumerator:
ROLE_BUTTONDROPDOWN 

Definition at line 597 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_BUTTONMENU 

Definition at line 598 of file nsIAccessible.idl.

{ ROLE_BUTTONMENU = 57U };
anonymous enum
Enumerator:
ROLE_CARET 

Definition at line 545 of file nsIAccessible.idl.

{ ROLE_CARET = 7U };
anonymous enum
Enumerator:
ROLE_BUTTONDROPDOWNGRID 

Definition at line 599 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_WHITESPACE 

Definition at line 600 of file nsIAccessible.idl.

{ ROLE_WHITESPACE = 59U };
anonymous enum
Enumerator:
ROLE_PAGETABLIST 

Definition at line 601 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_CLOCK 

Definition at line 602 of file nsIAccessible.idl.

{ ROLE_CLOCK = 61U };
anonymous enum
Enumerator:
ROLE_SPLITBUTTON 

Definition at line 603 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_IPADDRESS 

Definition at line 604 of file nsIAccessible.idl.

{ ROLE_IPADDRESS = 63U };
anonymous enum
Enumerator:
ROLE_NOTHING 

Definition at line 605 of file nsIAccessible.idl.

{ ROLE_NOTHING = 4294967295U };
anonymous enum
Enumerator:
ROLE_ICON 

Definition at line 609 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_PASSWORD_TEXT 

Definition at line 610 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_AUTOCOMPLETE 

Definition at line 611 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_ALERT 

Definition at line 546 of file nsIAccessible.idl.

{ ROLE_ALERT = 8U };
anonymous enum
Enumerator:
ROLE_EDITBAR 

Definition at line 612 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_EMBEDDED 

Definition at line 613 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_ENTRY 

Definition at line 614 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_CAPTION 

Definition at line 615 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_DOCUMENT_FRAME 

Definition at line 616 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_HEADING 

Definition at line 617 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_PAGE 

Definition at line 618 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_SECTION 

Definition at line 619 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_REDUNDANT_OBJECT 

Definition at line 620 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_CONTROLLED_BY 

Definition at line 623 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_WINDOW 

Definition at line 547 of file nsIAccessible.idl.

{ ROLE_WINDOW = 9U };
anonymous enum
Enumerator:
NAVRELATION_CONTROLLER_FOR 

Definition at line 624 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_LABEL_FOR 

Definition at line 625 of file nsIAccessible.idl.

{ NAVRELATION_LABEL_FOR = 0x1002 };
anonymous enum
Enumerator:
NAVRELATION_LABELLED_BY 

Definition at line 626 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_MEMBER_OF 

Definition at line 627 of file nsIAccessible.idl.

{ NAVRELATION_MEMBER_OF = 0x1004 };
anonymous enum
Enumerator:
NAVRELATION_NODE_CHILD_OF 

Definition at line 628 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_FLOWS_TO 

Definition at line 629 of file nsIAccessible.idl.

{ NAVRELATION_FLOWS_TO = 0x1006 };
anonymous enum
Enumerator:
NAVRELATION_FLOWS_FROM 

Definition at line 630 of file nsIAccessible.idl.

{ NAVRELATION_FLOWS_FROM = 0x1007 };
anonymous enum
Enumerator:
NAVRELATION_SUBWINDOW_OF 

Definition at line 631 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_EMBEDS 

Definition at line 632 of file nsIAccessible.idl.

{ NAVRELATION_EMBEDS = 0x1009 };
anonymous enum
Enumerator:
NAVRELATION_EMBEDDED_BY 

Definition at line 633 of file nsIAccessible.idl.

anonymous enum
Enumerator:
ROLE_CLIENT 

Definition at line 548 of file nsIAccessible.idl.

{ ROLE_CLIENT = 10U };
anonymous enum
Enumerator:
NAVRELATION_POPUP_FOR 

Definition at line 634 of file nsIAccessible.idl.

{ NAVRELATION_POPUP_FOR = 0x100b };
anonymous enum
Enumerator:
NAVRELATION_PARENT_WINDOW_OF 

Definition at line 635 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_DEFAULT_BUTTON 

Definition at line 636 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_DESCRIBED_BY 

Definition at line 637 of file nsIAccessible.idl.

anonymous enum
Enumerator:
NAVRELATION_DESCRIPTION_FOR 

Definition at line 638 of file nsIAccessible.idl.


Member Function Documentation

Add this accessible to the current selection.

Perform the accessible action at the given zero-based index Action number 0 is the default action.

Extend the current selection from its current accessible anchor node to this accessible.

Accessible node geometrically above this one.

Accessible node geometrically below this one.

Accessible node related to this one.

Accessible node geometrically to the left of this one.

Accessible node geometrically to the right of this one.

The name of the accessible action at the given zero-based index.

void nsIAccessible::getBounds ( out long  x,
out long  y,
out long  width,
out long  height 
)

Nth accessible child using zero-based index or last child if index less than zero.

Accessible child which contains the coordinate at x,y.

void nsIAccessible::getNativeInterface ( out voidPtr  aOutAccessible)

Get a pointer to accessibility interface for this node, which is specific to the OS/accessibility toolkit we're running on.

Remove this accessible from the current selection.

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.

Select this accessible node only.


Member Data Documentation

Number of accessible children.

Definition at line 86 of file nsIAccessible.idl.

Accessible description -- long text associated with this node.

Definition at line 108 of file nsIAccessible.idl.

Definition at line 301 of file nsIAccessible.idl.

Extended state flags (for now non-MSAA, for Java and Gnome/ATK support) "Extended state flags" has seperate value space from "MSAA State flags".

Definition at line 300 of file nsIAccessible.idl.

Definition at line 302 of file nsIAccessible.idl.

const unsigned long nsIAccessible::EXT_STATE_MODAL = 0x01000000

Definition at line 303 of file nsIAccessible.idl.

Definition at line 304 of file nsIAccessible.idl.

Definition at line 305 of file nsIAccessible.idl.

Definition at line 306 of file nsIAccessible.idl.

Definition at line 307 of file nsIAccessible.idl.

Definition at line 308 of file nsIAccessible.idl.

Definition at line 309 of file nsIAccessible.idl.

Extended accessible states -- second bit field describing node.

Definition at line 148 of file nsIAccessible.idl.

Enumerated accessible role.

The values depend on platform because of variations. See the ROLE_* constants defined later in this file. Widgets can use role attribute to force the final role

Definition at line 136 of file nsIAccessible.idl.

Accessible states -- bit field which describes boolean properties of node.

See the STATE_* constants defined later in this file. Many states are only valid given a certain role attribute that supports them

Definition at line 143 of file nsIAccessible.idl.

Accessible value -- a number or a secondary text equivalent for this node Widgets that use a role attribute can force a value using the valuenow attribute.

Definition at line 103 of file nsIAccessible.idl.

First child in accessible tree.

Definition at line 76 of file nsIAccessible.idl.

Focused accessible child of node.

Definition at line 158 of file nsIAccessible.idl.

readonly attribute AString nsIAccessible::help

Help text associated with node.

Definition at line 153 of file nsIAccessible.idl.

The 0-based index of this accessible in its parent's list of children, or -1 if this accessible does not have a parent.

Definition at line 92 of file nsIAccessible.idl.

Provides localized string of global keyboard accelerator, such as Ctrl+O for Open file.

Definition at line 121 of file nsIAccessible.idl.

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.

Definition at line 115 of file nsIAccessible.idl.

Last child in accessible tree.

Definition at line 81 of file nsIAccessible.idl.

Accessible name -- the main text equivalent for this node.

Definition at line 97 of file nsIAccessible.idl.

Next sibling in accessible tree.

Definition at line 66 of file nsIAccessible.idl.

The number of accessible actions associated with this accessible.

Definition at line 234 of file nsIAccessible.idl.

Parent node in accessible tree.

Definition at line 61 of file nsIAccessible.idl.

Previous sibling in accessible tree.

Definition at line 71 of file nsIAccessible.idl.

Definition at line 340 of file nsIAccessible.idl.

Definition at line 341 of file nsIAccessible.idl.

Definition at line 353 of file nsIAccessible.idl.

Definition at line 354 of file nsIAccessible.idl.

Definition at line 355 of file nsIAccessible.idl.

Definition at line 350 of file nsIAccessible.idl.

Definition at line 349 of file nsIAccessible.idl.

Definition at line 347 of file nsIAccessible.idl.

Definition at line 346 of file nsIAccessible.idl.

Definition at line 342 of file nsIAccessible.idl.

Definition at line 343 of file nsIAccessible.idl.

Definition at line 344 of file nsIAccessible.idl.

Definition at line 345 of file nsIAccessible.idl.

Relation Types -- most of these come from ATK's atkrelationtype.h RELATION_NULL: RELATION_CONTROLLED_BY: Controlled by one or more target objects.

RELATION_CONTROLLER_FOR: Controller for one or more target objects. RELATION_LABEL_FOR: Label for one or more target objects. RELATION_LABELLED_BY: Labelled by one or more target objects. RELATION_MEMBER_OF: Member of a group of one or more target objects. RELATION_NODE_CHILD_OF: Cell in a treetable which is displayed because a cell in the same col is expanded & identifies it. RELATION_FLOWS_TO: Has content that flows logically to another object in a sequential way, e.g. text flow. RELATION_FLOWS_FROM: Has content that flows logically from another object in a sequential way, e.g. text flow. RELATION_SUBWINDOW_OF: Subwindow attached to a component but otherwise not connected in the UI hierarchy to that component. RELATION_EMBEDS: Visually embeds another object's content, i.e. this object's content flows around another's content. RELATION_EMBEDDED_BY: Inverse of RELATION_EMBEDS; this object's content is visually embedded in another object. RELATION_POPUP_FOR: Popup for another object. RELATION_PARENT_WINDOW_OF: Parent window of another object. RELATION_DEFAULT_BUTTON: Part of a form/dialog with a related default button. RELATION_DESCRIBED_BY: Described by one or more target objects. RELATION_DESCRIPTION_FOR: Description for one or more target objects. RELATION_LAST_DEFINED:

Definition at line 339 of file nsIAccessible.idl.

Definition at line 352 of file nsIAccessible.idl.

Definition at line 351 of file nsIAccessible.idl.

Definition at line 348 of file nsIAccessible.idl.

readonly attribute unsigned long nsIAccessible::role

Natural enumerated accessible role for the associated element.

The values depend on platform because of variations. See the ROLE_* constants defined later in this file. This does not take into account role attribute as the finalRole does.

Definition at line 129 of file nsIAccessible.idl.

Definition at line 284 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_ALERT_LOW = 0x04000000

Definition at line 282 of file nsIAccessible.idl.

Definition at line 283 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_ANIMATED = 0x00004000

Definition at line 270 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_BUSY = 0x00000800

Definition at line 267 of file nsIAccessible.idl.

Definition at line 294 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_CHECKED = 0x00000010

Definition at line 260 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_COLLAPSED = 0x00000400

Definition at line 266 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_DEFAULT = 0x00000100

Definition at line 264 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_EXPANDED = 0x00000200

Definition at line 265 of file nsIAccessible.idl.

Definition at line 281 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_FLOATING = 0x00001000

Definition at line 268 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_FOCUSABLE = 0x00100000

Definition at line 276 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_FOCUSED = 0x00000004

Definition at line 258 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_HASPOPUP = 0x40000000

Definition at line 286 of file nsIAccessible.idl.

Definition at line 263 of file nsIAccessible.idl.

Definition at line 292 of file nsIAccessible.idl.

Definition at line 293 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_INVISIBLE = 0x00008000

Definition at line 271 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_LINKED = 0x00400000

Definition at line 278 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_MARQUEED = 0x00002000

Definition at line 269 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_MIXED = 0x00000020

Definition at line 261 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_MOVEABLE = 0x00040000

Definition at line 274 of file nsIAccessible.idl.

Definition at line 280 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_OFFSCREEN = 0x00010000

Definition at line 272 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_PRESSED = 0x00000008

Definition at line 259 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_PROTECTED = 0x20000000

Definition at line 285 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_READONLY = 0x00000040

Definition at line 262 of file nsIAccessible.idl.

Definition at line 291 of file nsIAccessible.idl.

Definition at line 277 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_SELECTED = 0x00000002

Definition at line 257 of file nsIAccessible.idl.

Definition at line 275 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_SIZEABLE = 0x00020000

Definition at line 273 of file nsIAccessible.idl.

const unsigned long nsIAccessible::STATE_TRAVERSED = 0x00800000

Definition at line 279 of file nsIAccessible.idl.

MSAA State flags - used for bitfield.

More than 1 allowed.

Definition at line 256 of file nsIAccessible.idl.


The documentation for this interface was generated from the following file: