2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001 Sun Microsystems Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef _ACCESSIBILITY_ROLE_IDL
24 #define _ACCESSIBILITY_ROLE_IDL
26 module Accessibility {
30 /* Object is a label indicating the keyboard accelerators for the parent */
31 ROLE_ACCELERATOR_LABEL,
32 /* Object is used to alert the user about something */
34 /* Object contains a dynamic or moving image of some kind */
36 /* Object is a 2d directional indicator */
38 /* Object contains one or more dates, usually arranged into a 2d list */
40 /* Object that can be drawn into and is used to trap events */
43 * A choice that can be checked or unchecked and provides a separate
44 * indicator for the current state.
47 /* A menu item that behaves like a check box (see ROLE_CHECK_BOX) */
49 /* A specialized dialog that lets the user choose a color. */
51 /* The header for a column of data */
53 /* A list of choices the user can select from */
55 /* An object which allows entry of a date */
57 /* An inconifed internal frame within a DESKTOP_PANE */
60 * A pane that supports internal frames and iconified versions of those
65 * An object that allows a value to be changed via rotating a visual element,
66 * or which displays a value via such a rotating element.
69 /* A top level window with title bar and a border */
72 * A pane that allows the user to navigate through and select the contents
77 * A specialized dialog that displays the files in the directory and lets
78 * the user select a file, browse a different directory, or specify a
83 * A object that fills up space in a user interface
86 /* XXX Don't know sure about this. */
87 ROLE_FOCUS_TRAVERSABLE,
88 /* Allows selection of a display font */
90 /* A top level window with a title bar, border, menubar, etc. */
92 /* A pane that is guaranteed to be painted on top of all panes beneath it */
95 * A document container for HTML, whose children
96 * represent the document content.
99 /* A small fixed size picture, typically used to decorate components */
101 /* An image, typically static. */
103 /* A frame-like object that is clipped by a desktop pane. */
105 /* An object used to present an icon or short string in an interface */
108 * A specialized pane that allows its children to be drawn in layers,
109 * providing a form of stacking order.
113 * An object that presents a list of objects to the user and allows the
114 * user to select one or more of them.
117 /* An object that represents an element of a list. */
120 * An object usually found inside a menu bar that contains a list of
121 * actions the user can choose from.
125 * An object usually drawn at the top of the primary dialog box of an
126 * application that contains a list of menus the user can choose from.
130 * An object usually contained in a menu that presents an action the
134 /* A specialized pane whose primary use is inside a DIALOG */
136 /* An object that is a child of a page tab list */
139 * An object that presents a series of panels (or page tabs), one at a time,
140 * through some mechanism provided by the object.
143 /* A generic container that is often used to group objects. */
146 * A text object uses for passwords, or other places where the text
147 * content is not shown visibly to the user.
151 * A temporary window that is usually used to offer the user a list of
152 * choices, and then hides when the user selects one of those choices.
155 /* An object used to indicate how much of a task has been completed. */
158 * An object the user can manipulate to tell the application to do
163 * A specialized check box that will cause other radio buttons in the
164 * same group to become uncghecked when this one is checked.
167 /* Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON) */
168 ROLE_RADIO_MENU_ITEM,
170 * A specialized pane that has a glass pane and a layered pane as its
174 /* The header for a row of data */
177 * An object usually used to allow a user to incrementally view a large
182 * An object that allows a user to incrementally view a large amount
187 * An object usually contained in a menu to provide a visible and
188 * logical separation of the contents in a menu.
191 /* An object that allows the user to select from a bounded range */
194 * An object which allows one of a set of choices to be selected,
195 * and which displays the current choice.
198 /* A specialized panel that presents two other panels at the same time. */
200 /* Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR) */
202 /* An object used to repesent information in terms of rows and columns. */
205 ROLE_TABLE_COLUMN_HEADER,
206 ROLE_TABLE_ROW_HEADER,
207 /* Object allows menu to be removed from menubar and shown in its own window. */
208 ROLE_TEAROFF_MENU_ITEM,
209 /* An object that emulates a terminal */
211 /* An object that presents text to the user */
214 * A specialized push button that can be checked or unchecked, but does
215 * not procide a separate indicator for the current state.
219 * A bar or palette usually composed of push buttons or toggle buttons
223 * An object that provides information about another object
226 /* An object used to repsent hierarchical information to the user. */
228 /* An object that presents both tabular and hierarchical info to the user */
231 * The object contains some Accessible information, but its role is
235 /* An object usually used in a scroll pane. */
237 /* A top level window with no title or border */
240 * means that the role for this item is known, but not included in the
244 /* not a valid role, used for finding end of enumeration. */