1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
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 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>
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>
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>
22 <tp:enum name="StateType" type="u">
23 <tp:enumvalue suffix="STATE_INVALID"/>
24 <tp:enumvalue suffix="STATE_ACTIVE" value="1">
26 Indicates a window is currently the active window, or is an active subelement within a container or table
29 <tp:enumvalue suffix="STATE_ARMED" value="2">
31 Indicates that the object is armed
34 <tp:enumvalue suffix="STATE_BUSY" value="3">
35 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
36 <p>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or
37 the object is temporarily unavailable for interaction due to activity already in progress.</p>
40 <tp:enumvalue suffix="STATE_CHECKED" value="4">
42 Indicates this object is currently checked
45 <tp:enumvalue suffix="STATE_COLLAPSED" value="5">
47 Indicates this object is collapsed
50 <tp:enumvalue suffix="STATE_DEFUNCT" value="6">
51 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
52 <p>Indicates that this object no longer has a valid backing widget
53 (for instance, if its peer object has been destroyed) </p>
56 <tp:enumvalue suffix="STATE_EDITABLE" value="7">
58 Indicates the user can change the contents of this object
61 <tp:enumvalue suffix="STATE_ENABLED" value="8">
62 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
63 <p>Indicates that this object is enabled, i.e. that it currently reflects some application state.
64 Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user
65 interaction cannot cause them to acquire STATE_ENABLED. @see STATE_SENSITIVE.</p>
68 <tp:enumvalue suffix="STATE_EXPANDABLE" value="9">
70 Indicates this object allows progressive disclosure of its children
73 <tp:enumvalue suffix="STATE_EXPANDED" value="10">
75 Indicates this object its expanded
78 <tp:enumvalue suffix="STATE_FOCUSABLE" value="11">
79 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
80 <p>Indicates this object can accept keyboard focus, which means all
81 events resulting from typing on the keyboard will normally be passed
82 to it when it has focus</p>
85 <tp:enumvalue suffix="STATE_FOCUSED" value="12">
87 Indicates this object currently has the keyboard focus
90 <tp:enumvalue suffix="STATE_HAS_TOOLTIP" value="13">
92 Indicates that the object has an associated tooltip
95 <tp:enumvalue suffix="STATE_HORIZONTAL" value="14">
97 Indicates the orientation of thsi object is horizontal
100 <tp:enumvalue suffix="STATE_ICONIFIED" value="15">
102 Indicates this object is minimized and is represented only by an icon
105 <tp:enumvalue suffix="STATE_MODAL" value="16">
106 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
107 <p>Indicates something must be done with this object before the user can
108 interact with an object in a different window.</p>
111 <tp:enumvalue suffix="STATE_MULTI_LINE" value="17">
113 Indicates this (text) object can contain multiple lines of text
116 <tp:enumvalue suffix="STATE_MULTISELECTABLE" value="18">
117 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
118 <p>Indicates this object allows more than one of its children to be
119 selected at the same time, or in the case of text objects,
120 that the object supports non-contiguous text selections.</p>
123 <tp:enumvalue suffix="STATE_OPAQUE" value="19">
124 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
125 <p>Indicates this object paints every pixel within its rectangular region.
126 It also indicates an alpha value of unity, if it supports alpha blending. </p>
129 <tp:enumvalue suffix="STATE_PRESSED" value="20">
131 Indicates this object is currently pressed
134 <tp:enumvalue suffix="STATE_RESIZABLE" value="21">
136 Indicates the size of this object's size is not fixed
139 <tp:enumvalue suffix="STATE_SELECTABLE" value="22">
140 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
141 <p>Indicates this object is the child of an object that allows its
142 children to be selected and that this child is one of those children
143 that can be selected.</p>
146 <tp:enumvalue suffix="STATE_SELECTED" value="23">
147 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
148 <p>Indicates this object is the child of an object that allows its
149 children to be selected and that this child is one of those children
150 that has been selected.</p>
153 <tp:enumvalue suffix="STATE_SENSITIVE" value="24">
154 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
155 <p>Indicates this object is sensitive, e.g. to user interaction.
156 STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
157 but may be found in the absence of STATE_ENABLED if the current visible state of the
158 control is "disconnected" from the application state. In such cases, direct user interaction
159 can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
160 an explicit selection using an object whose current state is ambiguous or undefined.
161 @see STATE_ENABLED, STATE_INDETERMINATE. </p>
164 <tp:enumvalue suffix="STATE_SHOWING" value="25">
165 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
166 <p>Indicates this object, the object's parent, the object's parent's
167 parent, and so on, are all 'shown' to the end-user, i.e.
168 subject to "exposure" if blocking or obscuring objects do not interpose
169 between this object and the top of the window stack.</p>
172 <tp:enumvalue suffix="STATE_SINGLE_LINE" value="26">
174 Indicates this (text) object can contain only a single line of text
177 <tp:enumvalue suffix="STATE_STALE" value="27">
178 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
179 <p>Indicates that the information returned for this object may no longer be
180 synchronized with the application state. This can occur if the object has STATE_TRANSIENT,
181 and can also occur towards the end of the object peer's lifecycle. </p>
184 <tp:enumvalue suffix="STATE_TRANSIENT" value="28">
186 Indicates this object is transient
189 <tp:enumvalue suffix="STATE_VERTICAL" value="29">
190 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
191 <p>Indicates the orientation of this object is vertical; for example this state may appear on
192 such objects as scrollbars, text objects (with vertical text flow), separators, etc.</p>
195 <tp:enumvalue suffix="STATE_VISIBLE" value="30">
196 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
197 <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
198 @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
199 that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
200 field of view, or having an ancestor container that has not yet made visible.
201 A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
202 The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying
203 that an object is 'hidden'.</p>
206 <tp:enumvalue suffix="STATE_MANAGES_DESCENDANTS" value="31">
207 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
208 <p>Indicates that "active-descendant-changed" event is sent when children
209 become 'active' (i.e. are selected or navigated to onscreen). Used to
210 prevent need to enumerate all children in very large containers, like
211 tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
212 that the children should not, and need not, be enumerated by the client.
213 Objects implementing this state are expected to provide relevant state
214 notifications to listening clients, for instance notifications of visibility
215 changes and activation of their contained child objects, without the client
216 having previously requested references to those children.</p>
219 <tp:enumvalue suffix="STATE_INDETERMINATE" value="32">
220 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
221 <p>Indicates that a check box or other boolean indicator is in a state other than
222 checked or not checked. This usually means that the boolean value reflected or
223 controlled by the object does not apply consistently to the entire current context.
224 For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
225 if the currently selected text contains a mixture of weight attributes.
226 In many cases interacting with a STATE_INDETERMINATE object will cause
227 the context's corresponding boolean attribute to be homogenized, whereupon the object
228 will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.</p>
231 <tp:enumvalue suffix="STATE_REQUIRED" value="33">
232 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
233 <p>Indicates that user interaction with this object is 'required' from the user,
234 for instance before completing the processing of a form.</p>
237 <tp:enumvalue suffix="STATE_TRUNCATED" value="34">
238 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
239 <p>Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.
240 @since AT-SPI 1.7.0.</p>
243 <tp:enumvalue suffix="STATE_ANIMATED" value="35">
244 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
245 <p>Indicates this object's visual representation is dynamic, not static.
246 This state may be applied to an object during an animated 'effect' and
247 be removed from the object once its visual representation becomes static.
248 @note some applications, notably content viewers, may not be able to detect
249 all kinds of animated content. Therefore the absence of this state should not
250 be taken as definitive evidence that the object's visual representation is
251 static; this state is advisory. </p>
253 <p>@since AT-SPI 1.7.0</p>
256 <tp:enumvalue suffix="STATE_INVALID_ENTRY" value="36">
257 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
258 <p>This object has indicated an error condition due to failure of input
259 validation. For instance, a form control may acquire this state in response
260 to invalid or malformed user input. </p>
262 <p>@since AT-SPI 1.7.0 </p>
265 <tp:enumvalue suffix="STATE_SUPPORTS_AUTOCOMPLETION" value="37">
266 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
267 <p>This state indicates that the object in question implements some form of ¨typeahead¨ or
268 pre-selection behavior whereby entering the first character of one or more sub-elements
269 causes those elements to scroll into view or become selected. Subsequent character input
270 may narrow the selection further as long as one or more sub-elements match the string.
271 This state is normally only useful and encountered on objects that implement Selection.
272 In some cases the typeahead behavior may result in full or partial ¨completion¨ of
273 the data in the input field, in which case these input events may trigger text-changed
274 events from the source. </p>
276 <p>@since AT-SPI 1.7.0 </p>
279 <tp:enumvalue suffix="STATE_SELECTABLE_TEXT" value="38">
280 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
281 <p>This state indicates that the object in question supports text selection.
282 It should only be exposed on objects which implement the Text interface,
283 in order to distinguish this state from STATE_SELECTABLE, which infers that
284 the object in question is a selectable child of an object which implements
285 Selection. While similar, text selection and subelement selection are
286 distinct operations. </p>
288 <p>@since AT-SPI 1.7.0 </p>
291 <tp:enumvalue suffix="STATE_IS_DEFAULT" value="39">
292 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
293 <p>This state indicates that the object in question is the 'default' interaction object
294 in a dialog, i.e. the one that gets activated if the user presses "Enter" when the
295 dialog is initially posted. </p>
297 <p>@since AT-SPI 1.7.0 </p>
300 <tp:enumvalue suffix="STATE_VISITED" value="40">
301 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
302 <p>This state indicates that the object (typically a hyperlink)
303 has already been activated or invoked, with the result that some backing data
304 has been downloaded or rendered. </p>
306 <p>@since AT-SPI 1.7.1 </p>
309 <tp:enumvalue suffix="STATE_LAST_DEFINED" value="41">
310 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
311 <p>This value of the enumeration should not be used as a parameter, it indicates the number of
312 items in the StateType enumeration.</p>
316 <interface name="org.freedesktop.atspi.StateSet">
317 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
318 <p>The StateSet interface encapsulates a collection of state information.
319 It allows comparison of state information between object instances, and comparisons
320 of an object's state with some hypothetical collection of states.</p>
322 <method name="contains">
323 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
324 <p>Query a StateSet for a specific StateType.
325 @param state the StateType being queried for.</p>
327 <arg direction="in" name="state" type="u" tp:type="StateType"/>
328 <arg direction="out" type="b" tp:type="boolean">
330 \c TRUE if the StateSet contains StateType \a state.
336 Add a StateType to an existing StateSet, if not already present.
338 <arg direction="in" name="state" type="u" tp:type="StateType"/>
340 <method name="remove">
342 Remove a StateType to an existing StateSet, if it is present.
344 <arg direction="in" name="state" type="u" tp:type="StateType"/>
346 <method name="equals">
347 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
348 <p>Compare two statesets for equivalence.
349 @param tarStateSet the StateSet to be compared with this one.</p>
351 <arg direction="in" name="tarStateSet" type="o" tp:type="StateSet"/>
352 <arg direction="out" type="b" tp:type="boolean">
354 \c TRUE if the two StateSet objects are composed of the same StateTypes.
358 <method name="compare">
360 Compare two StateSet instances and obtain their differences.
362 <arg direction="in" name="compareState" type="o" tp:type="StateSet"/>
363 <arg direction="out" type="o" tp:type="StateSet">
365 a 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.
369 <method name="isEmpty">
370 <arg direction="out" type="b" tp:type="boolean">
372 \c TRUE if the StateSet contains no states.
376 <method name="getStates">
377 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
381 <arg direction="out" type="au" tp:type="StateSeq"/>
383 <method name="unImplemented">
384 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
385 <p>unImplemented: </p>
387 <p>placeholders for future expansion.</p>
390 <method name="unImplemented2">
392 <method name="unImplemented3">
394 <method name="unImplemented4">