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