1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
4 <tp:enum name="LOCALE_TYPE" type="u">
6 Used by Text and Document interfaces these correspond to the POSIX 'setlocale' enum values.
8 <tp:enumvalue suffix="LOCALE_TYPE_MESSAGES"/>
9 <tp:enumvalue suffix="LOCALE_TYPE_COLLATE" value="1"/>
10 <tp:enumvalue suffix="LOCALE_TYPE_CTYPE" value="2"/>
11 <tp:enumvalue suffix="LOCALE_TYPE_MONETARY" value="3"/>
12 <tp:enumvalue suffix="LOCALE_TYPE_NUMERIC" value="4"/>
13 <tp:enumvalue suffix="LOCALE_TYPE_TIME" value="5"/>
16 <tp:enum name="COORD_TYPE" type="u">
18 Used by Component, Image, and Text interfaces to specify whether coordinates are relative to the window or the screen.
20 <tp:enumvalue suffix="COORD_TYPE_SCREEN"/>
21 <tp:enumvalue suffix="COORD_TYPE_WINDOW" value="1"/>
24 <tp:struct name="BoundingBox">
25 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
26 Used by Component and Text interfaces, a struct defining a bounding rectangle.
27 The relevant coordinate system is determined by the context of the
28 API call which returned or receives the value.
30 <tp:member type="i" tp:name="x">
32 The value corresponding to the minimum or leftmost x position.
35 <tp:member type="i" tp:name="y">
37 The value corresponding to the minimum y value.
40 <tp:member type="i" tp:name="width">
41 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
42 The horizontal extent of the bounding box,
43 that is, the difference between the maximum and minimum
47 <tp:member type="i" tp:name="height">
48 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
49 The vertical extent of the bounding box,
50 that is, the difference between the maximum and minimum
55 <interface name="org.freedesktop.atspi.Accessible">
56 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
57 <p>The base interface which is implemented by all accessible objects.
58 All objects support interfaces for querying their contained 'children'
59 and position in the accessible-object hierarchy, whether or not they
60 actually have children. </p>
62 <p>Events that may be emitted by instances of Accessible include:
63 "object:property-change" A base (strongly-typed) object attribute has changed,
64 for instance "object:property-change:accessible-name".
65 Notifed property subtypes include accessible-name, accessible-description,
66 accessible-parent and accessible-role.</p>
68 <p>"object:children-changed" The number or identity of an object's children
71 "object:state-changed" The object's StateSet has had a state added
74 "object:active-descendant-changed" If the object includes
75 STATE_MANAGES_DESCENDANTS, this event is fired to indicate that the
76 descendant having STATE_ACTIVE has changed; this corresponds to
77 "micro" keyboard focus when the containing/emitting object has
78 "macro" or technical keyboard focus. For instance, this event is
79 usually emitted while traversing tables and/or spreadsheet cells.
81 "object:attribute-change" A weakly-typed property, as contained in the
82 AttributeSet returned by Accessible::GetAttributes, has changed in value,
83 been added, or been removed from the object.
84 ("object:attribute-change" notifications were added in AT-SPI 1.7.0)</p>
87 <tp:property name="name" type="s" access="readwrite">
89 A (short) string representing the object's name.
92 <tp:property name="description" type="s" access="readwrite">
94 A string describing the object in more detail than name.
97 <tp:property name="parent" type="o" access="read">
99 The Accessible object which is this object's containing object.
102 <tp:property name="childCount" type="i" access="read">
104 The number of children contained by this object.
107 <method name="GetChildAtIndex">
109 Get the accessible child of this object at \c index.
111 <arg direction="in" name="index" type="i">
113 an in parameter indicating which child is requested (zero-indexed).
116 <arg direction="out" type="o" tp:type="Accessible">
118 the 'nth' ::Accessible child of this object.
122 <method name="GetIndexInParent">
124 Get the index of this object in its parent's child list.
126 <arg direction="out" type="i">
128 A long integer indicating this object's index in the parent's list.
132 <method name="GetRelationSet">
134 Get a set defining this object's relationship to other accessible objects.
136 <arg direction="out" type="a(uao)" tp:type="RelationSet">
138 A RelationSet defining this object's relationships.
142 <method name="GetRole">
143 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
144 Get the Role indicating the type of UI role played by this object.
146 <arg direction="out" type="u" tp:type="Role">
148 A Role indicating the type of UI role played by this object.
152 <method name="GetRoleName">
153 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
154 Get a string indicating the type of UI role played by this object.
156 <arg direction="out" type="s">
158 A UTF-8 string indicating the type of UI role played by this object.
162 <method name="GetLocalizedRoleName">
163 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
164 Get a string indicating the type of UI role played by this object,
165 translated to the current locale.
167 <arg direction="out" type="s">
169 A UTF-8 string indicating the type of UI role played by this object.
173 <method name="GetState">
175 Get the current state of the object as a StateSet.
177 <arg direction="out" type="au" tp:type="StateSet">
179 A StateSet encapsulating the currently true states of the object.
180 Returns an array of (currently two) 32-bit integers giving bitwise flags.
184 <method name="GetAttributes">
185 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
186 <p>Get a list of properties applied to this object as a whole, as an
187 AttributeSet consisting of name-value pairs. As such these attributes
188 may be considered weakly-typed properties or annotations, as distinct
189 from the strongly-typed interface instance data declared using the IDL
190 "attribute" keyword.</p>
192 <p>Not all objects have explicit "name-value pair" AttributeSet properties. </p>
194 <p>Attribute names and values may have any UTF-8 string value, however where possible,
195 in order to facilitate consistent use and exposure of "attribute" properties by
196 applications and AT clients, attribute names and values should chosen from
197 a publicly-specified namespace where appropriate.</p>
199 <p>Where possible, the names and values in the name-value pairs
200 should be chosen from well-established attribute namespaces
201 using standard semantics.
202 For example, attributes of Accessible objects corresponding to XHTML content
203 elements should correspond to attribute names and values specified in the w3c
204 XHTML specification, at http://www.w3.org/TR/xhtml2, where such values are not
205 already exposed via a more strongly-typed aspect of the AT-SPI API.
207 values should be chosen from the 'Dublin Core' Metadata
208 namespace using Dublin Core semantics:
209 http://dublincore.org/dcregistry/
210 Similarly, relevant structural metadata should be exposed
211 using attribute names and values chosen from the CSS2 and WICD specification:
212 http://www.w3.org/TR/1998/REC-CSS2-19980512
213 WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). </p>
215 <p>Clients seeking semantic or typographical attributes associated with
216 specific character spans of text content should use Text.GetAttributeRun instead.
217 The attributes returned by Accessible.GetAttributes do not include
218 "text attributes". (See Text.GetAttributeRun)</p>
221 <arg direction="out" type="{ss}" tp:type="AttributeSet">
223 An AttributeSet encapsulating any "attribute values" currently defined for the object.
227 <method name="GetApplication">
228 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
229 <p>Get the containing Application for this object.</p>
231 <arg direction="out" type="o" tp:type="Application">
233 The Application instance to which this object belongs.