2009-06-11 Mark Doffman <mark.doffman@codethink.co.uk>
[platform/core/uifw/at-spi2-atk.git] / 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   <method name="getLocale">
31     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
32       <p>Gets the locale in which the application is currently operating.
33         For the current message locale, use \a lctype LOCALE_TYPE_MESSAGES.    </p>
34
35     </tp:docstring>
36     <arg direction="in" name="lctype" type="u" tp:type="LOCALE_TYPE">
37     <tp:docstring>
38       <p>The LocaleType for which the locale is queried.</p>
39     </tp:docstring>
40     </arg>
41     <arg direction="out" type="s">
42     <tp:docstring>
43       A string compliant with the POSIX standard for locale description.
44     </tp:docstring>
45     </arg>
46   </method>
47 </interface>
48 </node>