2003-04-24 Padraig O'Briain <padraig.obriain@sun.com>

[platform/core/uifw/at-spi2-atk.git] / cspi / spi-roletypes.h

diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h
index 1bd7664..3e9582d 100644 (file)
--- a/cspi/spi-roletypes.h
+++ b/cspi/spi-roletypes.h
@@ -1,3 +1,26 @@
+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
 #ifndef _SPI_ROLETYPES_H_
 #define _SPI_ROLETYPES_H_
 
@@ -8,7 +31,7 @@ extern "C" {
 /**
  * AccessibleRole:
  * @SPI_ROLE_INVALID: role is not legal, something is wrong with this object
- * @SPI_ROLE_ACCELERATOR_LABEL: object is a label indicating keyboard
+ * @SPI_ROLE_ACCEL_LABEL: object is a label indicating keyboard
  *                              accelerators for the parent
  * @SPI_ROLE_ALERT: Object is used to alert the user about something
  * @SPI_ROLE_ANIMATION: Object contains a dynamic or moving image
@@ -30,11 +53,11 @@ extern "C" {
  * @SPI_ROLE_DIALOG: A top level window with title bar and a border
  * @SPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate
  *              through and select the contents of a directory.
+ * @SPI_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
  * @SPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in the
  *               directory and lets the user select a file, browse a different
  *              directory, or specify a filename.
  * @SPI_ROLE_FILLER: A object that fills up space in a user interface
- * @SPI_ROLE_FOCUS_TRAVERSABLE: XXX Not sure about this.
  * @SPI_ROLE_FONT_CHOOSER: Allows selection of a display font
  * @SPI_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  * @SPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all
@@ -70,6 +93,8 @@ extern "C" {
  *        the application to do something.
  * @SPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the
  *        same group to become uncghecked when this one is checked.
+ * @SPI_ROLE_RADIO_MENU_ITEM: A specialized menu item that behaves like a 
+ *        radio button.
  * @SPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its
  *        children.
  * @SPI_ROLE_ROW_HEADER: The header for a row of data
@@ -106,6 +131,14 @@ extern "C" {
  * @SPI_ROLE_WINDOW: A top level window with no title or border.
  * @SPI_ROLE_EXTENDED: This object's role is not included in the standard role list and
  *                     should be queried by name.
+ * @SPI_ROLE_HEADER: An object that serves as a document header.
+ * @SPI_ROLE_FOOTER: An object that serves as a document footer.
+ * @SPI_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.
+ * @SPI_ROLE_RULER: An object which describes margins and tab stops, etc.  for text objects 
+ *                  which it controls (should have CONTROLLER_FOR relation to such). 
+ * @SPI_ROLE_APPLICATION: An object which corresponds to a desktop application,
+ *                  which may have children of @SPI_ROLE_FRAME or other type.
+ * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration.
  **/
 typedef enum
 {
@@ -117,6 +150,7 @@ typedef enum
   SPI_ROLE_CALENDAR,
   SPI_ROLE_CANVAS,
   SPI_ROLE_CHECK_BOX,
+  SPI_ROLE_CHECK_MENU_ITEM,
   SPI_ROLE_COLOR_CHOOSER,
   SPI_ROLE_COLUMN_HEADER,
   SPI_ROLE_COMBO_BOX,
@@ -126,9 +160,9 @@ typedef enum
   SPI_ROLE_DIAL,
   SPI_ROLE_DIALOG,
   SPI_ROLE_DIRECTORY_PANE,
+  SPI_ROLE_DRAWING_AREA,
   SPI_ROLE_FILE_CHOOSER,
   SPI_ROLE_FILLER,
-  SPI_ROLE_FOCUS_TRAVERSABLE,
   SPI_ROLE_FONT_CHOOSER,
   SPI_ROLE_FRAME,
   SPI_ROLE_GLASS_PANE,
@@ -167,6 +201,7 @@ typedef enum
   SPI_ROLE_TABLE_COLUMN_HEADER,
   SPI_ROLE_TABLE_ROW_HEADER,
   SPI_ROLE_TEAROFF_MENU_ITEM,
+  SPI_ROLE_TERMINAL,
   SPI_ROLE_TEXT,
   SPI_ROLE_TOGGLE_BUTTON,
   SPI_ROLE_TOOL_BAR,
@@ -177,6 +212,11 @@ typedef enum
   SPI_ROLE_VIEWPORT,
   SPI_ROLE_WINDOW,
   SPI_ROLE_EXTENDED,
+  SPI_ROLE_HEADER,
+  SPI_ROLE_FOOTER,
+  SPI_ROLE_PARAGRAPH,
+  SPI_ROLE_RULER,
+  SPI_ROLE_APPLICATION,
   SPI_ROLE_LAST_DEFINED
 } AccessibleRole;