← Back to branch summary

~ubuntu-branches/ubuntu/lucid/at-spi/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/cspi/html/at-spi-cspi-State-and-StateSets.html

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-07-02 15:50:32 UTC
  • mfrom: (1.2.1 upstream) (0.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100702155032-mw7vioq2owm3a809
Tags: 1.30.1-0ubuntu1
https://launchpad.net/bugs/600906
* New upstream release (LP: #600906)
  -  Fixes GNOME bugzilla #538680, collection.getMatchesTo() seems to ignore
     the count.
  - Updated translations:

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/html/at-spi-cspi-State-and-StateSets.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>State and StateSets</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
8
8
<link rel="up" href="spi-accessible.html" title="Basic Accessible Object Methods and Interface Query">
9
9
<link rel="prev" href="at-spi-cspi-AccessibleRelations-and-RelationSets.html" title="AccessibleRelations and RelationSets">
10
10
<link rel="next" href="spi-component.html" title="Subinterface Methods">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="spi-main.html" title="SPI Main Event Loop and Registry">
14
 
<link rel="chapter" href="spi-application.html" title="AccessibleApplication Methods">
15
 
<link rel="chapter" href="spi-accessible.html" title="Basic Accessible Object Methods and Interface Query">
16
 
<link rel="chapter" href="spi-component.html" title="Subinterface Methods">
17
 
<link rel="chapter" href="ch05.html" title="Auxiliary Types">
18
13
</head>
19
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
20
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
27
22
</tr>
28
23
<tr><td colspan="5" class="shortcuts">
29
24
<a href="#at-spi-cspi-State-and-StateSets.synopsis" class="shortcut">Top</a>
30
 
                 | 
31
 
                <a href="#at-spi-cspi-State-and-StateSets.description" class="shortcut">Description</a>
 
25
                   | 
 
26
                  <a href="#at-spi-cspi-State-and-StateSets.description" class="shortcut">Description</a>
32
27
</td></tr>
33
28
</table>
34
29
<div class="refentry" title="State and StateSets">
42
37
</tr></table></div>
43
38
<div class="refsynopsisdiv" title="Synopsis">
44
39
<a name="at-spi-cspi-State-and-StateSets.synopsis"></a><h2>Synopsis</h2>
45
 
<pre class="synopsis">
46
 
enum                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a>;
 
40
<pre class="synopsis">enum                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a>;
47
41
struct              <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a>;
48
 
void                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-ref" title="AccessibleStateSet_ref ()">AccessibleStateSet_ref</a>              (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
49
 
void                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-unref" title="AccessibleStateSet_unref ()">AccessibleStateSet_unref</a>            (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
50
 
void                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-add" title="AccessibleStateSet_add ()">AccessibleStateSet_add</a>              (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
51
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
52
 
<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> * <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()">AccessibleStateSet_compare</a>         (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
53
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);
54
 
SPIBoolean          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-contains" title="AccessibleStateSet_contains ()">AccessibleStateSet_contains</a>         (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
55
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
56
 
SPIBoolean          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()">AccessibleStateSet_equals</a>           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
57
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);
58
 
SPIBoolean          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-isEmpty" title="AccessibleStateSet_isEmpty ()">AccessibleStateSet_isEmpty</a>          (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
59
 
void                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-remove" title="AccessibleStateSet_remove ()">AccessibleStateSet_remove</a>           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
60
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
 
42
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-ref" title="AccessibleStateSet_ref ()">AccessibleStateSet_ref</a>              (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);
 
43
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-unref" title="AccessibleStateSet_unref ()">AccessibleStateSet_unref</a>            (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);
 
44
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-add" title="AccessibleStateSet_add ()">AccessibleStateSet_add</a>              (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
45
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);
 
46
<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="returnvalue">AccessibleStateSet</span></a> * <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()">AccessibleStateSet_compare</a>         (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
47
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj2</code></em>);
 
48
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-contains" title="AccessibleStateSet_contains ()">AccessibleStateSet_contains</a>         (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
49
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);
 
50
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()">AccessibleStateSet_equals</a>           (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
51
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj2</code></em>);
 
