atkobject.xml

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

  ATK_ROLE_FOOTER,
  ATK_ROLE_PARAGRAPH,
  ATK_ROLE_RULER,
  ATK_ROLE_APPLICATION,
  ATK_ROLE_AUTOCOMPLETE,
  ATK_ROLE_EDITBAR,
  ATK_ROLE_EMBEDDED,
  ATK_ROLE_ENTRY,
  ATK_ROLE_CHART,
  ATK_ROLE_CAPTION,
  ATK_ROLE_DOCUMENT_FRAME,
  ATK_ROLE_HEADING,
  ATK_ROLE_PAGE,
  ATK_ROLE_SECTION,
  ATK_ROLE_REDUNDANT_OBJECT,
  ATK_ROLE_FORM,
  ATK_ROLE_LINK,
  ATK_ROLE_INPUT_METHOD_WINDOW,
  ATK_ROLE_LAST_DEFINED
} AtkRole;
</programlisting>
<para>
Describes the role of an object
</para>
<para>
These are the built-in enumerated roles that UI components can have in
ATK.  Other roles may be added at runtime, so an AtkRole &gt;=
ATK_ROLE_LAST_DEFINED is not necessarily an error.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="ATK-ROLE-INVALID:CAPS" role="constant">
<term><literal>ATK_ROLE_INVALID</literal></term>
<listitem><simpara> Invalid role
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ACCEL-LABEL:CAPS" role="constant">
<term><literal>ATK_ROLE_ACCEL_LABEL</literal></term>
<listitem><simpara> A label which represents an accelerator
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ALERT:CAPS" role="constant">
<term><literal>ATK_ROLE_ALERT</literal></term>
<listitem><simpara> An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role.  Should be used for warning dialogs, etc.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ANIMATION:CAPS" role="constant">
<term><literal>ATK_ROLE_ANIMATION</literal></term>
<listitem><simpara> An object which is an animated image
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ARROW:CAPS" role="constant">
<term><literal>ATK_ROLE_ARROW</literal></term>
<listitem><simpara> An arrow in one of the four cardinal directions
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CALENDAR:CAPS" role="constant">
<term><literal>ATK_ROLE_CALENDAR</literal></term>
<listitem><simpara>  An object that displays a calendar and allows the user to select a date
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CANVAS:CAPS" role="constant">
<term><literal>ATK_ROLE_CANVAS</literal></term>
<listitem><simpara> An object that can be drawn into and is used to trap events
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CHECK-BOX:CAPS" role="constant">
<term><literal>ATK_ROLE_CHECK_BOX</literal></term>
<listitem><simpara> A choice that can be checked or unchecked and provides a separate indicator for the current state
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-CHECK-MENU-ITEM:CAPS" role="constant">
<term><literal>ATK_ROLE_CHECK_MENU_ITEM</literal></term>
<listitem><simpara> A menu item with a check box
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-COLOR-CHOOSER:CAPS" role="constant">
<term><literal>ATK_ROLE_COLOR_CHOOSER</literal></term>
<listitem><simpara> A specialized dialog that lets the user choose a color
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-COLUMN-HEADER:CAPS" role="constant">
<term><literal>ATK_ROLE_COLUMN_HEADER</literal></term>
<listitem><simpara> The header for a column of data
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-COMBO-BOX:CAPS" role="constant">
<term><literal>ATK_ROLE_COMBO_BOX</literal></term>
<listitem><simpara> A list of choices the user can select from
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DATE-EDITOR:CAPS" role="constant">
<term><literal>ATK_ROLE_DATE_EDITOR</literal></term>
<listitem><simpara> An object whose purpose is to allow a user to edit a date
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DESKTOP-ICON:CAPS" role="constant">
<term><literal>ATK_ROLE_DESKTOP_ICON</literal></term>
<listitem><simpara> An inconifed internal frame within a DESKTOP_PANE
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DESKTOP-FRAME:CAPS" role="constant">
<term><literal>ATK_ROLE_DESKTOP_FRAME</literal></term>
<listitem><simpara> A pane that supports internal frames and iconified versions of those internal frames
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DIAL:CAPS" role="constant">
<term><literal>ATK_ROLE_DIAL</literal></term>
<listitem><simpara> An object whose purpose is to allow a user to set a value
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DIALOG:CAPS" role="constant">
<term><literal>ATK_ROLE_DIALOG</literal></term>
<listitem><simpara> A top level window with title bar and a border
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DIRECTORY-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_DIRECTORY_PANE</literal></term>
<listitem><simpara> A pane that allows the user to navigate through and select the contents of a directory
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-DRAWING-AREA:CAPS" role="constant">
<term><literal>ATK_ROLE_DRAWING_AREA</literal></term>
<listitem><simpara> An object used for drawing custom user interface elements
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-FILE-CHOOSER:CAPS" role="constant">
<term><literal>ATK_ROLE_FILE_CHOOSER</literal></term>
<listitem><simpara> A specialized dialog that lets the user choose a file
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-FILLER:CAPS" role="constant">
<term><literal>ATK_ROLE_FILLER</literal></term>
<listitem><simpara> A object that fills up space in a user interface
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-FONT-CHOOSER:CAPS" role="constant">
<term><literal>ATK_ROLE_FONT_CHOOSER</literal></term>
<listitem><simpara> A specialized dialog that lets the user choose a font
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-FRAME:CAPS" role="constant">
<term><literal>ATK_ROLE_FRAME</literal></term>
<listitem><simpara> A top level window with a title bar, border, menubar, etc.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-GLASS-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_GLASS_PANE</literal></term>
<listitem><simpara> A pane that is guaranteed to be painted on top of all panes beneath it
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-HTML-CONTAINER:CAPS" role="constant">
<term><literal>ATK_ROLE_HTML_CONTAINER</literal></term>
<listitem><simpara> A document container for HTML, whose children represent the document content
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-ICON:CAPS" role="constant">
<term><literal>ATK_ROLE_ICON</literal></term>
<listitem><simpara> A small fixed size picture, typically used to decorate components
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-IMAGE:CAPS" role="constant">
<term><literal>ATK_ROLE_IMAGE</literal></term>
<listitem><simpara> An object whose primary purpose is to display an image
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-INTERNAL-FRAME:CAPS" role="constant">
<term><literal>ATK_ROLE_INTERNAL_FRAME</literal></term>
<listitem><simpara> A frame-like object that is clipped by a desktop pane
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LABEL:CAPS" role="constant">
<term><literal>ATK_ROLE_LABEL</literal></term>
<listitem><simpara> An object used to present an icon or short string in an interface
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LAYERED-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_LAYERED_PANE</literal></term>
<listitem><simpara> A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LIST:CAPS" role="constant">
<term><literal>ATK_ROLE_LIST</literal></term>
<listitem><simpara> An object that presents a list of objects to the user and allows the user to select one or more of them 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LIST-ITEM:CAPS" role="constant">
<term><literal>ATK_ROLE_LIST_ITEM</literal></term>
<listitem><simpara> An object that represents an element of a list 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-MENU:CAPS" role="constant">
<term><literal>ATK_ROLE_MENU</literal></term>
<listitem><simpara> An object usually found inside a menu bar that contains a list of actions the user can choose from
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-MENU-BAR:CAPS" role="constant">
<term><literal>ATK_ROLE_MENU_BAR</literal></term>
<listitem><simpara> An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-MENU-ITEM:CAPS" role="constant">
<term><literal>ATK_ROLE_MENU_ITEM</literal></term>
<listitem><simpara> An object usually contained in a menu that presents an action the user can choose
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-OPTION-PANE:CAPS" role="constant">
<term><literal>ATK_ROLE_OPTION_PANE</literal></term>
<listitem><simpara> A specialized pane whose primary use is inside a DIALOG
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PAGE-TAB:CAPS" role="constant">
<term><literal>ATK_ROLE_PAGE_TAB</literal></term>
<listitem><simpara> An object that is a child of a page tab list
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PAGE-TAB-LIST:CAPS" role="constant">
<term><literal>ATK_ROLE_PAGE_TAB_LIST</literal></term>
<listitem><simpara> An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object 
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PANEL:CAPS" role="constant">
<term><literal>ATK_ROLE_PANEL</literal></term>
<listitem><simpara> A generic container that is often used to group objects
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-PASSWORD-TEXT:CAPS" role="constant">
<term><literal>ATK_ROLE_PASSWORD_TEXT</literal></term>