+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
#ifndef _SPI_ROLETYPES_H_
#define _SPI_ROLETYPES_H_
* @SPI_ROLE_DIALOG: A top level window with title bar and a border
* @SPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate
* through and select the contents of a directory.
+ * @SPI_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
* @SPI_ROLE_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.
* @SPI_ROLE_FILLER: A object that fills up space in a user interface
- * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this.
* @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font
* @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
* @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all
* the application to do something.
* @SPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the
* same group to become uncghecked when this one is checked.
- * @SPI_RADIO_MENU_ITEM: A specialized menu item that behaves like a
+ * @SPI_ROLE_RADIO_MENU_ITEM: A specialized menu item that behaves like a
* radio button.
* @SPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its
* children.
* @SPI_ROLE_WINDOW: A top level window with no title or border.
* @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and
* should be queried by name.
+ * @SPI_ROLE_HEADER: An object that serves as a document header.
+ * @SPI_ROLE_FOOTER: An object that serves as a document footer.
+ * @SPI_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.
+ * @SPI_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects
+ * which it controls (should have CONTROLLER_FOR relation to such).
+ * @SPI_ROLE_APPLICATION: An object which corresponds to a desktop application,
+ * which may have children of @SPI_ROLE_FRAME or other type.
+ * @SPI_ROLE_AUTOCOMPLETE: 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.
+ * @SPI_ROLE_EDITBAR: The object is an editable text object in a toolbar
+ * @SPI_ROLE_EMBEDDED: The object is an embedded component container.
+ * This role is a "grouping" hint that the contained
+ * objects share a context which is different from the
+ * container in which this accessible is embedded.
+ * Uses: document embedding, "panel applets", etc.
+ * @SPI_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @SPI_STATE_EDITABLE is present.
+ * @SPI_ROLE_CHART: 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.
+ * @SPI_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.
+ * @SPI_ROLE_DOCUMENT_FRAME: 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.
+ * @SPI_ROLE_HEADING: 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.
+ * @SPI_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @SPI_ROLE_PAGE is used in documents and content which support a paginated navigation model.
+ * @SPI_ROLE_SECTION: 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.
+ * @SPI_ROLE_REDUNDANT_OBJECT: 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.
+ * @SPI_ROLE_FORM: The object is a container for form controls, for instance as part of a
+ * web form or user-input form within a document. This role is primarily a tag/convenience for
+ * clients when navigating complex documents, it is not expected that ordinary GUI containers will
+ * always have ATK_ROLE_FORM.
+ * @SPI_ROLE_LINK: The object is a hypertext anchor.
+ * @SPI_ROLE_INPUT_METHOD_WINDOW: The object is an input method window used
+ * to input or compose a text character (typically a "complex text" character).
+ * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration.
+ *
+ * Describes the role of an object
+ *
+ * These are the built-in enumerated roles that UI components can have.
+ * Other roles may be added at runtime, so an AccessibleRole >=
+ * SPI_ROLE_LAST_DEFINED is not necessarily an error.
**/
typedef enum
{
SPI_ROLE_DIAL,
SPI_ROLE_DIALOG,
SPI_ROLE_DIRECTORY_PANE,
+ SPI_ROLE_DRAWING_AREA,
SPI_ROLE_FILE_CHOOSER,
SPI_ROLE_FILLER,
- SPI_ROLE_FOCUS_TRAVERSABLE,
SPI_ROLE_FONT_CHOOSER,
SPI_ROLE_FRAME,
SPI_ROLE_GLASS_PANE,
SPI_ROLE_TABLE_COLUMN_HEADER,
SPI_ROLE_TABLE_ROW_HEADER,
SPI_ROLE_TEAROFF_MENU_ITEM,
+ SPI_ROLE_TERMINAL,
SPI_ROLE_TEXT,
SPI_ROLE_TOGGLE_BUTTON,
SPI_ROLE_TOOL_BAR,
SPI_ROLE_VIEWPORT,
SPI_ROLE_WINDOW,
SPI_ROLE_EXTENDED,
+ SPI_ROLE_HEADER,
+ SPI_ROLE_FOOTER,
+ SPI_ROLE_PARAGRAPH,
+ SPI_ROLE_RULER,
+ SPI_ROLE_APPLICATION,
+ SPI_ROLE_AUTOCOMPLETE,
+ SPI_ROLE_EDITBAR,
+ SPI_ROLE_EMBEDDED,
+ SPI_ROLE_ENTRY,
+ SPI_ROLE_CHART,
+ SPI_ROLE_CAPTION,
+ SPI_ROLE_DOCUMENT_FRAME,
+ SPI_ROLE_HEADING,
+ SPI_ROLE_PAGE,
+ SPI_ROLE_SECTION,
+ SPI_ROLE_FORM,
+ SPI_ROLE_REDUNDANT_OBJECT,
+ SPI_ROLE_LINK,
+ SPI_ROLE_INPUT_METHOD_WINDOW,
SPI_ROLE_LAST_DEFINED
} AccessibleRole;
projects / platform / core / uifw / at-spi2-atk.git / blobdiff