AccessibleRole.idl File Reference


Enumerations

enum  IA2Role {
  IA2_ROLE_UNKNOWN = 0,
  IA2_ROLE_CANVAS = 0x401,
  IA2_ROLE_CAPTION,
  IA2_ROLE_CHECK_MENU_ITEM,
  IA2_ROLE_COLOR_CHOOSER,
  IA2_ROLE_DATE_EDITOR,
  IA2_ROLE_DESKTOP_ICON,
  IA2_ROLE_DESKTOP_PANE,
  IA2_ROLE_DIRECTORY_PANE,
  IA2_ROLE_EDITBAR,
  IA2_ROLE_EMBEDDED_OBJECT,
  IA2_ROLE_ENDNOTE,
  IA2_ROLE_FILE_CHOOSER,
  IA2_ROLE_FONT_CHOOSER,
  IA2_ROLE_FOOTER,
  IA2_ROLE_FOOTNOTE,
  IA2_ROLE_FORM,
  IA2_ROLE_FRAME,
  IA2_ROLE_GLASS_PANE,
  IA2_ROLE_HEADER,
  IA2_ROLE_HEADING,
  IA2_ROLE_ICON,
  IA2_ROLE_IMAGE_MAP,
  IA2_ROLE_INPUT_METHOD_WINDOW,
  IA2_ROLE_INTERNAL_FRAME,
  IA2_ROLE_LABEL,
  IA2_ROLE_LAYERED_PANE,
  IA2_ROLE_NOTE,
  IA2_ROLE_OPTION_PANE,
  IA2_ROLE_PAGE,
  IA2_ROLE_PARAGRAPH,
  IA2_ROLE_RADIO_MENU_ITEM,
  IA2_ROLE_REDUNDANT_OBJECT,
  IA2_ROLE_ROOT_PANE,
  IA2_ROLE_RULER,
  IA2_ROLE_SCROLL_PANE,
  IA2_ROLE_SECTION,
  IA2_ROLE_SHAPE,
  IA2_ROLE_SPLIT_PANE,
  IA2_ROLE_TEAR_OFF_MENU,
  IA2_ROLE_TERMINAL,
  IA2_ROLE_TEXT_FRAME,
  IA2_ROLE_TOGGLE_BUTTON,
  IA2_ROLE_VIEW_PORT
}

Enumeration Type Documentation

enum IA2Role

Collection of roles

This enumerator defines an extended set of accessible roles of objects implementing the IAccessible2 interface. These roles are in addition to the MSAA roles obtained through the MSAA get_accRole method. Examples are 'footnote', 'heading', and 'label'. You obtain an object's IAccessible2 roles by calling IAccessible2::role.

