2003-12-01 Bill Haneman <billh@gnome.org>

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

diff --git a/cspi/spi-roletypes.h b/cspi/spi-roletypes.h
index 8cae974..c3b5a1f 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_
 
@@ -108,7 +131,25 @@ 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_AUTOCOMPLETE: The object is a dialog or list containing items for 
+ *                         insertion into an entry widget, for instance a list 
+ *                          of words for completion of a text entry.
+ * @SPI_ROLE_EDITBAR: The object is an editable text object in a toolbar
+
  * @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration.
+ *
+ * Describes the role of an object
+ *
+ * These are the built-in enumerated roles that UI components can have.
+ * Other roles may be added at runtime, so an AccessibleRole >=
+ * SPI_ROLE_LAST_DEFINED is not necessarily an error.
  **/
 typedef enum
 {
@@ -182,6 +223,13 @@ 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_AUTOCOMPLETE,
+  SPI_ROLE_EDITBAR,
   SPI_ROLE_LAST_DEFINED
 } AccessibleRole;