52
<span class="returnvalue">SPIBoolean</span>          <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-isEmpty" title="AccessibleStateSet_isEmpty ()">AccessibleStateSet_isEmpty</a>          (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);
 
53
<span class="returnvalue">void</span>                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-remove" title="AccessibleStateSet_remove ()">AccessibleStateSet_remove</a>           (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
54
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);
61
55
</pre>
62
56
</div>
63
57
<div class="refsect1" title="Description">
114
108
} AccessibleState;
115
109
</pre>
116
110
<p>
117
 
The possibles states of an object.</p>
118
 
<p>
 
111
The possibles states of an object.
119
112
</p>
120
113
<div class="variablelist"><table border="0">
121
114
<col align="left" valign="top">
122
115
<tbody>
123
116
<tr>
124
 
<td><p><a name="SPI-STATE-INVALID--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID</code></span></p></td>
125
 
<td> Indicates an invalid state
126
 
</td>
127
 
</tr>
128
 
<tr>
129
 
<td><p><a name="SPI-STATE-ACTIVE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ACTIVE</code></span></p></td>
130
 
<td> Indicates a window is currently the active window 
131
 
</td>
132
 
</tr>
133
 
<tr>
134
 
<td><p><a name="SPI-STATE-ARMED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ARMED</code></span></p></td>
135
 
<td> Indicates that the object is armed
136
 
</td>
137
 
</tr>
138
 
<tr>
139
 
<td><p><a name="SPI-STATE-BUSY--CAPS"></a><span class="term"><code class="literal">SPI_STATE_BUSY</code></span></p></td>
140
 
<td> Indicates the current object is busy 
141
 
</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><a name="SPI-STATE-CHECKED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_CHECKED</code></span></p></td>
145
 
<td> Indicates this object is currently checked 
146
 
</td>
147
 
</tr>
148
 
<tr>
149
 
<td><p><a name="SPI-STATE-COLLAPSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_COLLAPSED</code></span></p></td>
150
 
<td> Indicates this object is collapsed 
151
 
</td>
152
 
</tr>
153
 
<tr>
154
 
<td><p><a name="SPI-STATE-DEFUNCT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_DEFUNCT</code></span></p></td>
155
 
<td> Indicates the user interface object corresponding to this object no longer exists 
156
 
</td>
157
 
</tr>
158
 
<tr>
159
 
<td><p><a name="SPI-STATE-EDITABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EDITABLE</code></span></p></td>
160
 
<td> Indicates the user can change the contents of this object
161
 
</td>
162
 
</tr>
163
 
<tr>
164
 
<td><p><a name="SPI-STATE-ENABLED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ENABLED</code></span></p></td>
165
 
<td> Indicates that this object is enabled 
166
 
</td>
167
 
</tr>
168
 
<tr>
169
 
<td><p><a name="SPI-STATE-EXPANDABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDABLE</code></span></p></td>
170
 
<td> Indicates this object allows progressive disclosure of its children 
171
 
</td>
172
 
</tr>
173
 
<tr>
174
 
<td><p><a name="SPI-STATE-EXPANDED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDED</code></span></p></td>
175
 
<td> Indicates this object its expanded
176
 
</td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><a name="SPI-STATE-FOCUSABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSABLE</code></span></p></td>
180
 
<td> Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
181
 
</td>
182
 
</tr>
183
 
<tr>
184
 
<td><p><a name="SPI-STATE-FOCUSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSED</code></span></p></td>
185
 
<td> Indicates this object currently has the keyboard focus 
186
 
</td>
187
 
</tr>
188
 
<tr>
189
 
<td><p><a name="SPI-STATE-HORIZONTAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_HORIZONTAL</code></span></p></td>
190
 
<td> Indicates the orientation of thsi object is horizontal
191
 
</td>
192
 
</tr>
193
 
<tr>
194
 
<td><p><a name="SPI-STATE-ICONIFIED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ICONIFIED</code></span></p></td>
195
 
<td> Indicates this object is minimized and is represented only by an icon
196
 