Enumerator:
IA2_ROLE_UNKNOWN  Unknown role. The object contains some Accessible information, but its role is not known.
IA2_ROLE_CANVAS  An object that can be drawn into and to manage events from the objects drawn into it. Also refer to IA2_ROLE_FRAME, IA2_ROLE_GLASS_PANE, and IA2_ROLE_LAYERED_PANE.
IA2_ROLE_CAPTION  A caption describing another object.
IA2_ROLE_CHECK_MENU_ITEM  Used for check buttons that are menu items.
IA2_ROLE_COLOR_CHOOSER  A specialized dialog that lets the user choose a color.
IA2_ROLE_DATE_EDITOR  A date editor.
IA2_ROLE_DESKTOP_ICON  An iconified internal frame in an IA2_ROLE_DESKTOP_PANE. Also refer to IA2_ROLE_INTERNAL_FRAME.
IA2_ROLE_DESKTOP_PANE  A desktop pane. A pane that supports internal frames and iconified versions of those internal frames. Also refer to IA2_ROLE_INTERNAL_FRAME.
IA2_ROLE_DIRECTORY_PANE  A directory pane. A pane that allows the user to navigate through and select the contents of a directory. May be used by a file chooser. Also refer to IA2_ROLE_FILE_CHOOSER.
IA2_ROLE_EDITBAR  An editable text object in a toolbar.
Note: This role has been deprecated. The edit bar role was meant for a text area in a tool bar. However, to detect a text area in a tool bar the AT can query the parent.
IA2_ROLE_EMBEDDED_OBJECT  Embedded (OLE) object.
IA2_ROLE_ENDNOTE  Text that is used as an endnote (footnote at the end of a chapter or section).
IA2_ROLE_FILE_CHOOSER  A file chooser. A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename. May use the directory pane to show the contents of a directory. Also refer to IA2_ROLE_DIRECTORY_PANE.
IA2_ROLE_FONT_CHOOSER  A font chooser. A font chooser is a component that lets the user pick various attributes for fonts.
IA2_ROLE_FOOTER  Footer of a document page. Also refer to IA2_ROLE_HEADER.
IA2_ROLE_FOOTNOTE  Text that is used as a footnote. Also refer to IA2_ROLE_ENDNOTE.
IA2_ROLE_FORM  A container of form controls. An example of the use of this role is to represent an HTML FORM tag.
IA2_ROLE_FRAME  Frame role. A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application. Also refer to IA2_ROLE_CANVAS and the MSAA roles of dialog and window.
IA2_ROLE_GLASS_PANE  A glass pane. A pane that is guaranteed to be painted on top of all panes beneath it. Also refer to IA2_ROLE_CANVAS, IA2_ROLE_INTERNAL_FRAME, and IA2_ROLE_ROOT_PANE.
IA2_ROLE_HEADER  Header of a document page. Also refer to IA2_ROLE_FOOTER.
IA2_ROLE_HEADING  Heading. Use the IAccessible2::attributes heading-level attribute to determine the heading level.
IA2_ROLE_ICON  A small fixed size picture, typically used to decorate components.
IA2_ROLE_IMAGE_MAP  An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document.
IA2_ROLE_INPUT_METHOD_WINDOW  An object which is used to allow input of characters not found on a keyboard, such as the input of Chinese characters on a Western keyboard.
IA2_ROLE_INTERNAL_FRAME  An internal frame. A frame-like object that is clipped by a desktop pane. The desktop pane, internal frame, and desktop icon objects are often used to create multiple document interfaces within an application. Also refer to IA2_ROLE_DESKTOP_ICON, IA2_ROLE_DESKTOP_PANE, and IA2_ROLE_FRAME.
IA2_ROLE_LABEL  An object used to present an icon or short string in an interface.
IA2_ROLE_LAYERED_PANE  A layered pane. A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. This is usually the pane that holds the menu bar as well as the pane that contains most of the visual components in a window. Also refer to IA2_ROLE_CANVAS, IA2_ROLE_GLASS_PANE, and IA2_ROLE_ROOT_PANE.
IA2_ROLE_NOTE  An embedded note which is not visible until activated.
IA2_ROLE_OPTION_PANE  A specialized pane whose primary use is inside a dialog. Also refer to MSAA's dialog role.
IA2_ROLE_PAGE  An object representing a page of document content. It is used in documents which are accessed by the user on a page by page basis.
IA2_ROLE_PARAGRAPH  A paragraph of text.
IA2_ROLE_RADIO_MENU_ITEM  A radio button that is a menu item. Also refer to MSAA's button and menu item roles.
IA2_ROLE_REDUNDANT_OBJECT  An object which is redundant with another object in the accessible hierarchy. ATs typically ignore objects with this role.
IA2_ROLE_ROOT_PANE  A root pane. A specialized pane that has a glass pane and a layered pane as its children. Also refer to IA2_ROLE_GLASS_PANE and IA2_ROLE_LAYERED_PANE
IA2_ROLE_RULER  A ruler such as those used in word processors.
IA2_ROLE_SCROLL_PANE  A scroll pane. An object that allows a user to incrementally view a large amount of information. Its children can include scroll bars and a viewport. Also refer to IA2_ROLE_VIEW_PORT and MSAA's scroll bar role.
IA2_ROLE_SECTION  A container of document content. An example of the use of this role is to represent an HTML DIV tag. A section may be used as a region. A region is a group of elements that together form a perceivable unit. A region does not necessarily follow the logical structure of the content, but follows the perceivable structure of the page. A region may have an attribute in the set of IAccessible2::attributes which indicates that it is "live". A live region is content that is likely to change in response to a timed change, a user event, or some other programmed logic or event.
IA2_ROLE_SHAPE  Object with graphical representation used to represent content on draw pages.
IA2_ROLE_SPLIT_PANE  A split pane. A specialized panel that presents two other panels at the same time. Between the two panels is a divider the user can manipulate to make one panel larger and the other panel smaller.
IA2_ROLE_TEAR_OFF_MENU  An object that forms part of a menu system but which can be "undocked" from or "torn off" the menu system to exist as a separate window.
IA2_ROLE_TERMINAL  An object used as a terminal emulator.
IA2_ROLE_TEXT_FRAME  Collection of objects that constitute a logical text entity.
IA2_ROLE_TOGGLE_BUTTON  A toggle button. A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state. Also refer to MSAA's roles of push button, check box, and radio button.
Note: IA2_ROLE_TOGGLE_BUTTON should not be used. Instead, use MSAA's ROLE_SYSTEM_PUSHBUTTON and STATE_SYSTEM_PRESSED.
IA2_ROLE_VIEW_PORT  A viewport. An object usually used in a scroll pane. It represents the portion of the entire data that the user can see. As the user manipulates the scroll bars, the contents of the viewport can change. Also refer to IA2_ROLE_SCROLL_PANE.


To submit feedback on IAccessible2 API Version 1.2, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.2, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.2 can be found at: http://a11y.org/ia2-errata


Generated on Mon Jun 21 10:42:50 2010 for IAccessible2 API Version 1.2 by  doxygen 1.5.6