1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?xml version="1.0" encoding="UTF-8"?>
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.a11y.atspi.Collection:
@short_description: An interface designed to allow accessibles which satisfy a set of
criteria to be returned.
-->
<interface name="org.a11y.atspi.Collection">
<!--
Version: The version of this interface.
This property is incremented by one every time a new method, signal, or property
is added to this interface.
-->
<property name="version" type="u" access="read"/>
<!--
GetMatches:
Return descendants which satisfy a set of criteria specified in the
match rule.
@rule: Criteria that objects to be returned must fulfill.
This structure is composed as follows:
- ai: States (see below for more how they are encoded)
- i: Match type used for matching states
- a{ss}: Attributes. See also the Accessible.GetAttributes method
- i: Match type used for matching attributes
- ai: Roles (see below for how they are encoded)
- i: Match type used for matching roles
- as: Interfaces, by name (like "Action" or "Text").
- i: Match type used for matching interfaces
- b: Whether to invert the criteria. If true, the match rule should
be denied (inverted); if false, it should not. For example, if
the match rule defines that a match is an object of ROLE_HEADING
which has STATE_FOCUSABLE and a click action, inverting it would
match all objects that are not of ROLE_HEADING, focusable and
clickable at the same time.
For all criteria, the value used for the match type corresponds to the
AtspiCollectionMatchType enum values.
The set of states and roles are bitsets encoded as an array of
multiple 32-bit integers.
A state/role with enum value N is set by setting the Nth bit in the bit
set.
The first integer in the array contains the lowest 0-31 bits, the next
integer bits 32-63, etc.
For example, enum value AT_SPI_ROLE_COMBOBOX has a value of 83. In order to
pass a set of roles in which only this role is set, an array of integers
representing (1 << 83) = 0x800000000000000000000 would be
passed: { 0, 0, 0x80000, 0 }
@sortby: The way objects should be sorted.
The values correspond to those defined in the AtspiCollectionSortOrder enum.
@count: Maximum number of objects to return, or 0 for no limit.
@traverse: Whether to return descendants from the accessible subtree
(if #TRUE) or only direct children (if #FALSE).
-->
<method name="GetMatches">
<arg direction="in" name="rule" type="(aiia{ss}iaiiasib)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiMatchRule"/>
<arg direction="in" name="sortby" type="u"/>
<arg direction="in" name="count" type="i"/>
<arg direction="in" name="traverse" type="b"/>
<arg direction="out" type="a(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiReferenceSet"/>
</method>
<!--
GetMatchesTo:
@currentObject: The object at which to start searching.
@rule: Criteria that objects to be returned must fulfill.
@sortby: The way objects should be sorted.
@tree: Specifies restrictions on the objects to be traversed. Values
correspond to the AtspiCollectionTreeTraversalType enum:
- ATSPI_Collection_TREE_RESTRICT_CHILDREN (0): Restrict children tree traversal
- 1 (ATSPI_Collection_TREE_RESTRICT_SIBLING): Restrict sibling tree traversal
- 2 (ATSPI_Collection_TREE_INORDER): In-order tree traversal.
@limit_scope: If true, only descendants of @currentObject's parent
will be returned. Otherwise (if false), any accessible may be
returned if it would preceed @currentObject in a flattened
hierarchy.
@count: The maximum number of results to return, or 0 for no limit.
@traverse: Whether to traverse the accessible subtree (in case
of true) or only the direct children (on case of false).
Gets all Accessible objects from the collection, after
@currentObject, matching a given @rule.
Returns: All accessible objects matching the given match rule after
@currentObject.
-->
<method name="GetMatchesTo">
<arg direction="in" name="currentObject" type="o"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
<arg direction="in" name="rule" type="(aiia{ss}iaiiasib)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QSpiMatchRule"/>
<arg direction="in" name="sortby" type="u"/>
<arg direction="in" name="tree" type="u"/>
<arg direction="in" name="limit_scope" type="b"/>
<arg direction="in" name="count" type="i"/>
<arg direction="in" name="traverse" type="b"/>
<arg direction="out" type="a(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiReferenceSet"/>
</method>
<!--
GetMatchesFrom:
@currentObject: Upon reaching this object, searching should stop.
@rule: Criteria that objects to be returned must fulfill.
@sortby: The way objects should be sorted.
@tree: Specifies restrictions on the objects to be traversed. Values
correspond to the AtspiCollectionTreeTraversalType enum.
@count: The maximum number of results to return, or 0 for no limit.
@traverse: Whether to traverse the accessible subtree (if true)
or only the direct children (if false).
Gets all Accessible objects from the collection, before @currentObject,
matching a given @rule.
Returns: All accessible objects matching the given match rule after
@currentObject.
-->
<method name="GetMatchesFrom">
<arg direction="in" name="currentObject" type="o"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QSpiObjectReference"/>
<arg direction="in" name="rule" type="(aiia{ss}iaiiasib)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QSpiMatchRule"/>
<arg direction="in" name="sortby" type="u"/>
<arg direction="in" name="tree" type="u"/>
<arg direction="in" name="count" type="i"/>
<arg direction="in" name="traverse" type="b"/>
<arg direction="out" type="a(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiReferenceSet"/>
</method>
<!--
GetActiveDescendant:
Returns the active descendant of the given object. Not currently
implemented in libatspi.
-->
<method name="GetActiveDescendant">
<arg direction="out" type="(so)"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QSpiReferenceSet"/>
</method>
</interface>
</node>
|