</td>
197
 
</tr>
198
 
<tr>
199
 
<td><p><a name="SPI-STATE-MODAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MODAL</code></span></p></td>
200
 
<td> Indicates something must be done with this object before the user can interact with an object in a different window
201
 
</td>
202
 
</tr>
203
 
<tr>
204
 
<td><p><a name="SPI-STATE-MULTI-LINE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTI_LINE</code></span></p></td>
205
 
<td> Indicates this (text) object can contain multiple lines of text
206
 
</td>
207
 
</tr>
208
 
<tr>
209
 
<td><p><a name="SPI-STATE-MULTISELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTISELECTABLE</code></span></p></td>
210
 
<td> Indicates this object allows more than one of its children to be selected at the same time
211
 
</td>
212
 
</tr>
213
 
<tr>
214
 
<td><p><a name="SPI-STATE-OPAQUE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_OPAQUE</code></span></p></td>
215
 
<td> Indicates this object paints every pixel within its rectangular region
216
 
</td>
217
 
</tr>
218
 
<tr>
219
 
<td><p><a name="SPI-STATE-PRESSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_PRESSED</code></span></p></td>
220
 
<td> Indicates this object is currently pressed
221
 
</td>
222
 
</tr>
223
 
<tr>
224
 
<td><p><a name="SPI-STATE-RESIZABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_RESIZABLE</code></span></p></td>
225
 
<td> Indicates the size of this object is not fixed
226
 
</td>
227
 
</tr>
228
 
<tr>
229
 
<td><p><a name="SPI-STATE-SELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE</code></span></p></td>
230
 
<td> Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
231
 
</td>
232
 
</tr>
233
 
<tr>
234
 
<td><p><a name="SPI-STATE-SELECTED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTED</code></span></p></td>
235
 
<td> Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
236
 
</td>
237
 
</tr>
238
 
<tr>
239
 
<td><p><a name="SPI-STATE-SENSITIVE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SENSITIVE</code></span></p></td>
240
 
<td> Indicates this object is sensitive
241
 
</td>
242
 
</tr>
243
 
<tr>
244
 
<td><p><a name="SPI-STATE-SHOWING--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SHOWING</code></span></p></td>
245
 
<td> Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
246
 
</td>
247
 
</tr>
248
 
<tr>
249
 
<td><p><a name="SPI-STATE-SINGLE-LINE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SINGLE_LINE</code></span></p></td>
250
 
<td> Indicates this (text) object can contain only a single line of text
251
 
</td>
252
 
</tr>
253
 
<tr>
254
 
<td><p><a name="SPI-STATE-STALE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_STALE</code></span></p></td>
255
 
<td> Indicates that the index associated with this object has changed since the user accessed the object
256
 
</td>
257
 
</tr>
258
 
<tr>
259
 
<td><p><a name="SPI-STATE-TRANSIENT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRANSIENT</code></span></p></td>
260
 
<td> Indicates this object is transient
261
 
</td>
262
 
</tr>
263
 
<tr>
264
 
<td><p><a name="SPI-STATE-VERTICAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VERTICAL</code></span></p></td>
265
 
<td> Indicates the orientation of this object is vertical
266
 
</td>
267
 
</tr>
268
 
<tr>
269
 
<td><p><a name="SPI-STATE-VISIBLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISIBLE</code></span></p></td>
270
 
<td> Indicates this object is visible 
271
 
</td>
272
 
</tr>
273
 
<tr>
274
 
<td><p><a name="SPI-STATE-MANAGES-DESCENDANTS--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MANAGES_DESCENDANTS</code></span></p></td>
275
 
<td> Indicates that "active-descendant-changed" 
 
117
<td><p><a name="SPI-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID</code></span></p></td>
 
118
<td>Indicates an invalid state
 
119
</td>
 
120
</tr>
 
121
<tr>
 
122
<td><p><a name="SPI-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_ACTIVE</code></span></p></td>
 
123
<td>Indicates a window is currently the active window 
 
124
</td>
 
125
</tr>
 
126
<tr>
 
