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