xml/Accessibility.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <tp:spec xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" xmlns:xi="http://www.w3.org/2001/XInclude">
   3
   4
   5 <tp:version>1.24.0</tp:version>
   6
   7
   8
   9
  10
  11 <tp:docstring>
  12  !\mainpage AT-SPI Interfaces and Subinterfaces
  13
  14   This is the main documentation page for the
  15   Assistive Technology Service Provider Interface (AT-SPI).
  16
  17   \section apps Applications and Interface Components
  18   Namespace Accessibility includes service APIs implemented by
  19   participating applications and their user interface components:\n\n
  20   Accessibility::Accessible\n
  21   Accessibility::Application\n
  22   Accessibility::Desktop\n
  23   Accessibility::Collecgtion\n
  24   Accessibility::Component\n
  25   Accessibility::Hypertext\n
  26   Accessibility::Image\n
  27   Accessibility::Selection\n
  28   Accessibility::StreamableContent\n
  29   Accessibility::Table\n
  30   Accessibility::Text\n
  31   Accessibility::EditableText\n
  32   Accessibility::Value
  33
  34   \section types Enumerated Types
  35   Accessibility defines a number of key enumerated types, including:\n\n
  36   Accessibility::RelationType\n
  37   Accessibility::Role\n
  38   Accessibility::StateType\n
  39   Accessibility::Event\n
  40   Accessibility::EventDetails \n
  41
  42   \section Registry
  43   Accessibility also includes Accessibility::Registry,
  44   which is the service used by assistive technologies and related
  45   AT-SPI clients to register interest in certain classes of events,
  46   enumerate the currently available desktop and application list,
  47   and to synthesize certain kinds of device events.
  48
  49   \section listeners Event Listener Interfaces
  50   Accessibility::EventListener\n
  51   Accessibility::DeviceEventListener
  52
  53   \section helpers Helper Interfaces
  54
  55   The following interfaces may be implemented by assistive technologies
  56   themselves, in order to export their services in a consistent manner or
  57   in order to interoperate with other applications or desktop services.\n
  58
  59   Accessibility::LoginHelper : Implemented by adaptive technologies which
  60   need to participate in user-authentication or login activities, and which
  61   therefore may need negotiation with authentication agents or processes.\n
  62
  63   Accessibility::Selector [NEW]: Implemented by user agents or assistive
  64   technologies which export lists of choices from which the end-user is
  65   expected to make selections.  Useful for various types of remote
  66   activation or intercommunication between multiple ATs.
  67 </tp:docstring>
  68
  69 <!-- Accessibility interfaces and subinterfaces -->
  70
  71 <xi:include href="org.freedesktop.atspi.Accessible.xml"/>
  72 <xi:include href="org.freedesktop.atspi.Action.xml"/>
  73 <xi:include href="org.freedesktop.atspi.Collection.xml"/>
  74 <xi:include href="org.freedesktop.atspi.Component.xml"/>
  75 <xi:include href="org.freedesktop.atspi.Document.xml"/>
  76 <xi:include href="org.freedesktop.atspi.Hyperlink.xml"/>
  77 <xi:include href="org.freedesktop.atspi.Image.xml"/>
  78 <xi:include href="org.freedesktop.atspi.Selection.xml"/>
  79 <xi:include href="org.freedesktop.atspi.StreamableContent.xml"/>
  80 <xi:include href="org.freedesktop.atspi.Table.xml"/>
  81 <xi:include href="org.freedesktop.atspi.Text.xml"/>
  82 <xi:include href="org.freedesktop.atspi.Tree.xml"/>
  83 <xi:include href="org.freedesktop.atspi.Value.xml"/>
  84
  85 <!-- Interfaces derived from Accessibility::Text -->
  86 <xi:include href="org.freedesktop.atspi.EditableText.xml"/>
  87 <xi:include href="org.freedesktop.atspi.Hypertext.xml"/>
  88 <xi:include href="org.freedesktop.atspi.State.xml"/>
  89
  90 <!-- Utility interfaces and interfaces derived from Accessibility::Accessible -->
  91
  92 <xi:include href="org.freedesktop.atspi.Application.xml"/>
  93 <xi:include href="org.freedesktop.atspi.Registry.xml"/>
  94 <xi:include href="org.freedesktop.atspi.Registry.Common.xml"/>
  95 <xi:include href="org.freedesktop.atspi.Event.xml"/>
  96 <xi:include href="org.freedesktop.atspi.Desktop.xml"/>
  97 <xi:include href="org.freedesktop.atspi.DeviceEventController.xml"/>
  98 <xi:include href="org.freedesktop.atspi.DeviceEventListener.xml"/>
  99 <xi:include href="org.freedesktop.atspi.Relation.xml"/>
 100 <xi:include href="org.freedesktop.atspi.Role.xml"/>
 101 <xi:include href="org.freedesktop.atspi.LoginHelper.xml"/>
 102 <xi:include href="org.freedesktop.atspi.Selector.xml"/>
 103 </tp:spec>