127
<td><p><a name="SPI-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_ARMED</code></span></p></td>
 
128
<td>Indicates that the object is armed
 
129
</td>
 
130
</tr>
 
131
<tr>
 
132
<td><p><a name="SPI-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">SPI_STATE_BUSY</code></span></p></td>
 
133
<td>Indicates the current object is busy 
 
134
</td>
 
135
</tr>
 
136
<tr>
 
137
<td><p><a name="SPI-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_CHECKED</code></span></p></td>
 
138
<td>Indicates this object is currently checked 
 
139
</td>
 
140
</tr>
 
141
<tr>
 
142
<td><p><a name="SPI-STATE-COLLAPSED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_COLLAPSED</code></span></p></td>
 
143
<td>Indicates this object is collapsed 
 
144
</td>
 
145
</tr>
 
146
<tr>
 
147
<td><p><a name="SPI-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">SPI_STATE_DEFUNCT</code></span></p></td>
 
148
<td>Indicates the user interface object corresponding to this object no longer exists 
 
149
</td>
 
150
</tr>
 
151
<tr>
 
152
<td><p><a name="SPI-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_EDITABLE</code></span></p></td>
 
153
<td>Indicates the user can change the contents of this object
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td><p><a name="SPI-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_ENABLED</code></span></p></td>
 
158
<td>Indicates that this object is enabled 
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><a name="SPI-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDABLE</code></span></p></td>
 
163
<td>Indicates this object allows progressive disclosure of its children 
 
164
</td>
 
165
</tr>
 
166
<tr>
 
167
<td><p><a name="SPI-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDED</code></span></p></td>
 
168
<td>Indicates this object its expanded
 
169
</td>
 
170
</tr>
 
171
<tr>
 
172
<td><p><a name="SPI-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSABLE</code></span></p></td>
 
173
<td>Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
 
174
</td>
 
175
</tr>
 
176
<tr>
 
177
<td><p><a name="SPI-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSED</code></span></p></td>
 
178
<td>Indicates this object currently has the keyboard focus 
 
179
</td>
 
180
</tr>
 
181
<tr>
 
182
<td><p><a name="SPI-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">SPI_STATE_HORIZONTAL</code></span></p></td>
 
183
<td>Indicates the orientation of thsi object is horizontal
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><a name="SPI-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_ICONIFIED</code></span></p></td>
 
188
<td>Indicates this object is minimized and is represented only by an icon
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><a name="SPI-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">SPI_STATE_MODAL</code></span></p></td>
 
193
<td>Indicates something must be done with this object before the user can interact with an object in a different window
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td><p><a name="SPI-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTI_LINE</code></span></p></td>
 
198
<td>Indicates this (text) object can contain multiple lines of text
 
199
</td>
 
200
</tr>
 
201
<tr>
 
202
<td><p><a name="SPI-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTISELECTABLE</code></span></p></td>
 
203
<td>Indicates this object allows more than one of its children to be selected at the same time
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><a name="SPI-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_OPAQUE</code></span></p></td>
 
208
<td>Indicates this object paints every pixel within its rectangular region
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><a name="SPI-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_PRESSED</code></span></p></td>
 
213
<td>Indicates this object is currently pressed
 
214
</td>
 
215
</tr>
 
216
<tr>
 
217
<td><p><a name="SPI-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_RESIZABLE</code></span></p></td>
 
218
<td>Indicates the size of this object is not fixed
 
219
</td>
 
220
</tr>
 
221
<tr>
 
222
<td><p><a name="SPI-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE</code></span></p></td>
 
223
<td>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
 
224
</td>
 
225
</tr>
 
226
<tr>
 
227
<td><p><a name="SPI-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTED</code></span></p></td>
 
228
<td>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
 
229
</td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><a name="SPI-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SENSITIVE</code></span></p></td>
 
233
<td>Indicates this object is sensitive
 
234
</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><a name="SPI-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SHOWING</code></span></p></td>
 
238
<td>Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
 
239
</td>
 
240
</tr>
 
241
<tr>
 
242
<td><p><a name="SPI-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SINGLE_LINE</code></span></p></td>
 
