xml/org.freedesktop.atspi.Application.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3 <interface name="org.freedesktop.atspi.Application">
   4   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
   5     <p>An interface identifying an object which is the root of the
   6       user interface Accessible hierarchy associated with a running application.
   7       Children of Application are typically, but not exclusively,
   8       top-level windows.</p>
   9
  10     <p>It is possible for an element deeper in an Accessibility stack to
  11       implement Application, for instance in the case of "embedded applications"
  12       which draw into toplevel windows associated with other applications
  13       from the user's point of view.</p>
  14   </tp:docstring>
  15   <tp:property name="toolkitName" type="s" access="read">
  16   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  17     <p>A string indicating the type of user interface toolkit
  18        which is used by the application.</p>
  19       <p>Ordinarily clients of the Application should be
  20       toolkit-agnostic, dependencies on this property should
  21       be avoided where possible.</p>
  22   </tp:docstring>
  23   </tp:property>
  24   <tp:property name="version" type="s" access="read">
  25   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  26     <p>A string indicating the version number of the application's
  27       accessibility bridge implementation.</p>
  28   </tp:docstring>
  29   </tp:property>
  30   <tp:property name="id" type="i" access="readwrite">
  31   <tp:docstring>
  32     The application instance's unique ID as assigned by the registry.
  33   </tp:docstring>
  34   </tp:property>
  35   <method name="registerToolkitEventListener">
  36     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  37     <tp:docstring>
  38       An EventListener object which will receive the requestedevents from the application's toolkits via toolit 'bridges'
  39     </tp:docstring>
  40     </arg>
  41     <arg direction="in" name="eventName" type="s">
  42     <tp:docstring>
  43             <p> A UTF-8 string indicating the type of (toolkit-specific) eventbeing requested.  Not all applications can generate toolkit events of a given type. Register with this application's toolkit for "toolkit-specific" event notifications.</p>
  44
  45             <p>For most event support, clients should use non-toolkit-specific events whenever possible, Registry.registerGlobalEventListener - this method is provided as a 'back door' when generic names do not exist for the events in question.</p>
  46     </tp:docstring>
  47     </arg>
  48   </method>
  49   <method name="registerObjectEventListener">
  50     <arg direction="in" name="listener" type="o" tp:type="EventListener">
  51     <tp:docstring>
  52       An EventListener object which will receive the requested events
  53     </tp:docstring>
  54     </arg>
  55     <arg direction="in" name="eventName" type="s">
  56     <tp:docstring>
  57       A UTF-8 string indicating the type of (toolkit-specific) event being requested. Register with this application toolkit for "Accessibility.Accessible" event notifications. DEPRECATED
  58     </tp:docstring>
  59     </arg>
  60   </method>
  61   <method name="pause">
  62     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  63       <p>Request that the application temporarily stop sending events.
  64         In most cases this should pause the application's main event loop.</p>
  65     </tp:docstring>
  66     <arg direction="out" type="b" tp:type="boolean">
  67         <tp:docstring>
  68             <p>True if the request succeeded, false otherwise.</p>
  69
  70         <p>This method is not implemented in most toolkits, and therefore should be treated with caution.</p>
  71         </tp:docstring>
  72     </arg>
  73   </method>
  74   <method name="resume">
  75     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  76       <p>Request that the application resume sending events.</p>
  77     </tp:docstring>
  78     <arg direction="out" type="b" tp:type="boolean">
  79     <tp:docstring>
  80       True if the request succeeded, False otherwise.
  81     </tp:docstring>
  82     </arg>
  83   </method>
  84   <method name="getLocale">
  85     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  86       <p>Gets the locale in which the application is currently operating.
  87         For the current message locale, use \a lctype LOCALE_TYPE_MESSAGES.    </p>
  88
  89     </tp:docstring>
  90     <arg direction="in" name="lctype" type="u" tp:type="LOCALE_TYPE">
  91     <tp:docstring>
  92       <p>The LocaleType for which the locale is queried.</p>
  93     </tp:docstring>
  94     </arg>
  95     <arg direction="out" type="s">
  96     <tp:docstring>
  97       A string compliant with the POSIX standard for locale description.
  98     </tp:docstring>
  99     </arg>
 100   </method>
 101 </interface>
 102 </node>