← Back to branch summary

~ubuntu-branches/ubuntu/maverick/at-spi/maverick

« 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: 2009-09-23 08:38:27 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20090923083827-lgmk1ulka14gji51
Tags: 1.28.0-0ubuntu1
New upstream release

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">
7
 
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
7
<link rel="start" 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">
31
31
                <a href="#at-spi-cspi-State-and-StateSets.description" class="shortcut">Description</a>
32
32
</td></tr>
33
33
</table>
34
 
<div class="refentry" title="State and StateSets">
 
34
<div class="refentry" lang="en">
35
35
<a name="at-spi-cspi-State-and-StateSets"></a><div class="titlepage"></div>
36
36
<div class="refnamediv"><table width="100%"><tr>
37
37
<td valign="top">
38
38
<h2><span class="refentrytitle"><a name="at-spi-cspi-State-and-StateSets.top_of_page"></a>State and StateSets</span></h2>
39
 
<p>State and StateSets</p>
 
39
<p>State and StateSets — </p>
40
40
</td>
41
41
<td valign="top" align="right"></td>
42
42
</tr></table></div>
43
 
<div class="refsynopsisdiv" title="Synopsis">
 
43
<div class="refsynopsisdiv">
44
44
<a name="at-spi-cspi-State-and-StateSets.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">
46
 
enum                <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a>;
47
 
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);
 
46
enum                <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a>;
 
47
struct              <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a>;
 
48
void                <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-ref" title="AccessibleStateSet_ref ()">AccessibleStateSet_ref</a>              (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
 
49
void                <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-unref" title="AccessibleStateSet_unref ()">AccessibleStateSet_unref</a>            (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
 
50
void                <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-add" title="AccessibleStateSet_add ()">AccessibleStateSet_add</a>              (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
51
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
 
52
<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> * <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()">AccessibleStateSet_compare</a>         (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
53
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);
 
54
SPIBoolean          <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-contains" title="AccessibleStateSet_contains ()">AccessibleStateSet_contains</a>         (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
55
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
 
56
SPIBoolean          <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()">AccessibleStateSet_equals</a>           (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
57
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);
 
58
SPIBoolean          <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-isEmpty" title="AccessibleStateSet_isEmpty ()">AccessibleStateSet_isEmpty</a>          (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);
 
59
void                <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-remove" title="AccessibleStateSet_remove ()">AccessibleStateSet_remove</a>           (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
60
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);
61
61
</pre>
62
62
</div>
63
 
<div class="refsect1" title="Description">
 
63
<div class="refsect1" lang="en">
64
64
<a name="at-spi-cspi-State-and-StateSets.description"></a><h2>Description</h2>
65
65
<p>
66
66
</p>
67
67
</div>
68
 
<div class="refsect1" title="Details">
 
68
<div class="refsect1" lang="en">
69
69
<a name="at-spi-cspi-State-and-StateSets.details"></a><h2>Details</h2>
70
 
<div class="refsect2" title="enum AccessibleState">
 