243
<td>Indicates this (text) object can contain only a single line of text
 
244
</td>
 
245
</tr>
 
246
<tr>
 
247
<td><p><a name="SPI-STATE-STALE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_STALE</code></span></p></td>
 
248
<td>Indicates that the index associated with this object has changed since the user accessed the object
 
249
</td>
 
250
</tr>
 
251
<tr>
 
252
<td><p><a name="SPI-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRANSIENT</code></span></p></td>
 
253
<td>Indicates this object is transient
 
254
</td>
 
255
</tr>
 
256
<tr>
 
257
<td><p><a name="SPI-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">SPI_STATE_VERTICAL</code></span></p></td>
 
258
<td>Indicates the orientation of this object is vertical
 
259
</td>
 
260
</tr>
 
261
<tr>
 
262
<td><p><a name="SPI-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISIBLE</code></span></p></td>
 
263
<td>Indicates this object is visible 
 
264
</td>
 
265
</tr>
 
266
<tr>
 
267
<td><p><a name="SPI-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">SPI_STATE_MANAGES_DESCENDANTS</code></span></p></td>
 
268
<td>Indicates that "active-descendant-changed" 
276
269
event is sent when children become 'active' (i.e. are selected or navigated 
277
270
to onscreen).  Used to prevent need to enumerate all children in very large 
278
271
containers, like tables.
279
272
</td>
280
273
</tr>
281
274
<tr>
282
 
<td><p><a name="SPI-STATE-INDETERMINATE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INDETERMINATE</code></span></p></td>
283
 
<td> Indicates that a check box is in a state other than checked or not checked.
284
 
</td>
285
 
</tr>
286
 
<tr>
287
 
<td><p><a name="SPI-STATE-TRUNCATED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRUNCATED</code></span></p></td>
288
 
<td> Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
289
 
</td>
290
 
</tr>
291
 
<tr>
292
 
<td><p><a name="SPI-STATE-REQUIRED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_REQUIRED</code></span></p></td>
293
 
<td> Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
294
 
</td>
295
 
</tr>
296
 
<tr>
297
 
<td><p><a name="SPI-STATE-INVALID-ENTRY--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID_ENTRY</code></span></p></td>
298
 
<td> Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.
299
 
</td>
300
 
</tr>
301
 
<tr>
302
 
<td><p><a name="SPI-STATE-SUPPORTS-AUTOCOMPLETION--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
303
 
<td> Indicates that the object may exhibit "typeahead" behavior in response to user keystrokes, e.g. one keystroke may result in the insertion of several characters into an entry, or result in the auto-selection of an item in a list.  This state supplants <em class="parameter"><code>SPI_ROLE_AUTOCOMPLETE</code></em>.
304
 
</td>
305
 
</tr>
306
 
<tr>
307
 
<td><p><a name="SPI-STATE-SELECTABLE-TEXT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE_TEXT</code></span></p></td>
 
275
<td><p><a name="SPI-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">SPI_STATE_INDETERMINATE</code></span></p></td>
 
276
<td>Indicates that a check box is in a state other than checked or not checked.
 
277
</td>
 
278
</tr>
 
279
<tr>
 
280
<td><p><a name="SPI-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRUNCATED</code></span></p></td>
 
281
<td>Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
 
282
</td>
 
283
</tr>
 
284
<tr>
 
285
<td><p><a name="SPI-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_REQUIRED</code></span></p></td>
 
286
<td>Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
 
287
</td>
 
288
</tr>
 
289
<tr>
 
290
<td><p><a name="SPI-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID_ENTRY</code></span></p></td>
 
291
<td>Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.
 
292
</td>
 
293
</tr>
 
294
<tr>
 
295
<td><p><a name="SPI-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
 
296
<td>Indicates that the object may exhibit "typeahead" behavior in response to user keystrokes, e.g. one keystroke may result in the insertion of several characters into an entry, or result in the auto-selection of an item in a list.  This state supplants <em class="parameter"><code>SPI_ROLE_AUTOCOMPLETE</code></em>.
 
297
</td>
 
298
</tr>
 
