xml/Accessibility.xml

   1 <tp:spec
   2   xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
   3   xmlns:xi="http://www.w3.org/2001/XInclude">
   4
   5 <tp:title>AT-SPI D-Bus Interface Specification</tp:title>
   6 <tp:version>1.24.0</tp:version>
   7
   8 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
   9 <tp:copyright>Copyright 2001-2005 Ximian, Inc. and Sun Microsystems, Inc.</tp:copyright>
  10 <tp:license xmlns="http://www.w3.org/1999/xhtml">
  11 <p>This library is free software; you can redistribute it and/or
  12 modify it under the terms of the GNU Library General Public
  13 License as published by the Free Software Foundation; either
  14 version 2 of the License, or (at your option) any later version.</p>
  15
  16 <p>This library is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 Library General Public License for more details.</p>
  20
  21 <p>You should have received a copy of the GNU Library General Public
  22 License along with this library; if not, write to the
  23 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 Boston, MA 02111-1307, USA.</p>
  25 </tp:license>
  26
  27 <tp:docstring>
  28  !\mainpage AT-SPI Interfaces and Subinterfaces
  29
  30   This is the main documentation page for the
  31   Assistive Technology Service Provider Interface (AT-SPI).
  32
  33   \section apps Applications and Interface Components
  34   Namespace Accessibility includes service APIs implemented by
  35   participating applications and their user interface components:\n\n
  36   Accessibility::Accessible\n
  37   Accessibility::Application\n
  38   Accessibility::Desktop\n
  39   Accessibility::Component\n
  40   Accessibility::Hypertext\n
  41   Accessibility::Image\n
  42   Accessibility::Selection\n
  43   Accessibility::StreamableContent\n
  44   Accessibility::Table\n
  45   Accessibility::Text\n
  46   Accessibility::EditableText\n
  47   Accessibility::Value
  48
  49   \section types Enumerated Types
  50   Accessibility defines a number of key enumerated types, including:\n\n
  51   Accessibility::RelationType\n
  52   Accessibility::Role\n
  53   Accessibility::StateType\n
  54   Accessibility::Event\n
  55   Accessibility::EventDetails \n
  56
  57   \section Registry
  58   Accessibility also includes Accessibility::Registry,
  59   which is the service used by assistive technologies and related
  60   AT-SPI clients to register interest in certain classes of events,
  61   enumerate the currently available desktop and application list,
  62   and to synthesize certain kinds of device events.
  63
  64   \section listeners Event Listener Interfaces
  65   Accessibility::EventListener\n
  66   Accessibility::DeviceEventListener
  67
  68   \section helpers Helper Interfaces
  69
  70   The following interfaces may be implemented by assistive technologies
  71   themselves, in order to export their services in a consistent manner or
  72   in order to interoperate with other applications or desktop services.\n
  73
  74   Accessibility::LoginHelper : Implemented by adaptive technologies which
  75   need to participate in user-authentication or login activities, and which
  76   therefore may need negotiation with authentication agents or processes.\n
  77
  78   Accessibility::Selector [NEW]: Implemented by user agents or assistive
  79   technologies which export lists of choices from which the end-user is
  80   expected to make selections.  Useful for various types of remote
  81   activation or intercommunication between multiple ATs.
  82 </tp:docstring>
  83
  84 <!-- Accessibility interfaces and subinterfaces -->
  85
  86 <xi:include href="org.freedesktop.atspi.Accessible.xml"/>
  87 <xi:include href="org.freedesktop.atspi.Action.xml"/>
  88 <xi:include href="org.freedesktop.atspi.Component.xml"/>
  89 <xi:include href="org.freedesktop.atspi.Document.xml"/>
  90 <xi:include href="org.freedesktop.atspi.Hyperlink.xml"/>
  91 <xi:include href="org.freedesktop.atspi.Image.xml"/>
  92 <xi:include href="org.freedesktop.atspi.Selection.xml"/>
  93 <xi:include href="org.freedesktop.atspi.StreamableContent.xml"/>
  94 <xi:include href="org.freedesktop.atspi.Table.xml"/>
  95 <xi:include href="org.freedesktop.atspi.Text.xml"/>
  96 <xi:include href="org.freedesktop.atspi.Tree.xml"/>
  97 <xi:include href="org.freedesktop.atspi.Value.xml"/>
  98
  99 <!-- Interfaces derived from Accessibility::Text -->
 100 <xi:include href="org.freedesktop.atspi.EditableText.xml"/>
 101 <xi:include href="org.freedesktop.atspi.Hypertext.xml"/>
 102 <xi:include href="Accessibility_State.xml"/>
 103
 104 <!-- Utility interfaces and interfaces derived from Accessibility::Accessible -->
 105
 106 <xi:include href="org.freedesktop.atspi.Application.xml"/>
 107 <xi:include href="Accessibility_Registry_Common.xml"/>
 108 <xi:include href="org.freedesktop.atspi.Registry.xml"/>
 109 <xi:include href="org.freedesktop.atspi.DeviceEventController.xml"/>
 110 <xi:include href="org.freedesktop.atspi.DeviceEventListener.xml"/>
 111 <xi:include href="Accessibility_Role.xml"/>
 112 <xi:include href="org.freedesktop.atspi.LoginHelper.xml"/>
 113 <xi:include href="org.freedesktop.atspi.Selector.xml"/>
 114 </tp:spec>