70
<div class="refsect2" lang="en">
71
71
<a name="AccessibleState"></a><h3>enum AccessibleState</h3>
72
72
<pre class="programlisting">typedef enum
73
73
{
121
121
<col align="left" valign="top">
122
122
<tbody>
123
123
<tr>
124
 
<td><p><a name="SPI-STATE-INVALID--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID</code></span></p></td>
 
124
<td>
 
125
<a name="SPI-STATE-INVALID--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID</code></span></td>
125
126
<td> Indicates an invalid state
126
127
</td>
127
128
</tr>
128
129
<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>
 
131
<a name="SPI-STATE-ACTIVE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ACTIVE</code></span></td>
130
132
<td> Indicates a window is currently the active window 
131
133
</td>
132
134
</tr>
133
135
<tr>
134
 
<td><p><a name="SPI-STATE-ARMED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ARMED</code></span></p></td>
 
136
<td>
 
137
<a name="SPI-STATE-ARMED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ARMED</code></span></td>
135
138
<td> Indicates that the object is armed
136
139
</td>
137
140
</tr>
138
141
<tr>
139
 
<td><p><a name="SPI-STATE-BUSY--CAPS"></a><span class="term"><code class="literal">SPI_STATE_BUSY</code></span></p></td>
 
142
<td>
 
143
<a name="SPI-STATE-BUSY--CAPS"></a><span class="term"><code class="literal">SPI_STATE_BUSY</code></span></td>
140
144
<td> Indicates the current object is busy 
141
145
</td>
142
146
</tr>
143
147
<tr>
144
 
<td><p><a name="SPI-STATE-CHECKED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_CHECKED</code></span></p></td>
 
148
<td>
 
149
<a name="SPI-STATE-CHECKED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_CHECKED</code></span></td>
145
150
<td> Indicates this object is currently checked 
146
151
</td>
147
152
</tr>
148
153
<tr>
149
 
<td><p><a name="SPI-STATE-COLLAPSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_COLLAPSED</code></span></p></td>
 
154
<td>
 
155
<a name="SPI-STATE-COLLAPSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_COLLAPSED</code></span></td>
150
156
<td> Indicates this object is collapsed 
151
157
</td>
152
158
</tr>
153
159
<tr>
154
 
<td><p><a name="SPI-STATE-DEFUNCT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_DEFUNCT</code></span></p></td>
 
160
<td>
 
161
<a name="SPI-STATE-DEFUNCT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_DEFUNCT</code></span></td>
155
162
<td> Indicates the user interface object corresponding to this object no longer exists 
156
163
</td>
157
164
</tr>
158
165
<tr>
159
 
<td><p><a name="SPI-STATE-EDITABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EDITABLE</code></span></p></td>
 
166
<td>
 
167
<a name="SPI-STATE-EDITABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EDITABLE</code></span></td>
160
168
<td> Indicates the user can change the contents of this object
161
169
</td>
162
170
</tr>
163
171
<tr>
164
 
<td><p><a name="SPI-STATE-ENABLED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ENABLED</code></span></p></td>
 
172
<td>
 
173
<a name="SPI-STATE-ENABLED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ENABLED</code></span></td>
165
174
<td> Indicates that this object is enabled 
166
175
</td>
167
176
</tr>
168
177
<tr>
169
 
<td><p><a name="SPI-STATE-EXPANDABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDABLE</code></span></p></td>
 
178
<td>
 
179
<a name="SPI-STATE-EXPANDABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDABLE</code></span></td>
170
180
<td> Indicates this object allows progressive disclosure of its children 
171
181
</td>
172
182
</tr>
173
183
<tr>
174
 
<td><p><a name="SPI-STATE-EXPANDED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDED</code></span></p></td>
 
184
<td>
 
185
<a name="SPI-STATE-EXPANDED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_EXPANDED</code></span></td>
175
186
<td> Indicates this object its expanded
176
187
</td>
177
188
</tr>
178
189
<tr>
179
 
<td><p><a name="SPI-STATE-FOCUSABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSABLE</code></span></p></td>
 
190
<td>
 
191
<a name="SPI-STATE-FOCUSABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSABLE</code></span></td>
180
192
<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
193
</td>
182
194
</tr>
183
195
<tr>
184
 
<td><p><a name="SPI-STATE-FOCUSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSED</code></span></p></td>
 
196
<td>
 
197
<a name="SPI-STATE-FOCUSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_FOCUSED</code></span></td>
185
198
<td> Indicates this object currently has the keyboard focus 
186
199
</td>
187
200
</tr>
188
201
<tr>
189
 
<td><p><a name="SPI-STATE-HORIZONTAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_HORIZONTAL</code></span></p></td>
 
202
<td>
 
203
<a name="SPI-STATE-HORIZONTAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_HORIZONTAL</code></span></td>
190
204
<td> Indicates the orientation of thsi object is horizontal
191
205
</td>
192
206
</tr>
193
207
<tr>
194
 
<td><p><a name="SPI-STATE-ICONIFIED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ICONIFIED</code></span></p></td>
 
208
<td>
 
209
<a name="SPI-STATE-ICONIFIED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_ICONIFIED</code></span></td>
195
210
<td> Indicates this object is minimized and is represented only by an icon
196
211
</td>
197
212
</tr>
198
213
<tr>
199
 
<td><p><a name="SPI-STATE-MODAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MODAL</code></span></p></td>
 
214
<td>
 
215
<a name="SPI-STATE-MODAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MODAL</code></span></td>
200
216
<td> Indicates something must be done with this object before the user can interact with an object in a different window
201
217
</td>
202
218
</tr>
203
219
<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>
 
220
<td>
 
221
<a name="SPI-STATE-MULTI-LINE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTI_LINE</code></span></td>
205
222
<td> Indicates this (text) object can contain multiple lines of text
206
223
</td>
207
224
</tr>
208
225
<tr>
209
 
<td><p><a name="SPI-STATE-MULTISELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTISELECTABLE</code></span></p></td>
 
226
<td>
 
227
<a name="SPI-STATE-MULTISELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MULTISELECTABLE</code></span></td>
210
228
<td> Indicates this object allows more than one of its children to be selected at the same time
211
229
</td>
212
230
</tr>
213
231
<tr>
214
 
<td><p><a name="SPI-STATE-OPAQUE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_OPAQUE</code></span></p></td>
 
232
<td>
 
233
<a name="SPI-STATE-OPAQUE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_OPAQUE</code></span></td>
215
234
<td> Indicates this object paints every pixel within its rectangular region
216
235
</td>
217
236
</tr>
218
237
<tr>
219
 
<td><p><a name="SPI-STATE-PRESSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_PRESSED</code></span></p></td>
 
238
<td>
 
239
<a name="SPI-STATE-PRESSED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_PRESSED</code></span></td>
220
240
<td> Indicates this object is currently pressed
221
241
</td>
222
242
</tr>
223
243
<tr>
224
 
<td><p><a name="SPI-STATE-RESIZABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_RESIZABLE</code></span></p></td>
 
244
<td>
 
245
<a name="SPI-STATE-RESIZABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_RESIZABLE</code></span></td>
225
246
<td> Indicates the size of this object is not fixed
226
247
</td>
227
248
</tr>
228
249
<tr>
229
 
<td><p><a name="SPI-STATE-SELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE</code></span></p></td>
 
250
<td>
 
251
<a name="SPI-STATE-SELECTABLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE</code></span></td>
230
252
<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
253
</td>
232
254
</tr>
233
255
<tr>
234
 
<td><p><a name="SPI-STATE-SELECTED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTED</code></span></p></td>
 
256
<td>
 
257
<a name="SPI-STATE-SELECTED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTED</code></span></td>
235
258
<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
259
</td>
237
260
</tr>
238
261
<tr>
239
 
<td><p><a name="SPI-STATE-SENSITIVE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SENSITIVE</code></span></p></td>
 
262
<td>
 
263
<a name="SPI-STATE-SENSITIVE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SENSITIVE</code></span></td>
240
264
<td> Indicates this object is sensitive
241
265
</td>
242
266
</tr>
243
267
<tr>
244
 
<td><p><a name="SPI-STATE-SHOWING--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SHOWING</code></span></p></td>
 
268
<td>
 
269
<a name="SPI-STATE-SHOWING--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SHOWING</code></span></td>
245
270
<td> Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
246
271
</td>
247
272
</tr>
248
273
<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>
 
274
<td>
 
275
<a name="SPI-STATE-SINGLE-LINE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SINGLE_LINE</code></span></td>
250
276
<td> Indicates this (text) object can contain only a single line of text
251
277
</td>
252
278
</tr>
253
279
<tr>
254
 
<td><p><a name="SPI-STATE-STALE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_STALE</code></span></p></td>
 
280
<td>
 
281
<a name="SPI-STATE-STALE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_STALE</code></span></td>
255
282
<td> Indicates that the index associated with this object has changed since the user accessed the object
256
283
</td>
257
284
</tr>
258
285
<tr>
259
 
<td><p><a name="SPI-STATE-TRANSIENT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRANSIENT</code></span></p></td>
 
286
<td>
 
287
<a name="SPI-STATE-TRANSIENT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRANSIENT</code></span></td>
260
288
<td> Indicates this object is transient
261
289
</td>
262
290
</tr>
263
291
<tr>
264
 
<td><p><a name="SPI-STATE-VERTICAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VERTICAL</code></span></p></td>
 
292
<td>
 
293
<a name="SPI-STATE-VERTICAL--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VERTICAL</code></span></td>
265
294
<td> Indicates the orientation of this object is vertical
266
295
</td>
267
296
</tr>
268
297
<tr>
269
 
<td><p><a name="SPI-STATE-VISIBLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISIBLE</code></span></p></td>
 
298
<td>
 
299
<a name="SPI-STATE-VISIBLE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISIBLE</code></span></td>
270
300
<td> Indicates this object is visible 
271
301
</td>
272
302
</tr>
273
303
<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>
 
304
<td>
 
305
<a name="SPI-STATE-MANAGES-DESCENDANTS--CAPS"></a><span class="term"><code class="literal">SPI_STATE_MANAGES_DESCENDANTS</code></span></td>
275
306
<td> Indicates that "active-descendant-changed" 
276
307
event is sent when children become 'active' (i.e. are selected or navigated 
277
308
to onscreen).  Used to prevent need to enumerate all children in very large 
279
310
</td>
280
311
</tr>
281
312
<tr>
282
 
<td><p><a name="SPI-STATE-INDETERMINATE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INDETERMINATE</code></span></p></td>
 
313
<td>
 
314
<a name="SPI-STATE-INDETERMINATE--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INDETERMINATE</code></span></td>
283
315
<td> Indicates that a check box is in a state other than checked or not checked.
284
316
</td>
285
317
</tr>
286
318
<tr>
287
 
<td><p><a name="SPI-STATE-TRUNCATED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRUNCATED</code></span></p></td>
 
319
<td>
 
320
<a name="SPI-STATE-TRUNCATED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_TRUNCATED</code></span></td>
288
321
<td> Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
289
322
</td>
290
323
</tr>
291
324
<tr>
292
 
<td><p><a name="SPI-STATE-REQUIRED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_REQUIRED</code></span></p></td>
 
325
<td>
 
326
<a name="SPI-STATE-REQUIRED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_REQUIRED</code></span></td>
293
327
<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
328
</td>
295
329
</tr>
296
330
<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>
 
331
<td>
 
332
<a name="SPI-STATE-INVALID-ENTRY--CAPS"></a><span class="term"><code class="literal">SPI_STATE_INVALID_ENTRY</code></span></td>
298
333
<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
334
</td>
300
335
</tr>
301
336
<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>
 
337
<td>
 
338
<a name="SPI-STATE-SUPPORTS-AUTOCOMPLETION--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SUPPORTS_AUTOCOMPLETION</code></span></td>
303
339
<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
340
</td>
305
341
</tr>
306
342
<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>
 
343
<td>
 
344
<a name="SPI-STATE-SELECTABLE-TEXT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_SELECTABLE_TEXT</code></span></td>
308
345
<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
346
</td>
310
347
</tr>
311
348
<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>
 
349
<td>
 
350
<a name="SPI-STATE-IS-DEFAULT--CAPS"></a><span class="term"><code class="literal">SPI_STATE_IS_DEFAULT</code></span></td>
313
351
<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
352
</td>
315
353
</tr>
316
354
<tr>
317
 
<td><p><a name="SPI-STATE-VISITED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISITED</code></span></p></td>
 
355
<td>
 
356
<a name="SPI-STATE-VISITED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_VISITED</code></span></td>
318
357
<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
358
</td>
320
359
</tr>
321
360
<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>
 
361
<td>
 
362
<a name="SPI-STATE-LAST-DEFINED--CAPS"></a><span class="term"><code class="literal">SPI_STATE_LAST_DEFINED</code></span></td>
323
363
<td> Not a valid state, used for finding end of enumeration
324
364
</td>
325
365
</tr>
327
367
</table></div>
328
368
</div>
329
369
<hr>
330
 
<div class="refsect2" title="struct AccessibleStateSet">
 
370
<div class="refsect2" lang="en">
331
371
<a name="AccessibleStateSet"></a><h3>struct AccessibleStateSet</h3>
332
372
<pre class="programlisting">struct AccessibleStateSet {
333
373
        guint   ref_count;
345
385
<col align="left" valign="top">
346
386
<tbody>
347
387
<tr>
348
 
<td><p><span class="term"><a
 
388
<td>
 
389
<span class="term"><a
349
390
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
350
 
>guint</a> <em class="structfield"><code>ref_count</code></em>;</span></p></td>
 
391
>guint</a> <em class="structfield"><code>ref_count</code></em>;</span></td>
351
392
<td> private
352
393
</td>
353
394
</tr>
354
395
<tr>
355
 
<td><p><span class="term"><a
 
396
<td>
 
397
<span class="term"><a
356
398
href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"
357
 
>GArray</a> *<em class="structfield"><code>states</code></em>;</span></p></td>
 
399
>GArray</a> *<em class="structfield"><code>states</code></em>;</span></td>
358
400
<td> private
359
401
</td>
360
402
</tr>
362
404
</table></div>
363
405
</div>
364
406
<hr>
365
 
<div class="refsect2" title="AccessibleStateSet_ref ()">
 
407
<div class="refsect2" lang="en">
366
408
<a name="AccessibleStateSet-ref"></a><h3>AccessibleStateSet_ref ()</h3>
367
 
<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>
 
409
<pre class="programlisting">void                AccessibleStateSet_ref              (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
368
410
<p>
369
 
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>
 
411
Increment the reference count for an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.</p>
370
412
<p>
371
413
</p>
372
414
<div class="variablelist"><table border="0">
373
415
<col align="left" valign="top">
374
416
<tbody><tr>
375
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
376
 
<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.
 
417
<td>
 
418
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
419
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
377
420
</td>
378
421
</tr></tbody>
379
422
</table></div>
380
423
</div>
381
424
<hr>
382
 
<div class="refsect2" title="AccessibleStateSet_unref ()">
 
425
<div class="refsect2" lang="en">
383
426
<a name="AccessibleStateSet-unref"></a><h3>AccessibleStateSet_unref ()</h3>
384
 
<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>
 
427
<pre class="programlisting">void                AccessibleStateSet_unref            (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
385
428
<p>
386
 
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>
 
429
Decrement the reference count for an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object.</p>
387
430
<p>
388
431
</p>
389
432
<div class="variablelist"><table border="0">
390
433
<col align="left" valign="top">
391
434
<tbody><tr>
392
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
393
 
<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.
 
435
<td>
 
436
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
437
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
394
438
</td>
395
439
</tr></tbody>
396
440
</table></div>
397
441
</div>
398
442
<hr>
399
 
<div class="refsect2" title="AccessibleStateSet_add ()">
 
443
<div class="refsect2" lang="en">
400
444
<a name="AccessibleStateSet-add"></a><h3>AccessibleStateSet_add ()</h3>
401
 
<pre class="programlisting">void                AccessibleStateSet_add              (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
402
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
445
<pre class="programlisting">void                AccessibleStateSet_add              (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
446
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
403
447
<p>
404
 
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
 
448
Add a particular <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> (i.e. set the
405
449
      given state to <a
406
450
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
407
451
><span class="type">TRUE</span></a> in the stateset.</p>
411
455
<col align="left" valign="top">
412
456
<tbody>
413
457
<tr>
414
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
415
 
<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.
 
458
<td>
 
459
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
460
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
416
461
</td>
417
462
</tr>
418
463
<tr>
419
 
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
420
 
<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>
 
464
<td>
 
465
<span class="term"><em class="parameter"><code>state</code></em> :</span></td>
 
466
<td> an <a 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 href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
421
467
</td>
422
468
</tr>
423
469
</tbody>
424
470
</table></div>
425
471
</div>
426
472
<hr>
427
 
<div class="refsect2" title="AccessibleStateSet_compare ()">
 
473
<div class="refsect2" lang="en">
428
474
<a name="AccessibleStateSet-compare"></a><h3>AccessibleStateSet_compare ()</h3>
429
 
<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,
430
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
 
475
<pre class="programlisting"><a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> * AccessibleStateSet_compare         (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
476
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
431
477
<p>
432
 
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>.
 
478
Determine the differences between two instances of <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>.
433
479
Not Yet Implemented.
434
480
.
435
 
<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>
 
481
<em class="parameter"><code>see</code></em> <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-equals" title="AccessibleStateSet_equals ()"><code class="function">AccessibleStateSet_equals()</code></a>.</p>
436
482
<p>
437
483
</p>
438
484
<div class="variablelist"><table border="0">
439
485
<col align="left" valign="top">
440
486
<tbody>
441
487
<tr>
442
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
443
 
<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.
444
 
</td>
445
 
</tr>
446
 
<tr>
447
 
<td><p><span class="term"><em class="parameter"><code>obj2</code></em> :</span></p></td>
448
 
<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.
449
 
</td>
450
 
</tr>
451
 
<tr>
452
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453
 
<td> an <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object containing all states contained on one of
 
488
<td>
 
489
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
490
<td> a pointer to the first <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
491
</td>
 
492
</tr>
 
493
<tr>
 
494
<td>
 
495
<span class="term"><em class="parameter"><code>obj2</code></em> :</span></td>
 
496
<td> a pointer to the second <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
497
</td>
 
498
</tr>
 
499
<tr>
 
500
<td>
 
501
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
502
<td> an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object containing all states contained on one of
454
503
         the two sets but not the other.
455
504
 
456
505
</td>
459
508
</table></div>
460
509
</div>
461
510
<hr>
462
 
<div class="refsect2" title="AccessibleStateSet_contains ()">
 
511
<div class="refsect2" lang="en">
463
512
<a name="AccessibleStateSet-contains"></a><h3>AccessibleStateSet_contains ()</h3>
464
 
<pre class="programlisting">SPIBoolean          AccessibleStateSet_contains         (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
465
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
513
<pre class="programlisting">SPIBoolean          AccessibleStateSet_contains         (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
514
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
466
515
<p>
467
 
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,
 
516
Determine whether a given <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> includes a given state; that is,
468
517
      whether <em class="parameter"><code>state</code></em> is true for the stateset in question.</p>
469
518
<p>
470
519
</p>
472
521
<col align="left" valign="top">
473
522
<tbody>
474
523
<tr>
475
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
476
 
<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.
 
524
<td>
 
525
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
526
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
477
527
</td>
478
528
</tr>
479
529
<tr>
480
 
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
481
 
<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>
 
530
<td>
 
531
<span class="term"><em class="parameter"><code>state</code></em> :</span></td>
 
532
<td> an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> for which the specified <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
482
533
      will be queried.
483
534
</td>
484
535
</tr>
485
536
<tr>
486
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
537
<td>
 
538
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
487
539
<td> <a
488
540
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
489
 
><span class="type">TRUE</span></a> if <em class="parameter"><code>state</code></em> is true/included in the given <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>,
 
541
><span class="type">TRUE</span></a> if <em class="parameter"><code>state</code></em> is true/included in the given <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>,
490
542
         otherwise <a
491
543
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
492
544
><span class="type">FALSE</span></a>.
497
549
</table></div>
498
550
</div>
499
551
<hr>
500
 
<div class="refsect2" title="AccessibleStateSet_equals ()">
 
552
<div class="refsect2" lang="en">
501
553
<a name="AccessibleStateSet-equals"></a><h3>AccessibleStateSet_equals ()</h3>
502
 
<pre class="programlisting">SPIBoolean          AccessibleStateSet_equals           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
503
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
 
554
<pre class="programlisting">SPIBoolean          AccessibleStateSet_equals           (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
555
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj2);</pre>
504
556
<p>
505
 
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.
 
557
Determine whether two instances of <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> are equivalent (i.e.
506
558
        consist of the same <span class="type">AccessibleStates</span>).  Useful for checking multiple
507
559
        state variables at once; construct the target state then compare against it.
508
560
</p>
509
561
<p>
510
 
<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>
 
562
<em class="parameter"><code>see</code></em> <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet-compare" title="AccessibleStateSet_compare ()"><code class="function">AccessibleStateSet_compare()</code></a>.</p>
511
563
<p>
512
564
</p>
513
565
<div class="variablelist"><table border="0">
514
566
<col align="left" valign="top">
515
567
<tbody>
516
568
<tr>
517
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
518
 
<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.
519
 
</td>
520
 
</tr>
521
 
<tr>
522
 
<td><p><span class="term"><em class="parameter"><code>obj2</code></em> :</span></p></td>
523
 
<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.
524
 
</td>
525
 
</tr>
526
 
<tr>
527
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
569
<td>
 
570
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
571
<td> a pointer to the first <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
572
</td>
 
573
</tr>
 
574
<tr>
 
575
<td>
 
576
<span class="term"><em class="parameter"><code>obj2</code></em> :</span></td>
 
577
<td> a pointer to the second <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
 
578
</td>
 
579
</tr>
 
580
<tr>
 
581
<td>
 
582
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
528
583
<td> <a
529
584
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
530
585
><span class="type">TRUE</span></a> if the two <span class="type">AccessibleStateSets</span> are equivalent,
538
593
</table></div>
539
594
</div>
540
595
<hr>
541
 
<div class="refsect2" title="AccessibleStateSet_isEmpty ()">
 
596
<div class="refsect2" lang="en">
542
597
<a name="AccessibleStateSet-isEmpty"></a><h3>AccessibleStateSet_isEmpty ()</h3>
543
 
<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>
 
598
<pre class="programlisting">SPIBoolean          AccessibleStateSet_isEmpty          (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj);</pre>
544
599
<p>
545
 
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>
 
600
Determine whether a given <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> is the empty set.</p>
546
601
<p>
547
602
</p>
548
603
<div class="variablelist"><table border="0">
549
604
<col align="left" valign="top">
550
605
<tbody>
551
606
<tr>
552
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
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.
 
607
<td>
 
608
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
609
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
554
610
</td>
555
611
</tr>
556
612
<tr>
557
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
613
<td>
 
614
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
558
615
<td> <a
559
616
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
560
 
><span class="type">TRUE</span></a> if the given <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> contains no (true) states,
 
617
><span class="type">TRUE</span></a> if the given <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> contains no (true) states,
561
618
         otherwise <a
562
619
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
563
620
><span class="type">FALSE</span></a>.
568
625
</table></div>
569
626
</div>
570
627
<hr>
571
 
<div class="refsect2" title="AccessibleStateSet_remove ()">
 
628
<div class="refsect2" lang="en">
572
629
<a name="AccessibleStateSet-remove"></a><h3>AccessibleStateSet_remove ()</h3>
573
 
<pre class="programlisting">void                AccessibleStateSet_remove           (<a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
574
 
                                                         <a class="link" href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
 
630
<pre class="programlisting">void                AccessibleStateSet_remove           (<a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet">AccessibleStateSet</a> *obj,
 
631
                                                         <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState">AccessibleState</a> state);</pre>
575
632
<p>
576
 
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
 
633
Remove a particular <a href="at-spi-cspi-State-and-StateSets.html#AccessibleState" title="enum AccessibleState"><span class="type">AccessibleState</span></a> to an <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> (i.e. set the
577
634
      given state to <a
578
635
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
579
636
><span class="type">FALSE</span></a> in the stateset.)</p>
583
640
<col align="left" valign="top">
584
641
<tbody>
585
642
<tr>
586
 
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
587
 
<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.
 
643
<td>
 
644
<span class="term"><em class="parameter"><code>obj</code></em> :</span></td>
 
645
<td> a pointer to the <a href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a> object on which to operate.
588
646
</td>
589
647
</tr>
590
648
<tr>
591
 
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
592
 
<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>
 
649
<td>
 
650
<span class="term"><em class="parameter"><code>state</code></em> :</span></td>
 
651
<td> an <a 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 href="at-spi-cspi-State-and-StateSets.html#AccessibleStateSet" title="struct AccessibleStateSet"><span class="type">AccessibleStateSet</span></a>
593
652
</td>
594
653
</tr>
595
654
</tbody>