299
<tr>
 
300
<td><p><a name="SPI-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE_TEXT</code></span></p></td>
308
301
<td>Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from <em class="parameter"><code>SPI_STATE_SELECTABLE</code></em>, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.
309
302
</td>
310
303
</tr>
311
304
<tr>
312
 
<td><p><a name="SPI-STATE-IS-DEFAULT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_IS_DEFAULT</code></span></p></td>
313
 
<td> Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key.  Typically a "close" or "submit" button.
314
 
</td>
315
 
</tr>
316
 
<tr>
317
 
<td><p><a name="SPI-STATE-VISITED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISITED</code></span></p></td>
318
 
<td> Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".
319
 
</td>
320
 
</tr>
321
 
<tr>
322
 
<td><p><a name="SPI-STATE-LAST-DEFINED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_LAST_DEFINED</code></span></p></td>
323
 
<td> Not a valid state, used for finding end of enumeration
 
305
<td><p><a name="SPI-STATE-IS-DEFAULT:CAPS"></a><span class="term"><code class="literal">SPI_STATE_IS_DEFAULT</code></span></p></td>
 
306
<td>Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key.  Typically a "close" or "submit" button.
 
307
</td>
 
308
</tr>
 
309
<tr>
 
310
<td><p><a name="SPI-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISITED</code></span></p></td>
 
311
<td>Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".
 
312
</td>
 
313
</tr>
 
314
<tr>
 
315
<td><p><a name="SPI-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">SPI_STATE_LAST_DEFINED</code></span></p></td>
 
316
<td>Not a valid state, used for finding end of enumeration
324
317
</td>
325
318
</tr>
326
319
</tbody>
336
329
</pre>
337
330
<p>
338
331
An opaque structure representing an accessible object's state,
339
 
which can then be queried via AccessibleStateSet APIs.</p>
 
332
which can then be queried via AccessibleStateSet APIs.
 
333
</p>
340
334
<p>
341
335
An AccessibleStateSet determines a component's state set. It is composed of
342
336
a set of AccessibleState values.
345
339
<col align="left" valign="top">
346
340
<tbody>
347
341
<tr>
348
 
<td><p><span class="term">guint <em class="structfield"><code>ref_count</code></em>;</span></p></td>
349
 
<td> private
 
342
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="AccessibleStateSet.ref-count"></a>ref_count</code></em>;</span></p></td>
 
343
<td>private
350
344
</td>
351
345
</tr>
352
346
<tr>
353
 
<td><p><span class="term">GArray *<em class="structfield"><code>states</code></em>;</span></p></td>
354
 
<td> private
 
347
<td><p><span class="term"><span class="type">GArray</span> *<em class="structfield"><code><a name="AccessibleStateSet.states"></a>states</code></em>;</span></p></td>
 
348
<td>private
355
349
</td>
356
350
</tr>
357
351
</tbody>
360
354
<hr>
361
355
<div class="refsect2" title="AccessibleStateSet_ref ()">
362
356
<a name="AccessibleStateSet-ref"></a><h3>AccessibleStateSet_ref ()</h3>
363
 
