Initial revision
[platform/core/uifw/at-spi2-atk.git] / idl / Accessibility_Role.idl
1 #ifndef _ACCESSIBILITY_ROLE_IDL
2 #define  _ACCESSIBILITY_ROLE_IDL
3
4 #if !defined(__ACCESSIBILITY_ROLE_COMPILATION) && defined(__ORBIT_IDL__)
5 %{
6 #pragma include_defs Role.h
7 %}
8 #pragma inhibit push
9 #endif
10
11 module Accessibility {
12
13   enum Role {
14   ROLE_INVALID,
15   /* Object is used to alert the user about something */
16   ROLE_ALERT,
17   /* Object that can be drawn into and is used to trap events */
18   ROLE_CANVAS,
19   /*
20    * A choice that can be checked or unchecked and provides a separate
21    * indicator for the current state.
22    */
23   ROLE_CHECK_BOX,
24   /* A specialized dialog that lets the user choose a color. */
25   ROLE_COLOR_CHOOSER,
26   /* The header for a column of data */
27   ROLE_COLUMN_HEADER,
28   /* A list of choices the user can select from */
29   ROLE_COMBO_BOX,
30   /* An inconifed internal frame within a DESKTOP_PANE */
31   ROLE_DESKTOP_ICON,
32   /*
33    * A pane that supports internal frames and iconified versions of those
34    * internal frames.
35    */
36   ROLE_DESKTOP_FRAME,
37   /* A top level window with title bar and a border */
38   ROLE_DIALOG,
39   /*
40    * A pane that allows the user to navigate through and select the contents
41    * of a directory
42    */
43   ROLE_DIRECTORY_PANE,
44   /*
45    * A specialized dialog that displays the files in the directory and lets
46    * the user select a file, browse a different directory, or specify a
47    * filename.
48    */
49   ROLE_FILE_CHOOSER,
50   /*
51    * A object that fills up space in a user interface
52    */
53   ROLE_FILLER,
54   /* XXX Don't know sure about this. */
55   ROLE_FOCUS_TRAVERSABLE,
56   /* A top level window with a title bar, border, menubar, etc. */
57   ROLE_FRAME,
58   /* A pane that is guaranteed to be painted on top of all panes beneath it */
59   ROLE_GLASS_PANE,
60   /*
61    * A document container for HTML, whose children
62    * represent the document content.
63    */
64   ROLE_HTML_CONTAINER,
65   /* A small fixed size picture, typically used to decorate components */
66   ROLE_ICON,
67   /* A frame-like object that is clipped by a desktop pane. */
68   ROLE_INTERNAL_FRAME,
69   /* An object used to present an icon or short string in an interface */
70   ROLE_LABEL,
71   /*
72    * A specialized pane that allows its children to be drawn in layers,
73    * providing a form of stacking order.
74    */
75   ROLE_LAYERED_PANE,
76   /*
77    * An object that presents a list of objects to the user and allows the
78    * user to select one or more of them.
79    */
80   ROLE_LIST,
81    /* An object that represents an element of a list. */
82   ROLE_LIST_ITEM,
83   /*
84    * An object usually found inside a menu bar that contains a list of
85    * actions the user can choose from.
86    */
87   ROLE_MENU,
88   /*
89    * An object usually drawn at the top of the primary dialog box of an
90    * application that contains a list of menus the user can choose from.
91    */
92   ROLE_MENU_BAR,
93   /*
94    * An object usually contained in a menu that presents an action the
95    * user can choose.
96    */
97   ROLE_MENU_ITEM,
98   /* A specialized pane whose primary use is inside a DIALOG */
99   ROLE_OPTION_PANE,
100   /* An object that is a child of a page tab list */
101   ROLE_PAGE_TAB,
102   /*
103    * An object that presents a series of panels (or page tabs), one at a time,
104    * through some mechanism provided by the object.
105    */
106   ROLE_PAGE_TAB_LIST,
107   /* A generic container that is often used to group objects. */
108   ROLE_PANEL,
109   /*
110    * A text object uses for passwords, or other places where the text
111    * content is not shown visibly to the user.
112    */
113   ROLE_PASSWORD_TEXT,
114   /*
115    * A temporary window that is usually used to offer the user a list of
116    * choices, and then hides when the user selects one of those choices.
117    */
118   ROLE_POPUP_MENU,
119   /* An object used to indicate how much of a task has been completed. */
120   ROLE_PROGRESS_BAR,
121   /*
122    * An object the user can manipulate to tell the application to do
123    * something.
124    */
125   ROLE_PUSH_BUTTON,
126   /*
127    * A specialized check box that will cause other radio buttons in the
128    * same group to become uncghecked when this one is checked.
129    */
130   ROLE_RADIO_BUTTON,
131   /*
132    * A specialized pane that has a glass pane and a layered pane as its
133    * children.
134    */
135   ROLE_ROOT_PANE,
136   /* The header for a row of data */
137   ROLE_ROW_HEADER,
138   /*
139    * An object usually used to allow a user to incrementally view a large
140    * amount of data.
141    */
142   ROLE_SCROLL_BAR,
143   /*
144    * An object that allows a user to incrementally view a large amount
145    * of information.
146    */
147   ROLE_SCROLL_PANE,
148   /*
149    * An object usually contained in a menu to provide a visible and
150    * logical separation of the contents in a menu.
151    */
152   ROLE_SEPARATOR,
153   /* An object that allows the user to select from a bounded range */
154   ROLE_SLIDER,
155   /* A specialized panel that presents two other panels at the same time. */
156   ROLE_SPLIT_PANE,
157   /* An object used to rpesent information in terms of rows and columns. */
158   ROLE_TABLE,
159   ROLE_TABLE_CELL,
160   ROLE_TABLE_COLUMN_HEADER,
161   ROLE_TABLE_ROW_HEADER,
162   /* An object that presents text to the user */
163   ROLE_TEXT,
164   /*
165    * A specialized push button that can be checked or unchecked, but does
166    * not procide a separate indicator for the current state.
167    */
168   ROLE_TOGGLE_BUTTON,
169   /*
170    * A bar or palette usually composed of push buttons or toggle buttons
171    */
172   ROLE_TOOL_BAR,
173   /*
174    * An object that provides information about another object
175    */
176   ROLE_TOOL_TIP,
177   /* An object used to repsent hierarchical information to the user. */
178   ROLE_TREE,
179   /*
180    * The object contains some Accessible information, but its role is
181    * not known.
182    */
183   ROLE_UNKNOWN,
184   /* An object usually used in a scroll pane. */
185   ROLE_VIEWPORT,
186   /* A top level window with no title or border */
187   ROLE_WINDOW,
188   /* not a valid role, used for finding end of enumeration. */
189   ROLE_LAST_DEFINED
190   };
191 };
192 #if !defined(__ACCESSIBILITY_ROLE_COMPILATION) && defined(__ORBIT_IDL__)
193 #pragma inhibit pop
194 #endif
195
196 #endif