1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
3 <tp:enum name="StateType" type="u">
4 <tp:enumvalue suffix="STATE_INVALID"/>
5 <tp:enumvalue suffix="STATE_ACTIVE" value="1">
7 Indicates a window is currently the active window, or is an active subelement within a container or table
10 <tp:enumvalue suffix="STATE_ARMED" value="2">
12 Indicates that the object is armed
15 <tp:enumvalue suffix="STATE_BUSY" value="3">
16 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
17 <p>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or
18 the object is temporarily unavailable for interaction due to activity already in progress.</p>
21 <tp:enumvalue suffix="STATE_CHECKED" value="4">
23 Indicates this object is currently checked
26 <tp:enumvalue suffix="STATE_COLLAPSED" value="5">
28 Indicates this object is collapsed
31 <tp:enumvalue suffix="STATE_DEFUNCT" value="6">
32 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
33 <p>Indicates that this object no longer has a valid backing widget
34 (for instance, if its peer object has been destroyed) </p>
37 <tp:enumvalue suffix="STATE_EDITABLE" value="7">
39 Indicates the user can change the contents of this object
42 <tp:enumvalue suffix="STATE_ENABLED" value="8">
43 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
44 <p>Indicates that this object is enabled, i.e. that it currently reflects some application state.
45 Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user
46 interaction cannot cause them to acquire STATE_ENABLED. @see STATE_SENSITIVE.</p>
49 <tp:enumvalue suffix="STATE_EXPANDABLE" value="9">
51 Indicates this object allows progressive disclosure of its children
54 <tp:enumvalue suffix="STATE_EXPANDED" value="10">
56 Indicates this object its expanded
59 <tp:enumvalue suffix="STATE_FOCUSABLE" value="11">
60 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
61 <p>Indicates this object can accept keyboard focus, which means all
62 events resulting from typing on the keyboard will normally be passed
63 to it when it has focus</p>
66 <tp:enumvalue suffix="STATE_FOCUSED" value="12">
68 Indicates this object currently has the keyboard focus
71 <tp:enumvalue suffix="STATE_HAS_TOOLTIP" value="13">
73 Indicates that the object has an associated tooltip
76 <tp:enumvalue suffix="STATE_HORIZONTAL" value="14">
78 Indicates the orientation of thsi object is horizontal
81 <tp:enumvalue suffix="STATE_ICONIFIED" value="15">
83 Indicates this object is minimized and is represented only by an icon
86 <tp:enumvalue suffix="STATE_MODAL" value="16">
87 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
88 <p>Indicates something must be done with this object before the user can
89 interact with an object in a different window.</p>
92 <tp:enumvalue suffix="STATE_MULTI_LINE" value="17">
94 Indicates this (text) object can contain multiple lines of text
97 <tp:enumvalue suffix="STATE_MULTISELECTABLE" value="18">
98 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
99 <p>Indicates this object allows more than one of its children to be
100 selected at the same time, or in the case of text objects,
101 that the object supports non-contiguous text selections.</p>
104 <tp:enumvalue suffix="STATE_OPAQUE" value="19">
105 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
106 <p>Indicates this object paints every pixel within its rectangular region.
107 It also indicates an alpha value of unity, if it supports alpha blending. </p>
110 <tp:enumvalue suffix="STATE_PRESSED" value="20">
112 Indicates this object is currently pressed
115 <tp:enumvalue suffix="STATE_RESIZABLE" value="21">
117 Indicates the size of this object's size is not fixed
120 <tp:enumvalue suffix="STATE_SELECTABLE" value="22">
121 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
122 <p>Indicates this object is the child of an object that allows its
123 children to be selected and that this child is one of those children
124 that can be selected.</p>
127 <tp:enumvalue suffix="STATE_SELECTED" value="23">
128 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
129 <p>Indicates this object is the child of an object that allows its
130 children to be selected and that this child is one of those children
131 that has been selected.</p>
134 <tp:enumvalue suffix="STATE_SENSITIVE" value="24">
135 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
136 <p>Indicates this object is sensitive, e.g. to user interaction.
137 STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
138 but may be found in the absence of STATE_ENABLED if the current visible state of the
139 control is "disconnected" from the application state. In such cases, direct user interaction
140 can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
141 an explicit selection using an object whose current state is ambiguous or undefined.
142 @see STATE_ENABLED, STATE_INDETERMINATE. </p>
145 <tp:enumvalue suffix="STATE_SHOWING" value="25">
146 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
147 <p>Indicates this object, the object's parent, the object's parent's
148 parent, and so on, are all 'shown' to the end-user, i.e.
149 subject to "exposure" if blocking or obscuring objects do not interpose
150 between this object and the top of the window stack.</p>
153 <tp:enumvalue suffix="STATE_SINGLE_LINE" value="26">
155 Indicates this (text) object can contain only a single line of text
158 <tp:enumvalue suffix="STATE_STALE" value="27">
159 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
160 <p>Indicates that the information returned for this object may no longer be
161 synchronized with the application state. This can occur if the object has STATE_TRANSIENT,
162 and can also occur towards the end of the object peer's lifecycle. </p>
165 <tp:enumvalue suffix="STATE_TRANSIENT" value="28">
167 Indicates this object is transient
170 <tp:enumvalue suffix="STATE_VERTICAL" value="29">
171 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
172 <p>Indicates the orientation of this object is vertical; for example this state may appear on
173 such objects as scrollbars, text objects (with vertical text flow), separators, etc.</p>
176 <tp:enumvalue suffix="STATE_VISIBLE" value="30">
177 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
178 <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.</p>
179 <p>STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
180 that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
181 field of view, or having an ancestor container that has not yet made visible.
182 A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
183 The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying
184 that an object is 'hidden'.</p>
187 <tp:enumvalue suffix="STATE_MANAGES_DESCENDANTS" value="31">
188 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
189 <p>Indicates that "active-descendant-changed" event is sent when children
190 become 'active' (i.e. are selected or navigated to onscreen). Used to
191 prevent need to enumerate all children in very large containers, like
192 tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
193 that the children should not, and need not, be enumerated by the client.
194 Objects implementing this state are expected to provide relevant state
195 notifications to listening clients, for instance notifications of visibility
196 changes and activation of their contained child objects, without the client
197 having previously requested references to those children.</p>
200 <tp:enumvalue suffix="STATE_INDETERMINATE" value="32">
201 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
202 <p>Indicates that a check box or other boolean indicator is in a state other than
203 checked or not checked. This usually means that the boolean value reflected or
204 controlled by the object does not apply consistently to the entire current context.
205 For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
206 if the currently selected text contains a mixture of weight attributes.
207 In many cases interacting with a STATE_INDETERMINATE object will cause
208 the context's corresponding boolean attribute to be homogenized, whereupon the object
209 will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.</p>
212 <tp:enumvalue suffix="STATE_REQUIRED" value="33">
213 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
214 <p>Indicates that user interaction with this object is 'required' from the user,
215 for instance before completing the processing of a form.</p>
218 <tp:enumvalue suffix="STATE_TRUNCATED" value="34">
219 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
220 <p>Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.</p>
223 <tp:enumvalue suffix="STATE_ANIMATED" value="35">
224 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
225 <p>Indicates this object's visual representation is dynamic, not static.
226 This state may be applied to an object during an animated 'effect' and
227 be removed from the object once its visual representation becomes static.</p>
228 <p>some applications, notably content viewers, may not be able to detect
229 all kinds of animated content. Therefore the absence of this state should not
230 be taken as definitive evidence that the object's visual representation is
231 static; this state is advisory.</p>
234 <tp:enumvalue suffix="STATE_INVALID_ENTRY" value="36">
235 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
236 <p>This object has indicated an error condition due to failure of input
237 validation. For instance, a form control may acquire this state in response
238 to invalid or malformed user input. </p>
241 <tp:enumvalue suffix="STATE_SUPPORTS_AUTOCOMPLETION" value="37">
242 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
243 <p>This state indicates that the object in question implements some form of ¨typeahead¨ or
244 pre-selection behavior whereby entering the first character of one or more sub-elements
245 causes those elements to scroll into view or become selected. Subsequent character input
246 may narrow the selection further as long as one or more sub-elements match the string.
247 This state is normally only useful and encountered on objects that implement Selection.
248 In some cases the typeahead behavior may result in full or partial ¨completion¨ of
249 the data in the input field, in which case these input events may trigger text-changed
250 events from the source. </p>
253 <tp:enumvalue suffix="STATE_SELECTABLE_TEXT" value="38">
254 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
255 <p>This state indicates that the object in question supports text selection.
256 It should only be exposed on objects which implement the Text interface,
257 in order to distinguish this state from STATE_SELECTABLE, which infers that
258 the object in question is a selectable child of an object which implements
259 Selection. While similar, text selection and subelement selection are
260 distinct operations. </p>
263 <tp:enumvalue suffix="STATE_IS_DEFAULT" value="39">
264 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
265 <p>This state indicates that the object in question is the 'default' interaction object
266 in a dialog, i.e. the one that gets activated if the user presses "Enter" when the
267 dialog is initially posted. </p>
270 <tp:enumvalue suffix="STATE_VISITED" value="40">
271 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
272 <p>This state indicates that the object (typically a hyperlink)
273 has already been activated or invoked, with the result that some backing data
274 has been downloaded or rendered. </p>
277 <tp:enumvalue suffix="STATE_LAST_DEFINED" value="41">
278 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
279 <p>This value of the enumeration should not be used as a parameter, it indicates the number of
280 items in the StateType enumeration.</p>
284 <interface name="org.freedesktop.atspi.StateSet">
285 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
286 <p>The StateSet interface encapsulates a collection of state information.
287 It allows comparison of state information between object instances, and comparisons
288 of an object's state with some hypothetical collection of states.</p>
290 <method name="contains">
291 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
292 <p>Query a StateSet for a specific StateType.</p>
294 <arg direction="in" name="state" type="u" tp:type="StateType">
296 <p>The StateType being queried for.</p>
299 <arg direction="out" type="b" tp:type="boolean">
301 <Code>True</Code> if the StateSet contains StateType state.
307 Add a StateType to an existing StateSet, if not already present.
309 <arg direction="in" name="state" type="u" tp:type="StateType"/>
311 <method name="remove">
313 Remove a StateType to an existing StateSet, if it is present.
315 <arg direction="in" name="state" type="u" tp:type="StateType"/>
317 <method name="equals">
318 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
319 <p>Compare two statesets for equivalence.</p>
321 <arg direction="in" name="tarStateSet" type="o" tp:type="StateSet">
323 <p>The StateSet to be compared with this one.</p>
326 <arg direction="out" type="b" tp:type="boolean">
328 <code>True</code> if the two StateSet objects are composed of the same StateTypes.
332 <method name="compare">
334 Compare two StateSet instances and obtain their differences.
336 <arg direction="in" name="compareState" type="o" tp:type="StateSet"/>
337 <arg direction="out" type="o" tp:type="StateSet">
339 A 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared.
343 <method name="isEmpty">
344 <arg direction="out" type="b" tp:type="boolean">
346 <code>True</code> if the StateSet contains no states.
350 <method name="getStates">
351 <arg direction="out" type="au" tp:type="StateSeq"/>