2009-06-11 Mark Doffman <mark.doffman@codethink.co.uk>

[platform/core/uifw/at-spi2-atk.git] / idl / Accessibility.idl

diff --git a/idl/Accessibility.idl b/idl/Accessibility.idl
index f858a87..2b9b08e 100644 (file)
--- a/idl/Accessibility.idl
+++ b/idl/Accessibility.idl
@@ -2,7 +2,7 @@
  * AT-SPI - Assistive Technology Service Provider Interface 
  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
  *
- * Copyright 2001 Ximian, Inc.
+ * Copyright 2001-2005 Ximian, Inc. and Sun Microsystems, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -23,48 +23,119 @@
 #ifndef _ACCESSIBILITY_IDL_
 #define _ACCESSIBILITY_IDL_
 
-#if !defined(__ACCESSIBILITY_COMPILATION__) && defined(__ORBIT_IDL__)
+#ifndef  __ACCESSIBILITY_COMPILATION__
+#ifdef   __ORBIT_IDL__
 %{
 #pragma include_defs Accessibility.h
 %}
 #pragma inhibit push
 #endif
+#endif
+
+#ifndef _BONOBO_IDL_INCLUDED_
+#define _BONOBO_IDL_INCLUDED_
+#include <Bonobo_Unknown.idl>
+#endif /* _BONOBO_IDL_INCLUDED_ */
+
+/*!\mainpage AT-SPI Interfaces and Subinterfaces
+ *
+ * This is the main documentation page for the 
+ * Assistive Technology Service Provider Interface (AT-SPI). 
+ * 
+ * \section apps Applications and Interface Components
+ * Namespace Accessibility includes service APIs implemented by
+ * participating applications and their user interface components:\n\n
+ * Accessibility::Accessible\n 
+ * Accessibility::Application\n
+ * Accessibility::Desktop\n
+ * Accessibility::Component\n
+ * Accessibility::Hypertext\n
+ * Accessibility::Image\n
+ * Accessibility::Selection\n
+ * Accessibility::StreamableContent\n
+ * Accessibility::Table\n
+ * Accessibility::Text\n
+ * Accessibility::EditableText\n
+ * Accessibility::Value
+ *
+ * \section types Enumerated Types
+ * Accessibility defines a number of key enumerated types, including:\n\n
+ * Accessibility::RelationType\n
+ * Accessibility::Role\n
+ * Accessibility::StateType\n
+ * Accessibility::Event\n
+ * Accessibility::EventDetails \n
+ *
+ * \section Registry
+ * Accessibility also includes Accessibility::Registry,
+ * which is the service used by assistive technologies and related
+ * AT-SPI clients to register interest in certain classes of events,
+ * enumerate the currently available desktop and application list,
+ * and to synthesize certain kinds of device events.
+ *
+ * \section listeners Event Listener Interfaces
+ * Accessibility::EventListener\n
+ * Accessibility::DeviceEventListener
+ *
+ * \section helpers Helper Interfaces
+ *
+ * The following interfaces may be implemented by assistive technologies 
+ * themselves, in order to export their services in a consistent manner or
+ * in order to interoperate with other applications or desktop services.\n
+ *
+ * Accessibility::LoginHelper : Implemented by adaptive technologies which 
+ * need to participate in user-authentication or login activities, and which
+ * therefore may need negotiation with authentication agents or processes.\n
+ *
+ * Accessibility::Selector [NEW]: Implemented by user agents or assistive 
+ * technologies which export lists of choices from which the end-user is 
+ * expected to make selections.  Useful for various types of remote
+ * activation or intercommunication between multiple ATs.
+ **/
+
+#include <Bonobo_Unknown.idl>
 
 /*
  * Accessibility interfaces and subinterfaces
  */
-#include <Accessible.idl>
-#include <Action.idl>
-#include <Component.idl>
-#include <Hyperlink.idl>
-#include <Image.idl>
-#include <Selection.idl>
-#include <StreamableContent.idl>
-#include <Table.idl>
-#include <Text.idl>
-#include <Value.idl>
+#include <Accessibility_Accessible.idl>
+#include <Accessibility_Action.idl>
+#include <Accessibility_Collection.idl>
+#include <Accessibility_Component.idl>
+#include <Accessibility_Document.idl>
+#include <Accessibility_Hyperlink.idl>
+#include <Accessibility_Image.idl>
+#include <Accessibility_Selection.idl>
+#include <Accessibility_StreamableContent.idl>
+#include <Accessibility_Table.idl>
+#include <Accessibility_Text.idl>
+#include <Accessibility_Value.idl>
 
 /*
  * Interfaces derived from Accessibility::Text
  */
 
-#include <EditableText.idl>
-#include <Hypertext.idl>
+#include <Accessibility_EditableText.idl>
+#include <Accessibility_Hypertext.idl>
 
 /*
  * Utility interfaces and interfaces derived from Accessibility::Accessible
  */
 
-#include <Relation.idl>
-#include <State.idl>
-#include <Application.idl>
-#include <Desktop.idl>
-#include <Event.idl>
-#include <Registry.idl>
-#include <Role.idl>
+#include <Accessibility_Relation.idl>
+#include <Accessibility_State.idl>
+#include <Accessibility_Application.idl>
+#include <Accessibility_Desktop.idl>
+#include <Accessibility_Event.idl>
+#include <Accessibility_Registry.idl>
+#include <Accessibility_Role.idl>
+#include <Accessibility_LoginHelper.idl>
+#include <Accessibility_Selector.idl>
 
-#if !defined(__ACCESSIBILITY_COMPILATION__) && defined(__ORBIT_IDL__)
+#ifndef __ACCESSIBILITY_COMPILATION__
+#ifdef  __ORBIT_IDL__
 #pragma inhibit pop
 #endif
+#endif
 
 #endif