idl/Accessibility_Role.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 #ifndef _ACCESSIBILITY_ROLE_IDL
  24 #define _ACCESSIBILITY_ROLE_IDL
  25
  26 module Accessibility {
  27
  28   enum Role {
  29   ROLE_INVALID,
  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 */
  33   ROLE_ALERT,
  34   /* Object contains a dynamic or moving image of some kind */
  35   ROLE_ANIMATION,
  36   /* Object is a 2d directional indicator */
  37   ROLE_ARROW,
  38   /* Object contains one or more dates, usually arranged into a 2d list */
  39   ROLE_CALENDAR,
  40   /* Object that can be drawn into and is used to trap events */
  41   ROLE_CANVAS,
  42   /*
  43    * A choice that can be checked or unchecked and provides a separate
  44    * indicator for the current state.
  45    */
  46   ROLE_CHECK_BOX,
  47   /* A specialized dialog that lets the user choose a color. */
  48   ROLE_COLOR_CHOOSER,
  49   /* The header for a column of data */
  50   ROLE_COLUMN_HEADER,
  51   /* A list of choices the user can select from */
  52   ROLE_COMBO_BOX,
  53   /* An object which allows entry of a date */
  54   ROLE_DATE_EDITOR,
  55   /* An inconifed internal frame within a DESKTOP_PANE */
  56   ROLE_DESKTOP_ICON,
  57   /*
  58    * A pane that supports internal frames and iconified versions of those
  59    * internal frames.
  60    */
  61   ROLE_DESKTOP_FRAME,
  62   /* A top level window with title bar and a border */
  63   ROLE_DIALOG,
  64   /*
  65    * A pane that allows the user to navigate through and select the contents
  66    * of a directory
  67    */
  68   ROLE_DIRECTORY_PANE,
  69   /*
  70    * A specialized dialog that displays the files in the directory and lets
  71    * the user select a file, browse a different directory, or specify a
  72    * filename.
  73    */
  74   ROLE_FILE_CHOOSER,
  75   /*
  76    * A object that fills up space in a user interface
  77    */
  78   ROLE_FILLER,
  79   /* XXX Don't know sure about this. */
  80   ROLE_FOCUS_TRAVERSABLE,
  81   /* Allows selection of a display font */
  82   ROLE_FONT_CHOOSER,
  83   /* A top level window with a title bar, border, menubar, etc. */
  84   ROLE_FRAME,
  85   /* A pane that is guaranteed to be painted on top of all panes beneath it */
  86   ROLE_GLASS_PANE,
  87   /*
  88    * A document container for HTML, whose children
  89    * represent the document content.
  90    */
  91   ROLE_HTML_CONTAINER,
  92   /* A small fixed size picture, typically used to decorate components */
  93   ROLE_ICON,
  94   /* An image, typically static. */
  95   ROLE_IMAGE,
  96   /* A frame-like object that is clipped by a desktop pane. */
  97   ROLE_INTERNAL_FRAME,
  98   /* An object used to present an icon or short string in an interface */
  99   ROLE_LABEL,
 100   /*
 101    * A specialized pane that allows its children to be drawn in layers,
 102    * providing a form of stacking order.
 103    */
 104   ROLE_LAYERED_PANE,
 105   /*
 106    * An object that presents a list of objects to the user and allows the
 107    * user to select one or more of them.
 108    */
 109   ROLE_LIST,
 110    /* An object that represents an element of a list. */
 111   ROLE_LIST_ITEM,
 112   /*
 113    * An object usually found inside a menu bar that contains a list of
 114    * actions the user can choose from.
 115    */
 116   ROLE_MENU,
 117   /*
 118    * An object usually drawn at the top of the primary dialog box of an
 119    * application that contains a list of menus the user can choose from.
 120    */
 121   ROLE_MENU_BAR,
 122   /*
 123    * An object usually contained in a menu that presents an action the
 124    * user can choose.
 125    */
 126   ROLE_MENU_ITEM,
 127   /* A specialized pane whose primary use is inside a DIALOG */
 128   ROLE_OPTION_PANE,
 129   /* An object that is a child of a page tab list */
 130   ROLE_PAGE_TAB,
 131   /*
 132    * An object that presents a series of panels (or page tabs), one at a time,
 133    * through some mechanism provided by the object.
 134    */
 135   ROLE_PAGE_TAB_LIST,
 136   /* A generic container that is often used to group objects. */
 137   ROLE_PANEL,
 138   /*
 139    * A text object uses for passwords, or other places where the text
 140    * content is not shown visibly to the user.
 141    */
 142   ROLE_PASSWORD_TEXT,
 143   /*
 144    * A temporary window that is usually used to offer the user a list of
 145    * choices, and then hides when the user selects one of those choices.
 146    */
 147   ROLE_POPUP_MENU,
 148   /* An object used to indicate how much of a task has been completed. */
 149   ROLE_PROGRESS_BAR,
 150   /*
 151    * An object the user can manipulate to tell the application to do
 152    * something.
 153    */
 154   ROLE_PUSH_BUTTON,
 155   /*
 156    * A specialized check box that will cause other radio buttons in the
 157    * same group to become uncghecked when this one is checked.
 158    */
 159   ROLE_RADIO_BUTTON,
 160   /* Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON) */
 161   ROLE_RADIO_MENU_ITEM,
 162   /*
 163    * A specialized pane that has a glass pane and a layered pane as its
 164    * children.
 165    */
 166   ROLE_ROOT_PANE,
 167   /* The header for a row of data */
 168   ROLE_ROW_HEADER,
 169   /*
 170    * An object usually used to allow a user to incrementally view a large
 171    * amount of data.
 172    */
 173   ROLE_SCROLL_BAR,
 174   /*
 175    * An object that allows a user to incrementally view a large amount
 176    * of information.
 177    */
 178   ROLE_SCROLL_PANE,
 179   /*
 180    * An object usually contained in a menu to provide a visible and
 181    * logical separation of the contents in a menu.
 182    */
 183   ROLE_SEPARATOR,
 184   /* An object that allows the user to select from a bounded range */
 185   ROLE_SLIDER,
 186   /*
 187    * An object which allows one of a set of choices to be selected,
 188    * and which displays the current choice.
 189    */
 190   ROLE_SPIN_BUTTON,
 191   /* A specialized panel that presents two other panels at the same time. */
 192   ROLE_SPLIT_PANE,
 193   /* Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR) */
 194   ROLE_STATUS_BAR,
 195   /* An object used to repesent information in terms of rows and columns. */
 196   ROLE_TABLE,
 197   ROLE_TABLE_CELL,
 198   ROLE_TABLE_COLUMN_HEADER,
 199   ROLE_TABLE_ROW_HEADER,
 200   /* Object allows menu to be removed from menubar and shown in its own window. */
 201   ROLE_TEAROFF_MENU_ITEM,
 202   /* An object that presents text to the user */
 203   ROLE_TEXT,
 204   /*
 205    * A specialized push button that can be checked or unchecked, but does
 206    * not procide a separate indicator for the current state.
 207    */
 208   ROLE_TOGGLE_BUTTON,
 209   /*
 210    * A bar or palette usually composed of push buttons or toggle buttons
 211    */
 212   ROLE_TOOL_BAR,
 213   /*
 214    * An object that provides information about another object
 215    */
 216   ROLE_TOOL_TIP,
 217   /* An object used to repsent hierarchical information to the user. */
 218   ROLE_TREE,
 219   /*
 220    * The object contains some Accessible information, but its role is
 221    * not known.
 222    */
 223   ROLE_UNKNOWN,
 224   /* An object usually used in a scroll pane. */
 225   ROLE_VIEWPORT,
 226   /* A top level window with no title or border */
 227   ROLE_WINDOW,
 228   /*
 229    * means that the role for this item is known, but not included in the
 230    * core enumeration
 231    */
 232   ROLE_EXTENDED,
 233   /* not a valid role, used for finding end of enumeration. */
 234   ROLE_LAST_DEFINED
 235   };
 236 };
 237
 238 #endif