cspi/spi-roletypes.h

   1 #ifndef _SPI_ROLETYPES_H_
   2 #define _SPI_ROLETYPES_H_
   3
   4 #ifdef  __cplusplus
   5 extern "C" {
   6 #endif
   7
   8 /**
   9  * AccessibleRole:
  10  * @SPI_ROLE_INVALID: role is not legal, something is wrong with this object
  11  * @SPI_ROLE_ACCEL_LABEL: object is a label indicating keyboard
  12  *                              accelerators for the parent
  13  * @SPI_ROLE_ALERT: Object is used to alert the user about something
  14  * @SPI_ROLE_ANIMATION: Object contains a dynamic or moving image
  15  * @SPI_ROLE_ARROW: Object is a 2d directional indicator
  16  * @SPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged into
  17  *                     a 2d list
  18  * @SPI_ROLE_CANVAS: Object that can be drawn into and is used to trap events
  19  * @SPI_ROLE_CHECK_BOX: Object representd a choice that can be checked or unchecked
  20  *                    and provides a separate indicator for the current state.
  21  * @SPI_ROLE_CHECK_MENU_ITEM: Object is a menu item that behaves like a CHECK_BOX
  22  * @SPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color.
  23  * @SPI_ROLE_COLUMN_HEADER: The header for a column of data
  24  * @SPI_ROLE_COMBO_BOX: A list of choices the user can select from
  25  * @SPI_ROLE_DATE_EDITOR: Allows entry of a date
  26  * @SPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
  27  * @SPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
  28  *              iconified versions of those internal frames.
  29  * @SPI_ROLE_DIAL: A rotating/rotatable valuator
  30  * @SPI_ROLE_DIALOG: A top level window with title bar and a border
  31  * @SPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate
  32  *              through and select the contents of a directory.
  33  * @SPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in the
  34  *               directory and lets the user select a file, browse a different
  35  *               directory, or specify a filename.
  36  * @SPI_ROLE_FILLER: A object that fills up space in a user interface
  37  * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this.
  38  * @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font
  39  * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  40  * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all
  41  *               panes beneath it
  42  * @SPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
  43  *               represent the document content.
  44  * @SPI_ROLE_ICON: A small fixed size picture, typically used to decorate components.
  45  * @SPI_ROLE_IMAGE: An image, typically static
  46  * @SPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane.
  47  * @SPI_ROLE_LABEL: An object used to present an icon or short string in an interface
  48  * @SPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers
  49  *                         providing a  form of stacking order.
  50  * @SPI_ROLE_LIST: An object that presents a list of objects to the user and allows the
  51  *                         user to select one or more of them.
  52  * @SPI_ROLE_LIST_ITEM: An object that represents an element of a list.
  53  * @SPI_ROLE_MENU: An object usually found inside a menu bar that contains a list of
  54  *                 actions the user can choose from.
  55  * @SPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary dialog box of an
  56  *                 application that contains a list of menus the user can choose from.
  57  * @SPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents an
  58  *                 action the user can choose.
  59  * @SPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
  60  * @SPI_ROLE_PAGE_TAB: An object that is a child of a page tab list
  61  * @SPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or page tabs),
  62  *        one at a time, through some mechanism provided by the object.
  63  * @SPI_ROLE_PANEL: A generic container that is often used to group objects.
  64  * @SPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where
  65  *        the text content is not shown visibly to the user.
  66  * @SPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a
  67  *        list of choices, and then hides when the user selects one of those choices.
  68  * @SPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed.
  69  * @SPI_ROLE_PUSH_BUTTON: A specialized object which the user can interact with to tell
  70  *        the application to do something.
  71  * @SPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the
  72  *        same group to become uncghecked when this one is checked.
  73  * @SPI_RADIO_MENU_ITEM: A specialized menu item that behaves like a
  74  *        radio button.
  75  * @SPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its
  76  *        children.
  77  * @SPI_ROLE_ROW_HEADER: The header for a row of data
  78  * @SPI_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally
  79  *        view a large amount of data.
  80  * @SPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount
  81  *         of information.
  82  * @SPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and
  83  *        logical separation of the contents in a menu.
  84  * @SPI_ROLE_SLIDER: An object that allows the user to select from a bounded range.
  85  * @SPI_ROLE_SPIN_BUTTON: An object which allows selection from a set of choices and
  86  *                        displays the current choice.
  87  * @SPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time.
  88  * @SPI_ROLE_STATUS_BAR: An object the display qualitative status information. c.f. PROGRESS_BAR
  89  * @SPI_ROLE_TABLE: An object used to rpesent information in terms of rows and columns.
  90  * @SPI_ROLE_TABLE_CELL: An object which is a descendant of a table,
  91  *        with a row/column location.  A cell may span multiple rows and columns.
  92  * @SPI_ROLE_TABLE_COLUMN_HEADER: An object which serves to describe a column in a table.
  93  * @SPI_ROLE_TABLE_ROW_HEADER: An object which serves to label or describe a row in a table.
  94  * @SPI_ROLE_TEAROFF_MENU_ITEM: A menu item which allows the menu to be removed from
  95  *                              a menubar and placed in its own window
  96  * @SPI_ROLE_TERMINAL: An object that emulates a teletype or terminal
  97  * @SPI_ROLE_TEXT: An object that presents text to the user
  98  * @SPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked,
  99  *        but does not provide a separate indicator for the current state.
 100  * @SPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
 101  * @SPI_ROLE_TOOL_TIP: An object that provides information about another object
 102  * @SPI_ROLE_TREE: An object used to represent hierarchical information to the user
 103  * @SPI_ROLE_TREE_TABLE: An object which represents both hierarchical and tabular information
 104  * @SPI_ROLE_UNKNOWN: The object contains some SpiAccessible information, but its role is
 105  *                    not known.
 106  * @SPI_ROLE_VIEWPORT: An object usually used in a scroll pane, which restricts the visual
 107  *                    area into which its contents are presented.
 108  * @SPI_ROLE_WINDOW: A top level window with no title or border.
 109  * @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and
 110  *                     should be queried by name.
 111  **/
 112 typedef enum
 113 {
 114   SPI_ROLE_INVALID,
 115   SPI_ROLE_ACCEL_LABEL,
 116   SPI_ROLE_ALERT,
 117   SPI_ROLE_ANIMATION,
 118   SPI_ROLE_ARROW,
 119   SPI_ROLE_CALENDAR,
 120   SPI_ROLE_CANVAS,
 121   SPI_ROLE_CHECK_BOX,
 122   SPI_ROLE_CHECK_MENU_ITEM,
 123   SPI_ROLE_COLOR_CHOOSER,
 124   SPI_ROLE_COLUMN_HEADER,
 125   SPI_ROLE_COMBO_BOX,
 126   SPI_ROLE_DATE_EDITOR,
 127   SPI_ROLE_DESKTOP_ICON,
 128   SPI_ROLE_DESKTOP_FRAME,
 129   SPI_ROLE_DIAL,
 130   SPI_ROLE_DIALOG,
 131   SPI_ROLE_DIRECTORY_PANE,
 132   SPI_ROLE_FILE_CHOOSER,
 133   SPI_ROLE_FILLER,
 134   SPI_ROLE_FOCUS_TRAVERSABLE,
 135   SPI_ROLE_FONT_CHOOSER,
 136   SPI_ROLE_FRAME,
 137   SPI_ROLE_GLASS_PANE,
 138   SPI_ROLE_HTML_CONTAINER,
 139   SPI_ROLE_ICON,
 140   SPI_ROLE_IMAGE,
 141   SPI_ROLE_INTERNAL_FRAME,
 142   SPI_ROLE_LABEL,
 143   SPI_ROLE_LAYERED_PANE,
 144   SPI_ROLE_LIST,
 145   SPI_ROLE_LIST_ITEM,
 146   SPI_ROLE_MENU,
 147   SPI_ROLE_MENU_BAR,
 148   SPI_ROLE_MENU_ITEM,
 149   SPI_ROLE_OPTION_PANE,
 150   SPI_ROLE_PAGE_TAB,
 151   SPI_ROLE_PAGE_TAB_LIST,
 152   SPI_ROLE_PANEL,
 153   SPI_ROLE_PASSWORD_TEXT,
 154   SPI_ROLE_POPUP_MENU,
 155   SPI_ROLE_PROGRESS_BAR,
 156   SPI_ROLE_PUSH_BUTTON,
 157   SPI_ROLE_RADIO_BUTTON,
 158   SPI_ROLE_RADIO_MENU_ITEM,
 159   SPI_ROLE_ROOT_PANE,
 160   SPI_ROLE_ROW_HEADER,
 161   SPI_ROLE_SCROLL_BAR,
 162   SPI_ROLE_SCROLL_PANE,
 163   SPI_ROLE_SEPARATOR,
 164   SPI_ROLE_SLIDER,
 165   SPI_ROLE_SPIN_BUTTON,
 166   SPI_ROLE_SPLIT_PANE,
 167   SPI_ROLE_STATUS_BAR,
 168   SPI_ROLE_TABLE,
 169   SPI_ROLE_TABLE_CELL,
 170   SPI_ROLE_TABLE_COLUMN_HEADER,
 171   SPI_ROLE_TABLE_ROW_HEADER,
 172   SPI_ROLE_TEAROFF_MENU_ITEM,
 173   SPI_ROLE_TEXT,
 174   SPI_ROLE_TOGGLE_BUTTON,
 175   SPI_ROLE_TOOL_BAR,
 176   SPI_ROLE_TOOL_TIP,
 177   SPI_ROLE_TREE,
 178   SPI_ROLE_TREE_TABLE,
 179   SPI_ROLE_UNKNOWN,
 180   SPI_ROLE_VIEWPORT,
 181   SPI_ROLE_WINDOW,
 182   SPI_ROLE_EXTENDED,
 183   SPI_ROLE_LAST_DEFINED
 184 } AccessibleRole;
 185
 186 char* AccessibleRole_getName (AccessibleRole role);
 187
 188 #ifdef  __cplusplus
 189 }
 190 #endif
 191
 192 #endif