xml/Accessibility_Application.xml

   1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   2
   3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
   4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
   5 <tp:copyright>Copyright 2001-2004 Sun Microsystems Inc.</tp:copyright>
   6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
   7   <p>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.</p>
  11
  12   <p>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.</p>
  16
  17   <p>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.</p>
  21 </tp:license>
  22 <interface name="org.freedesktop.accessibility.Application">
  23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24     <p>An interface identifying an object which is the root of the
  25       user interface Accessible hierarchy associated with a running application.
  26       Children of Application are typically, but not exclusively,
  27       top-level windows.
  28       @note It is possible for an element deeper in an Accessibility stack to
  29       implement Application, for instance in the case of &quot;embedded applications&quot;
  30       which draw into toplevel windows associated with other applications
  31       from the user's point of view.</p>
  32   </tp:docstring>
  33   <tp:property name="toolkitName" type="s" access="read">
  34   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  35     <p>A string indicating the type of user interface toolkit
  36       which is used by the application.
  37       @note Ordinarily clients of ::Application should be
  38       toolkit-agnostic, dependencies on this property should
  39       be avoided where possible.</p>
  40   </tp:docstring>
  41   </tp:property>
  42   <tp:property name="version" type="s" access="read">
  43   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  44     <p>A string indicating the version number of the application's
  45       accessibility bridge implementation.</p>
  46   </tp:docstring>
  47   </tp:property>
  48   <tp:property name="id" type="i" access="readwrite">
  49   <tp:docstring>
  50     The application instance's unique ID as assigned by the registry.
  51   </tp:docstring>
  52   </tp:property>
  53   <method name="registerToolkitEventListener">
  54     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  55     <tp:docstring>
  56       an ::EventListener object which will receive the requestedevents from the application's toolkits via toolit 'bridges'
  57     </tp:docstring>
  58     </arg>
  59     <arg direction="in" name="eventName" type="s">
  60     <tp:docstring>
  61       a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested.  Not all applications can generate toolkit events ofa given type.Register with this application's toolkit for &quot;toolkit-specific&quot; event notifications.@noteFor most event support, clients should use non-toolkit-specific eventswhenever possible, via ::Registry::registerGlobalEventListener - this method is provided as a 'back door' when generic names do not exist for the events in question.
  62     </tp:docstring>
  63     </arg>
  64   </method>
  65   <method name="registerObjectEventListener">
  66     <tp:docstring>
  67       registerObjectEventListener:
  68     </tp:docstring>
  69     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  70     <tp:docstring>
  71       an ::EventListener object which will receive the requestedevents
  72     </tp:docstring>
  73     </arg>
  74     <arg direction="in" name="eventName" type="s">
  75     <tp:docstring>
  76       a UTF-8 string indicating the type of (toolkit-specific) eventbeing requested.  Register with this application toolkit for &quot;Accessibility::Accessible&quot; event notifications. @note: SUBJECT TO DEPRECATION.
  77     </tp:docstring>
  78     </arg>
  79   </method>
  80   <method name="pause">
  81     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  82       <p>Request that the application temporarily stop sending events.
  83         In most cases this should pause the application's main event loop.    </p>
  84     </tp:docstring>
  85     <arg direction="out" type="b" tp:type="boolean">
  86     <tp:docstring>
  87       \c true if the request succeeded, \c false otherwise.@note: This method is not implemented in most toolkits, and therefore should be treated with caution.
  88     </tp:docstring>
  89     </arg>
  90   </method>
  91   <method name="resume">
  92     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  93       <p>Request that the application resume sending events.    </p>
  94     </tp:docstring>
  95     <arg direction="out" type="b" tp:type="boolean">
  96     <tp:docstring>
  97       \c True if the request succeeded, \c False otherwise.
  98     </tp:docstring>
  99     </arg>
 100   </method>
 101   <method name="getLocale">
 102     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 103       <p>Gets the locale in which the application is currently operating.
 104         For the current message locale, use \a lctype LOCALE_TYPE_MESSAGES.    </p>
 105
 106       <p>@param lctype The LocaleType for which the locale is queried.</p>
 107     </tp:docstring>
 108     <arg direction="in" name="lctype" type="u" tp:type="LOCALE_TYPE"/>
 109     <arg direction="out" type="s">
 110     <tp:docstring>
 111       a string compliant with the POSIX standard for locale description.
 112     </tp:docstring>
 113     </arg>
 114   </method>
 115   <method name="unImplemented_">
 116     <tp:docstring>
 117       \cond (This comment tells doxygen not to document these)
 118     </tp:docstring>
 119   </method>
 120   <method name="unImplemented2_">
 121   </method>
 122   <method name="unImplemented3_">
 123   </method>
 124 </interface>
 125 </node>