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