idl/Accessibility.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001-2005 Ximian, Inc. and 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_IDL_
  24 #define _ACCESSIBILITY_IDL_
  25
  26 #ifndef  __ACCESSIBILITY_COMPILATION__
  27 #ifdef   __ORBIT_IDL__
  28 %{
  29 #pragma include_defs Accessibility.h
  30 %}
  31 #pragma inhibit push
  32 #endif
  33 #endif
  34
  35 #ifndef _BONOBO_IDL_INCLUDED_
  36 #ifdef __ORBIT_IDL__
  37 %{
  38 #pragma include_defs bonobo/Bonobo.h
  39 %}
  40 #pragma inhibit push
  41 #endif
  42 #include <Bonobo_Unknown.idl>
  43 #ifdef __ORBIT_IDL__
  44 #pragma inhibit pop
  45 #endif
  46
  47 #define _BONOBO_IDL_INCLUDED_
  48 #include <Bonobo_Unknown.idl>
  49 #endif /* _BONOBO_IDL_INCLUDED_ */
  50
  51 /*!\mainpage AT-SPI Interfaces and Subinterfaces
  52  *
  53  * This is the main documentation page for the
  54  * Assistive Technology Service Provider Interface (AT-SPI).
  55  *
  56  * \section apps Applications and Interface Components
  57  * Namespace Accessibility includes service APIs implemented by
  58  * participating applications and their user interface components:\n\n
  59  * Accessibility::Accessible\n
  60  * Accessibility::Application\n
  61  * Accessibility::Desktop\n
  62  * Accessibility::Component\n
  63  * Accessibility::Hypertext\n
  64  * Accessibility::Image\n
  65  * Accessibility::Selection\n
  66  * Accessibility::StreamableContent\n
  67  * Accessibility::Table\n
  68  * Accessibility::Text\n
  69  * Accessibility::EditableText\n
  70  * Accessibility::Value
  71  *
  72  * \section types Enumerated Types
  73  * Accessibility defines a number of key enumerated types, including:\n\n
  74  * Accessibility::RelationType\n
  75  * Accessibility::Role\n
  76  * Accessibility::StateType\n
  77  * Accessibility::Event\n
  78  * Accessibility::EventDetails \n
  79  *
  80  * \section Registry
  81  * Accessibility also includes Accessibility::Registry,
  82  * which is the service used by assistive technologies and related
  83  * AT-SPI clients to register interest in certain classes of events,
  84  * enumerate the currently available desktop and application list,
  85  * and to synthesize certain kinds of device events.
  86  *
  87  * \section listeners Event Listener Interfaces
  88  * Accessibility::EventListener\n
  89  * Accessibility::DeviceEventListener
  90  *
  91  * \section helpers Helper Interfaces
  92  *
  93  * The following interfaces may be implemented by assistive technologies
  94  * themselves, in order to export their services in a consistent manner or
  95  * in order to interoperate with other applications or desktop services.\n
  96  *
  97  * Accessibility::LoginHelper : Implemented by adaptive technologies which
  98  * need to participate in user-authentication or login activities, and which
  99  * therefore may need negotiation with authentication agents or processes.\n
 100  *
 101  * Accessibility::Selector [NEW]: Implemented by user agents or assistive
 102  * technologies which export lists of choices from which the end-user is
 103  * expected to make selections.  Useful for various types of remote
 104  * activation or intercommunication between multiple ATs.
 105  **/
 106
 107 #include <Bonobo_Unknown.idl>
 108
 109 /*
 110  * Accessibility interfaces and subinterfaces
 111  */
 112 #include <Accessibility_Accessible.idl>
 113 #include <Accessibility_Action.idl>
 114 #include <Accessibility_Component.idl>
 115 #include <Accessibility_Document.idl>
 116 #include <Accessibility_Hyperlink.idl>
 117 #include <Accessibility_Image.idl>
 118 #include <Accessibility_Selection.idl>
 119 #include <Accessibility_StreamableContent.idl>
 120 #include <Accessibility_Table.idl>
 121 #include <Accessibility_Text.idl>
 122 #include <Accessibility_Value.idl>
 123
 124 /*
 125  * Interfaces derived from Accessibility::Text
 126  */
 127
 128 #include <Accessibility_EditableText.idl>
 129 #include <Accessibility_Hypertext.idl>
 130
 131 /*
 132  * Utility interfaces and interfaces derived from Accessibility::Accessible
 133  */
 134
 135 #include <Accessibility_Relation.idl>
 136 #include <Accessibility_State.idl>
 137 #include <Accessibility_Application.idl>
 138 #include <Accessibility_Desktop.idl>
 139 #include <Accessibility_Event.idl>
 140 #include <Accessibility_Registry.idl>
 141 #include <Accessibility_Role.idl>
 142 #include <Accessibility_LoginHelper.idl>
 143 #include <Accessibility_Selector.idl>
 144
 145 #ifndef __ACCESSIBILITY_COMPILATION__
 146 #ifdef  __ORBIT_IDL__
 147 #pragma inhibit pop
 148 #endif
 149 #endif
 150
 151 #endif