atkobject.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

<listitem><simpara> A text object uses for passwords, or other places where the text content is not shown visibly to the user
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-POPUP-MENU:CAPS" role="constant">
<term><literal>ATK_ROLE_POPUP_MENU</literal></term>
<listitem><simpara> A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PROGRESS-BAR:CAPS" role="constant">
<term><literal>ATK_ROLE_PROGRESS_BAR</literal></term>
<listitem><simpara> An object used to indicate how much of a task has been completed
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PUSH-BUTTON:CAPS" role="constant">
<term><literal>ATK_ROLE_PUSH_BUTTON</literal></term>
<listitem><simpara> An object the user can manipulate to tell the application to do something
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-RADIO-BUTTON:CAPS" role="constant">
<term><literal>ATK_ROLE_RADIO_BUTTON</literal></term>
<listitem><simpara> A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-RADIO-MENU-ITEM:CAPS" role="constant">
<term><literal>ATK_ROLE_RADIO_MENU_ITEM</literal></term>
<listitem><simpara> A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ROOT-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_ROOT_PANE</literal></term>
<listitem><simpara> A specialized pane that has a glass pane and a layered pane as its children
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ROW-HEADER:CAPS" role="constant">
<term><literal>ATK_ROLE_ROW_HEADER</literal></term>
<listitem><simpara> The header for a row of data
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SCROLL-BAR:CAPS" role="constant">
<term><literal>ATK_ROLE_SCROLL_BAR</literal></term>
<listitem><simpara> An object usually used to allow a user to incrementally view a large amount of data.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SCROLL-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_SCROLL_PANE</literal></term>
<listitem><simpara> An object that allows a user to incrementally view a large amount of information
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SEPARATOR:CAPS" role="constant">
<term><literal>ATK_ROLE_SEPARATOR</literal></term>
<listitem><simpara> An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SLIDER:CAPS" role="constant">
<term><literal>ATK_ROLE_SLIDER</literal></term>
<listitem><simpara> An object that allows the user to select from a bounded range
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SPLIT-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_SPLIT_PANE</literal></term>
<listitem><simpara> A specialized panel that presents two other panels at the same time
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SPIN-BUTTON:CAPS" role="constant">
<term><literal>ATK_ROLE_SPIN_BUTTON</literal></term>
<listitem><simpara> An object used to get an integer or floating point number from the user
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-STATUSBAR:CAPS" role="constant">
<term><literal>ATK_ROLE_STATUSBAR</literal></term>
<listitem><simpara> An object which reports messages of minor importance to the user
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TABLE:CAPS" role="constant">
<term><literal>ATK_ROLE_TABLE</literal></term>
<listitem><simpara> An object used to represent information in terms of rows and columns
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TABLE-CELL:CAPS" role="constant">
<term><literal>ATK_ROLE_TABLE_CELL</literal></term>
<listitem><simpara> A cell in a table
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TABLE-COLUMN-HEADER:CAPS" role="constant">
<term><literal>ATK_ROLE_TABLE_COLUMN_HEADER</literal></term>
<listitem><simpara> The header for a column of a table
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TABLE-ROW-HEADER:CAPS" role="constant">
<term><literal>ATK_ROLE_TABLE_ROW_HEADER</literal></term>
<listitem><simpara> The header for a row of a table
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TEAR-OFF-MENU-ITEM:CAPS" role="constant">
<term><literal>ATK_ROLE_TEAR_OFF_MENU_ITEM</literal></term>
<listitem><simpara> A menu item used to tear off and reattach its menu
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TERMINAL:CAPS" role="constant">
<term><literal>ATK_ROLE_TERMINAL</literal></term>
<listitem><simpara> An object that represents an accessible terminal.  <parameter>Since</parameter>: ATK-0.6
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TEXT:CAPS" role="constant">
<term><literal>ATK_ROLE_TEXT</literal></term>
<listitem><simpara> An object that presents text to the user
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TOGGLE-BUTTON:CAPS" role="constant">
<term><literal>ATK_ROLE_TOGGLE_BUTTON</literal></term>
<listitem><simpara> A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TOOL-BAR:CAPS" role="constant">
<term><literal>ATK_ROLE_TOOL_BAR</literal></term>
<listitem><simpara> A bar or palette usually composed of push buttons or toggle buttons
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TOOL-TIP:CAPS" role="constant">
<term><literal>ATK_ROLE_TOOL_TIP</literal></term>
<listitem><simpara> An object that provides information about another object
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TREE:CAPS" role="constant">
<term><literal>ATK_ROLE_TREE</literal></term>
<listitem><simpara> An object used to represent hierarchical information to the user
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-TREE-TABLE:CAPS" role="constant">
<term><literal>ATK_ROLE_TREE_TABLE</literal></term>
<listitem><simpara> An object capable of expanding and collapsing rows as well as showing multiple columns of data.   <parameter>Since</parameter>: ATK-0.7
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-UNKNOWN:CAPS" role="constant">
<term><literal>ATK_ROLE_UNKNOWN</literal></term>
<listitem><simpara> The object contains some Accessible information, but its role is not known
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-VIEWPORT:CAPS" role="constant">
<term><literal>ATK_ROLE_VIEWPORT</literal></term>
<listitem><simpara> An object usually used in a scroll pane
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-WINDOW:CAPS" role="constant">
<term><literal>ATK_ROLE_WINDOW</literal></term>
<listitem><simpara> A top level window with no title or border.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-HEADER:CAPS" role="constant">
<term><literal>ATK_ROLE_HEADER</literal></term>
<listitem><simpara> An object that serves as a document header. <parameter>Since</parameter>:ATK 1.1.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-FOOTER:CAPS" role="constant">
<term><literal>ATK_ROLE_FOOTER</literal></term>
<listitem><simpara> An object that serves as a document footer.  <parameter>Since</parameter>: ATK-1.1.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PARAGRAPH:CAPS" role="constant">
<term><literal>ATK_ROLE_PARAGRAPH</literal></term>
<listitem><simpara> An object which is contains a paragraph of text content.   <parameter>Since</parameter>: ATK-1.1.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-RULER:CAPS" role="constant">
<term><literal>ATK_ROLE_RULER</literal></term>
<listitem><simpara> An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).   <parameter>Since</parameter>: ATK-1.1.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-APPLICATION:CAPS" role="constant">
<term><literal>ATK_ROLE_APPLICATION</literal></term>
<listitem><simpara> The object is an application object, which may contain <parameter>ATK_ROLE_FRAME</parameter> objects or other types of accessibles.  The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION.   <parameter>Since</parameter>: ATK-1.1.4
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-AUTOCOMPLETE:CAPS" role="constant">
<term><literal>ATK_ROLE_AUTOCOMPLETE</literal></term>
<listitem><simpara> The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.   <parameter>Since</parameter>: ATK-1.3
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-EDITBAR:CAPS" role="constant">
<term><literal>ATK_ROLE_EDITBAR</literal></term>
<listitem><simpara> The object is an editable text object in a toolbar.  <parameter>Since</parameter>: ATK-1.5
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-EMBEDDED:CAPS" role="constant">
<term><literal>ATK_ROLE_EMBEDDED</literal></term>
<listitem><simpara> The object is an embedded container within a document or panel.  This role is a grouping "hint" indicating that the contained objects share a context.  <parameter>Since</parameter>: ATK-1.7.2
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ENTRY:CAPS" role="constant">
<term><literal>ATK_ROLE_ENTRY</literal></term>
<listitem><simpara> The object is a component whose textual content may be entered or modified by the user, provided <parameter>ATK_STATE_EDITABLE</parameter> is present.   <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CHART:CAPS" role="constant">
<term><literal>ATK_ROLE_CHART</literal></term>
<listitem><simpara> The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property.  <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CAPTION:CAPS" role="constant">
<term><literal>ATK_ROLE_CAPTION</literal></term>
<listitem><simpara> The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.  <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DOCUMENT-FRAME:CAPS" role="constant">
<term><literal>ATK_ROLE_DOCUMENT_FRAME</literal></term>
<listitem><simpara> The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface.  <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-HEADING:CAPS" role="constant">
<term><literal>ATK_ROLE_HEADING</literal></term>
<listitem><simpara> The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PAGE:CAPS" role="constant">
<term><literal>ATK_ROLE_PAGE</literal></term>
<listitem><simpara> The object is a containing instance which encapsulates a page of information. <parameter>ATK_ROLE_PAGE</parameter> is used in documents and content which support a paginated navigation model.  <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-SECTION:CAPS" role="constant">
<term><literal>ATK_ROLE_SECTION</literal></term>
<listitem><simpara> The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-REDUNDANT-OBJECT:CAPS" role="constant">
<term><literal>ATK_ROLE_REDUNDANT_OBJECT</literal></term>
<listitem><simpara> The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons.  Objects of this role should normally be ignored by clients. <parameter>Since</parameter>: ATK-1.11
</simpara></listitem>