<pre class="programlisting">void                AccessibleStateSet_ref              (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
364
 
<p>
365
 
Increment the reference count for an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.</p>
366
 
<p>
 
357
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStateSet_ref              (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);</pre>
 
358
<p>
 
359
Increment the reference count for an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.
367
360
</p>
368
361
<div class="variablelist"><table border="0">
369
362
<col align="left" valign="top">
370
363
<tbody><tr>
371
364
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
372
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
365
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
373
366
</td>
374
367
</tr></tbody>
375
368
</table></div>
377
370
<hr>
378
371
<div class="refsect2" title="AccessibleStateSet_unref ()">
379
372
<a name="AccessibleStateSet-unref"></a><h3>AccessibleStateSet_unref ()</h3>
380
 
<pre class="programlisting">void                AccessibleStateSet_unref            (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
381
 
<p>
382
 
Decrement the reference count for an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.</p>
383
 
<p>
 
373
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStateSet_unref            (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);</pre>
 
374
<p>
 
375
Decrement the reference count for an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.
384
376
</p>
385
377
<div class="variablelist"><table border="0">
386
378
<col align="left" valign="top">
387
379
<tbody><tr>
388
380
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
389
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
381
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
390
382
</td>
391
383
</tr></tbody>
392
384
</table></div>
394
386
<hr>
395
387
<div class="refsect2" title="AccessibleStateSet_add ()">
396
388
<a name="AccessibleStateSet-add"></a><h3>AccessibleStateSet_add ()</h3>
397
 
<pre class="programlisting">void                AccessibleStateSet_add              (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
398
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
389
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStateSet_add              (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
390
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);</pre>
399
391
<p>
400
392
Add a particular <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> (i.e. set the
401
 
      given state to <span class="type">TRUE</span> in the stateset.</p>
402
 
<p>
 
393
      given state to <span class="type">TRUE</span> in the stateset.
403
394
</p>
404
395
<div class="variablelist"><table border="0">
405
396
<col align="left" valign="top">
406
397
<tbody>
407
398
<tr>
408
399
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
409
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
400
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
410
401
</td>
411
402
</tr>
412
403
<tr>
413
404
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
414
 
<td> an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to be added to the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
 
405
<td>an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to be added to the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
415
406
</td>
416
407
</tr>
417
408
</tbody>
420
411
<hr>
421
412
<div class="refsect2" title="AccessibleStateSet_compare ()">
422
413
<a name="AccessibleStateSet-compare"></a><h3>AccessibleStateSet_compare ()</h3>
423
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> * AccessibleStateSet_compare         (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
424
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
 
414
<pre class="programlisting"><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="returnvalue">AccessibleStateSet</span></a> * AccessibleStateSet_compare         (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
415
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj2</code></em>);</pre>
425
416
<p>
426
417
Determine the differences between two instances of <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>.
427
418
Not Yet Implemented.
428
419
.
429
 
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()"><code class="function">AccessibleStateSet_equals()</code></a>.</p>
430
 
<p>
 
420
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()"><code class="function">AccessibleStateSet_equals()</code></a>.
431
421
</p>
432
422
<div class="variablelist"><table border="0">
433
423
<col align="left" valign="top">
434
424
<tbody>
435
425
<tr>
436
426
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
437
 
<td> a pointer to the first <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
427
<td>a pointer to the first <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
438
428
</td>
439
429
</tr>
440
430
<tr>
441
431
<td><p><span class="term"><em class="parameter"><code>obj2</code></em> :</span></p></td>
442
 
<td> a pointer to the second <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
432
<td>a pointer to the second <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
443
433
</td>
444
434
</tr>
445
435
<tr>
455
445
<hr>
456
446
<div class="refsect2" title="AccessibleStateSet_contains ()">
457
447
<a name="AccessibleStateSet-contains"></a><h3>AccessibleStateSet_contains ()</h3>
458
 
<pre class="programlisting">SPIBoolean          AccessibleStateSet_contains         (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
459
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
448
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStateSet_contains         (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
449
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);</pre>
460
450
<p>
461
451
Determine whether a given <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> includes a given state; that is,
462
 
      whether <em class="parameter"><code>state</code></em> is true for the stateset in question.</p>
463
 
<p>
 
452
      whether <em class="parameter"><code>state</code></em> is true for the stateset in question.
464
453
</p>
465
454
<div class="variablelist"><table border="0">
466
455
<col align="left" valign="top">
467
456
<tbody>
468
457
<tr>
469
458
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
470
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
459
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
471
460
</td>
472
461
</tr>
473
462
<tr>
474
463
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
475
 
<td> an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> for which the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
 
464
<td>an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> for which the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
476
465
      will be queried.
477
466
</td>
478
467
</tr>
489
478
<hr>
490
479
<div class="refsect2" title="AccessibleStateSet_equals ()">
491
480
<a name="AccessibleStateSet-equals"></a><h3>AccessibleStateSet_equals ()</h3>
492
 
<pre class="programlisting">SPIBoolean          AccessibleStateSet_equals           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
493
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
 
481
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStateSet_equals           (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
482
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj2</code></em>);</pre>
494
483
<p>
495
484
Determine whether two instances of <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> are equivalent (i.e.
496
 
        consist of the same <span class="type">AccessibleStates</span>).  Useful for checking multiple
 
485
        consist of the same <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState"><span class="type">AccessibleStates</span></a>).  Useful for checking multiple
497
486
        state variables at once; construct the target state then compare against it.
498
487
</p>
499
488
<p>
500
 
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()"><code class="function">AccessibleStateSet_compare()</code></a>.</p>
501
 
<p>
 
489
<em class="parameter"><code>see</code></em> <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()"><code class="function">AccessibleStateSet_compare()</code></a>.
502
490
</p>
503
491
<div class="variablelist"><table border="0">
504
492
<col align="left" valign="top">
505
493
<tbody>
506
494
<tr>
507
495
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
508
 
<td> a pointer to the first <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
496
<td>a pointer to the first <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
509
497
</td>
510
498
</tr>
511
499
<tr>
512
500
<td><p><span class="term"><em class="parameter"><code>obj2</code></em> :</span></p></td>
513
 
<td> a pointer to the second <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
501
<td>a pointer to the second <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
514
502
</td>
515
503
</tr>
516
504
<tr>
517
505
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
518
 
<td> <span class="type">TRUE</span> if the two <span class="type">AccessibleStateSets</span> are equivalent,
 
506
<td> <span class="type">TRUE</span> if the two <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet"><span class="type">AccessibleStateSets</span></a> are equivalent,
519
507
         otherwise <span class="type">FALSE</span>.
520
508
 
521
509
</td>
526
514
<hr>
527
515
<div class="refsect2" title="AccessibleStateSet_isEmpty ()">
528
516
<a name="AccessibleStateSet-isEmpty"></a><h3>AccessibleStateSet_isEmpty ()</h3>
529
 
<pre class="programlisting">SPIBoolean          AccessibleStateSet_isEmpty          (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
530
 
<p>
531
 
Determine whether a given <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> is the empty set.</p>
532
 
<p>
 
517
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span>          AccessibleStateSet_isEmpty          (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>);</pre>
 
518
<p>
 
519
Determine whether a given <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> is the empty set.
533
520
</p>
534
521
<div class="variablelist"><table border="0">
535
522
<col align="left" valign="top">
536
523
<tbody>
537
524
<tr>
538
525
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
539
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
526
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
540
527
</td>
541
528
</tr>
542
529
<tr>
552
539
<hr>
553
540
<div class="refsect2" title="AccessibleStateSet_remove ()">
554
541
<a name="AccessibleStateSet-remove"></a><h3>AccessibleStateSet_remove ()</h3>
555
 
<pre class="programlisting">void                AccessibleStateSet_remove           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
556
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
542
<pre class="programlisting"><span class="returnvalue">void</span>                AccessibleStateSet_remove           (<em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> *obj</code></em>,
 
543
                                                         <em class="parameter"><code><a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> state</code></em>);</pre>
557
544
<p>
558
545
Remove a particular <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> (i.e. set the
559
 
      given state to <span class="type">FALSE</span> in the stateset.)</p>
560
 
<p>
 
546
      given state to <span class="type">FALSE</span> in the stateset.)
561
547
</p>
562
548
<div class="variablelist"><table border="0">
563
549
<col align="left" valign="top">
564
550
<tbody>
565
551
<tr>
566
552
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
567
 
<td> a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
553
<td>a pointer to the <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
568
554
</td>
569
555
</tr>
570
556
<tr>
571
557
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
572
 
<td> an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to be removed from the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
 
558
<td>an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to be removed from the specified <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
573
559
</td>
574
560
</tr>
575
561
</tbody>
579
565
</div>
580
566
<div class="footer">
581
567
<hr>
582
 
          Generated by GTK-Doc V1.11</div>
 
568
          Generated by GTK-Doc V1.14</div>
583
569
</body>
584
 
</html>
 
570
</html>
 
 
b'\\ No newline at end of file'