2009-06-11 Mark Doffman <mark.doffman@codethink.co.uk>
[platform/core/uifw/at-spi2-atk.git] / xml / org.freedesktop.atspi.Document.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.Document">
4   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
5     <p>Primarily a 'tagging' interface which indicates the start of 
6       document content in the Accessibility hierarchy.  
7       Accessible objects below the node implementing
8       Document are normally assumed to be part of the document content.
9       Attributes of Document are those attributes associated with the document 
10       as a whole.  Objects that implement Document are normally expected to
11       implement Collection as well.  </p>
12   </tp:docstring>
13   <method name="getLocale">
14     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
15       <p>Gets the locale associated with the document's content.
16         e.g. the locale for LOCALE_TYPE_MESSAGES.    </p>
17     </tp:docstring>
18     <arg direction="out" type="s">
19     <tp:docstring>
20       A string compliant with the POSIX standard for locale description.
21     </tp:docstring>
22     </arg>
23   </method>
24   <method name="getAttributeValue">
25     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
26       <p>Gets the value of a single attribute, if specified for the document as a whole.    </p>
27     </tp:docstring>
28     <arg direction="in" name="attributename" type="s">
29     <tp:docstring>
30       A string indicating the name of a specific attribute (name-value pair) being queried.
31     </tp:docstring>
32     </arg>
33     <arg direction="out" type="s">
34     <tp:docstring>
35       A string corresponding to the value of the specified attribute, oran empty string if the attribute is unspecified for the object.
36     </tp:docstring>
37     </arg>
38   </method>
39   <method name="getAttributes">
40     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
41       <p>Gets all attributes specified for a document as a whole.  
42         For attributes which change within 
43         the document content, see Text.getAttributes instead.    </p>
44     </tp:docstring>
45     <arg direction="out" type="{ss}" tp:type="AttributeSet">
46     <tp:docstring>
47       A list of strings containing the attributes of the document, as name-value pairs.
48     </tp:docstring>
49     </arg>
50   </method>
51 </interface>
52 </node>