cspi/spi-roletypes.h

   1 #ifndef _SPI_ROLETYPES_H_
   2 #define _SPI_ROLETYPES_H_
   3
   4 /**
   5  * AccessibleRole:
   6  * @SPI_ROLE_INVALID: role is not legal, something is wrong with this object
   7  * @SPI_ROLE_ALERT: Object is used to alert the user about something
   8  * @SPI_ROLE_CANVAS: Object that can be drawn into and is used to trap events
   9  * @SPI_ROLE_CHECK_BOX: Object representd a choice that can be checked or unchecked
  10  *                    and provides a separate indicator for the current state.
  11  * @SPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color.
  12  * @SPI_ROLE_COLUMN_HEADER: The header for a column of data
  13  * @SPI_ROLE_COMBO_BOX: A list of choices the user can select from
  14  * @SPI_ROLE_SPI_DESKTOP_ICON: An inconifed internal frame within a SPI_DESKTOP_PANE
  15  * @SPI_ROLE_SPI_DESKTOP_FRAME: A pane that supports internal frames and
  16  *              iconified versions of those internal frames.
  17  * @SPI_ROLE_DIALOG: A top level window with title bar and a border
  18  * @SPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate
  19  *              through and select the contents of a directory.
  20  * @SPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in the
  21  *               directory and lets the user select a file, browse a different
  22  *               directory, or specify a filename.
  23  * @SPI_ROLE_FILLER: A object that fills up space in a user interface
  24  * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this.
  25  * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  26  * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all
  27  *               panes beneath it
  28  * @SPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
  29  *               represent the document content.
  30  * @SPI_ROLE_ICON: A small fixed size picture, typically used to decorate components.
  31  * @SPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane.
  32  * @SPI_ROLE_LABEL: An object used to present an icon or short string in an interface
  33  * @SPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers
  34  *                         providing a  form of stacking order.
  35  * @SPI_ROLE_LIST: An object that presents a list of objects to the user and allows the
  36  *                         user to select one or more of them.
  37  * @SPI_ROLE_LIST_ITEM: An object that represents an element of a list.
  38  * @SPI_ROLE_MENU: An object usually found inside a menu bar that contains a list of
  39  *                 actions the user can choose from.
  40  * @SPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary dialog box of an
  41  *                 application that contains a list of menus the user can choose from.
  42  * @SPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents an
  43  *                 action the user can choose.
  44  * @SPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
  45  * @SPI_ROLE_PAGE_TAB: An object that is a child of a page tab list
  46  * @SPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or page tabs),
  47  *        one at a time, through some mechanism provided by the object.
  48  * @SPI_ROLE_PANEL: A generic container that is often used to group objects.
  49  * @SPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where
  50  *        the text content is not shown visibly to the user.
  51  * @SPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a
  52  *        list of choices, and then hides when the user selects one of those choices.
  53  * @SPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed.
  54  * @SPI_ROLE_PUSH_BUTTON: A specialized object which the user can interact with to tell
  55  *        the application to do something.
  56  * @SPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the
  57  *        same group to become uncghecked when this one is checked.
  58  * @SPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its
  59  *        children.
  60  * @SPI_ROLE_ROW_HEADER: The header for a row of data
  61  * @SPI_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally
  62  *        view a large amount of data.
  63  * @SPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount
  64  *         of information.
  65  * @SPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and
  66  *        logical separation of the contents in a menu.
  67  * @SPI_ROLE_SLIDER: An object that allows the user to select from a bounded range.
  68  * @SPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time.
  69  * @SPI_ROLE_TABLE: An object used to rpesent information in terms of rows and columns.
  70  * @SPI_ROLE_TABLE_CELL: An object which is a descendant of a table,
  71  *        with a row/column location.  A cell may span multiple rows and columns.
  72  * @SPI_ROLE_TABLE_COLUMN_HEADER: An object which serves to describe a column in a table.
  73  * @SPI_ROLE_TABLE_ROW_HEADER: An object which serves to label or describe a row in a table.
  74  * @SPI_ROLE_TEXT: An object that presents text to the user
  75  * @SPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked,
  76  *        but does not provide a separate indicator for the current state.
  77  * @SPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
  78  * @SPI_ROLE_TOOL_TIP: An object that provides information about another object
  79  * @SPI_ROLE_TREE: An object used to repsent hierarchical information to the user.
  80  * @SPI_ROLE_UNKNOWN: The object contains some SpiAccessible information, but its role is
  81  *                    not known.
  82  * @SPI_ROLE_VIEWPORT: An object usually used in a scroll pane, which restricts the visual
  83  *                    area into which its contents are presented.
  84  * @SPI_ROLE_WINDOW: A top level window with no title or border.
  85  **/
  86 typedef enum
  87 {
  88   SPI_ROLE_INVALID,
  89   SPI_ROLE_ALERT,
  90   SPI_ROLE_CANVAS,
  91   SPI_ROLE_CHECK_BOX,
  92   SPI_ROLE_COLOR_CHOOSER,
  93   SPI_ROLE_COLUMN_HEADER,
  94   SPI_ROLE_COMBO_BOX,
  95   SPI_ROLE_SPI_DESKTOP_ICON,
  96   SPI_ROLE_SPI_DESKTOP_FRAME,
  97   SPI_ROLE_DIALOG,
  98   SPI_ROLE_DIRECTORY_PANE,
  99   SPI_ROLE_FILE_CHOOSER,
 100   SPI_ROLE_FILLER,
 101   SPI_ROLE_FOCUS_TRAVERSABLE,
 102   SPI_ROLE_FRAME,
 103   SPI_ROLE_GLASS_PANE,
 104   SPI_ROLE_HTML_CONTAINER,
 105   SPI_ROLE_ICON,
 106   SPI_ROLE_INTERNAL_FRAME,
 107   SPI_ROLE_LABEL,
 108   SPI_ROLE_LAYERED_PANE,
 109   SPI_ROLE_LIST,
 110   SPI_ROLE_LIST_ITEM,
 111   SPI_ROLE_MENU,
 112   SPI_ROLE_MENU_BAR,
 113   SPI_ROLE_MENU_ITEM,
 114   SPI_ROLE_OPTION_PANE,
 115   SPI_ROLE_PAGE_TAB,
 116   SPI_ROLE_PAGE_TAB_LIST,
 117   SPI_ROLE_PANEL,
 118   SPI_ROLE_PASSWORD_TEXT,
 119   SPI_ROLE_POPUP_MENU,
 120   SPI_ROLE_PROGRESS_BAR,
 121   SPI_ROLE_PUSH_BUTTON,
 122   SPI_ROLE_RADIO_BUTTON,
 123   SPI_ROLE_ROOT_PANE,
 124   SPI_ROLE_ROW_HEADER,
 125   SPI_ROLE_SCROLL_BAR,
 126   SPI_ROLE_SCROLL_PANE,
 127   SPI_ROLE_SEPARATOR,
 128   SPI_ROLE_SLIDER,
 129   SPI_ROLE_SPLIT_PANE,
 130   SPI_ROLE_TABLE,
 131   SPI_ROLE_TABLE_CELL,
 132   SPI_ROLE_TABLE_COLUMN_HEADER,
 133   SPI_ROLE_TABLE_ROW_HEADER,
 134   SPI_ROLE_TEXT,
 135   SPI_ROLE_TOGGLE_BUTTON,
 136   SPI_ROLE_TOOL_BAR,
 137   SPI_ROLE_TOOL_TIP,
 138   SPI_ROLE_TREE,
 139   SPI_ROLE_UNKNOWN,
 140   SPI_ROLE_VIEWPORT,
 141   SPI_ROLE_WINDOW,
 142   SPI_ROLE_LAST_DEFINED
 143 } AccessibleRole;
 144
 145 char* AccessibleRole_getName (AccessibleRole role);
 146
 147 #endif