« back to all changes in this revision
Viewing changes to docs/html/atk-AtkState.html
- browse files at revision 45
- compare with another revision
- download diff
- download tarball
- view history from revision 45
- Committer: Bazaar Package Importer
- Author(s): Luke Yelavich
- Date: 2010-09-28 09:03:21 UTC
- mfrom: (1.2.30 upstream)
- Revision ID: james.westby@ubuntu.com-20100928090321-1eq83h0ssvc5yfoq
Tags: 1.32.0-0ubuntu1
* New upstream release
- Fixes: #630097, #621717, #571622, #617851, #616812.
- Translation update.
* debian/patches/90-relibtoolize.patch: Refreshed
* debian/watch: Update to retrieve 1.32 version series
- Fixes: #630097, #621717, #571622, #617851, #616812.
- Translation update.
* debian/patches/90-relibtoolize.patch: Refreshed
* debian/watch: Update to retrieve 1.32 version series
- files added:
- po/hy.gmo
- files removed:
- atk/Atk-1.0.gir
- docs/xml
- files modified:
- INSTALL
added
removed
docs/html/atk-AtkState.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>AtkState</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="ATK - Accessibility Toolkit">
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkSelection.html" title="AtkSelection">
10
10
<link rel="next" href="AtkStateSet.html" title="AtkStateSet">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
<link rel="index" href="ix01.html" title="Index">
15
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
16
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
17
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
18
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
19
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
20
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
21
13
</head>
22
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
30
22
</tr>
31
23
<tr><td colspan="5" class="shortcuts">
32
24
<a href="#atk-AtkState.synopsis" class="shortcut">Top</a>
33
|
34
<a href="#atk-AtkState.description" class="shortcut">Description</a>
25
|
26
<a href="#atk-AtkState.description" class="shortcut">Description</a>
35
27
</td></tr>
36
28
</table>
37
29
<div class="refentry" title="AtkState">
45
37
</tr></table></div>
46
38
<div class="refsynopsisdiv" title="Synopsis">
47
39
<a name="atk-AtkState.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">
49
enum <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a>;
40
<pre class="synopsis">enum <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a>;
50
41
typedef <a class="link" href="atk-AtkState.html#AtkState" title="AtkState">AtkState</a>;
51
<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> <a class="link" href="atk-AtkState.html#atk-state-type-register" title="atk_state_type_register ()">atk_state_type_register</a> (const gchar *name);
52
const gchar* <a class="link" href="atk-AtkState.html#atk-state-type-get-name" title="atk_state_type_get_name ()">atk_state_type_get_name</a> (<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);
53
<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> <a class="link" href="atk-AtkState.html#atk-state-type-for-name" title="atk_state_type_for_name ()">atk_state_type_for_name</a> (const gchar *name);
42
<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> <a class="link" href="atk-AtkState.html#atk-state-type-register" title="atk_state_type_register ()">atk_state_type_register</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
43
const <span class="returnvalue">gchar</span>* <a class="link" href="atk-AtkState.html#atk-state-type-get-name" title="atk_state_type_get_name ()">atk_state_type_get_name</a> (<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> type</code></em>);
44
<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> <a class="link" href="atk-AtkState.html#atk-state-type-for-name" title="atk_state_type_for_name ()">atk_state_type_for_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
54
45
</pre>
55
46
</div>
56
47
<div class="refsect1" title="Description">
110
101
} AtkStateType;
111
102
</pre>
112
103
<p>
113
The possible types of states of an object</p>
114
<p>
104
The possible types of states of an object
115
105
</p>
116
106
<div class="variablelist"><table border="0">
117
107
<col align="left" valign="top">
118
108
<tbody>
119
109
<tr>
120
<td><p><a name="ATK-STATE-INVALID--CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID</code></span></p></td>
121
<td> Indicates an invalid state - probably an error condition.
122
</td>
123
</tr>
124
<tr>
125
<td><p><a name="ATK-STATE-ACTIVE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_ACTIVE</code></span></p></td>
126
<td> Indicates a window is currently the active window, or is an active subelement within a container or table
127
</td>
128
</tr>
129
<tr>
130
<td><p><a name="ATK-STATE-ARMED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_ARMED</code></span></p></td>
131
<td> Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation.
132
</td>
133
</tr>
134
<tr>
135
<td><p><a name="ATK-STATE-BUSY--CAPS"></a><span class="term"><code class="literal">ATK_STATE_BUSY</code></span></p></td>
136
<td> Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.
137
</td>
138
</tr>
139
<tr>
140
<td><p><a name="ATK-STATE-CHECKED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_CHECKED</code></span></p></td>
141
<td> Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
142
</td>
143
</tr>
144
<tr>
145
<td><p><a name="ATK-STATE-DEFUNCT--CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFUNCT</code></span></p></td>
146
<td> Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
147
</td>
148
</tr>
149
<tr>
150
<td><p><a name="ATK-STATE-EDITABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_EDITABLE</code></span></p></td>
151
<td> Indicates the user can change the contents of this object
152
</td>
153
</tr>
154
<tr>
155
<td><p><a name="ATK-STATE-ENABLED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_ENABLED</code></span></p></td>
156
<td> Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
157
</td>
158
</tr>
159
<tr>
160
<td><p><a name="ATK-STATE-EXPANDABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDABLE</code></span></p></td>
161
<td> Indicates this object allows progressive disclosure of its children
162
</td>
163
</tr>
164
<tr>
165
<td><p><a name="ATK-STATE-EXPANDED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDED</code></span></p></td>
166
<td> Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
167
</td>
168
</tr>
169
<tr>
170
<td><p><a name="ATK-STATE-FOCUSABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSABLE</code></span></p></td>
171
<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
172
</td>
173
</tr>
174
<tr>
175
<td><p><a name="ATK-STATE-FOCUSED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSED</code></span></p></td>
176
<td> Indicates this object currently has the keyboard focus
177
</td>
178
</tr>
179
<tr>
180
<td><p><a name="ATK-STATE-HORIZONTAL--CAPS"></a><span class="term"><code class="literal">ATK_STATE_HORIZONTAL</code></span></p></td>
181
<td> Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful.
182
</td>
183
</tr>
184
<tr>
185
<td><p><a name="ATK-STATE-ICONIFIED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_ICONIFIED</code></span></p></td>
186
<td> Indicates this object is minimized and is represented only by an icon
187
</td>
188
</tr>
189
<tr>
190
<td><p><a name="ATK-STATE-MODAL--CAPS"></a><span class="term"><code class="literal">ATK_STATE_MODAL</code></span></p></td>
191
<td> Indicates something must be done with this object before the user can interact with an object in a different window
192
</td>
193
</tr>
194
<tr>
195
<td><p><a name="ATK-STATE-MULTI-LINE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTI_LINE</code></span></p></td>
196
<td> Indicates this (text) object can contain multiple lines of text
197
</td>
198
</tr>
199
<tr>
200
<td><p><a name="ATK-STATE-MULTISELECTABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTISELECTABLE</code></span></p></td>
201
<td> Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
202
</td>
203
</tr>
204
<tr>
205
<td><p><a name="ATK-STATE-OPAQUE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_OPAQUE</code></span></p></td>
206
<td> Indicates this object paints every pixel within its rectangular region.
207
</td>
208
</tr>
209
<tr>
210
<td><p><a name="ATK-STATE-PRESSED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_PRESSED</code></span></p></td>
211
<td> Indicates this object is currently pressed; c.f. ATK_STATE_ARMED
212
</td>
213
</tr>
214
<tr>
215
<td><p><a name="ATK-STATE-RESIZABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_RESIZABLE</code></span></p></td>
216
<td> Indicates the size of this object is not fixed
217
</td>
218
</tr>
219
<tr>
220
<td><p><a name="ATK-STATE-SELECTABLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE</code></span></p></td>
221
<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
222
</td>
223
</tr>
224
<tr>
225
<td><p><a name="ATK-STATE-SELECTED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTED</code></span></p></td>
226
<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
227
</td>
228
</tr>
229
<tr>
230
<td><p><a name="ATK-STATE-SENSITIVE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SENSITIVE</code></span></p></td>
231
<td> Indicates this object is sensitive, e.g. to user interaction.
110
<td><p><a name="ATK-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID</code></span></p></td>
111
<td>Indicates an invalid state - probably an error condition.
112
</td>
113
</tr>
114
<tr>
115
<td><p><a name="ATK-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ACTIVE</code></span></p></td>
116
<td>Indicates a window is currently the active window, or is an active subelement within a container or table
117
</td>
118
</tr>
119
<tr>
120
<td><p><a name="ATK-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ARMED</code></span></p></td>
121
<td>Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation.
122
</td>
123
</tr>
124
<tr>
125
<td><p><a name="ATK-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_BUSY</code></span></p></td>
126
<td>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.
127
</td>
128
</tr>
129
<tr>
130
<td><p><a name="ATK-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_CHECKED</code></span></p></td>
131
<td>Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
132
</td>
133
</tr>
134
<tr>
135
<td><p><a name="ATK-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFUNCT</code></span></p></td>
136
<td>Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
137
</td>
138
</tr>
139
<tr>
140
<td><p><a name="ATK-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EDITABLE</code></span></p></td>
141
<td>Indicates the user can change the contents of this object
142
</td>
143
</tr>
144
<tr>
145
<td><p><a name="ATK-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ENABLED</code></span></p></td>
146
<td>Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
147
</td>
148
</tr>
149
<tr>
150
<td><p><a name="ATK-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDABLE</code></span></p></td>
151
<td>Indicates this object allows progressive disclosure of its children
152
</td>
153
</tr>
154
<tr>
155
<td><p><a name="ATK-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDED</code></span></p></td>
156
<td>Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
157
</td>
158
</tr>
159
<tr>
160
<td><p><a name="ATK-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSABLE</code></span></p></td>
161
<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
162
</td>
163
</tr>
164
<tr>
165
<td><p><a name="ATK-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSED</code></span></p></td>
166
<td>Indicates this object currently has the keyboard focus
167
</td>
168
</tr>
169
<tr>
170
<td><p><a name="ATK-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_HORIZONTAL</code></span></p></td>
171
<td>Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful.
172
</td>
173
</tr>
174
<tr>
175
<td><p><a name="ATK-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ICONIFIED</code></span></p></td>
176
<td>Indicates this object is minimized and is represented only by an icon
177
</td>
178
</tr>
179
<tr>
180
<td><p><a name="ATK-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MODAL</code></span></p></td>
181
<td>Indicates something must be done with this object before the user can interact with an object in a different window
182
</td>
183
</tr>
184
<tr>
185
<td><p><a name="ATK-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTI_LINE</code></span></p></td>
186
<td>Indicates this (text) object can contain multiple lines of text
187
</td>
188
</tr>
189
<tr>
190
<td><p><a name="ATK-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTISELECTABLE</code></span></p></td>
191
<td>Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
192
</td>
193
</tr>
194
<tr>
195
<td><p><a name="ATK-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_OPAQUE</code></span></p></td>
196
<td>Indicates this object paints every pixel within its rectangular region.
197
</td>
198
</tr>
199
<tr>
200
<td><p><a name="ATK-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_PRESSED</code></span></p></td>
201
<td>Indicates this object is currently pressed; c.f. ATK_STATE_ARMED
202
</td>
203
</tr>
204
<tr>
205
<td><p><a name="ATK-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_RESIZABLE</code></span></p></td>
206
<td>Indicates the size of this object is not fixed
207
</td>
208
</tr>
209
<tr>
210
<td><p><a name="ATK-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE</code></span></p></td>
211
<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
212
</td>
213
</tr>
214
<tr>
215
<td><p><a name="ATK-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTED</code></span></p></td>
216
<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
217
</td>
218
</tr>
219
<tr>
220
<td><p><a name="ATK-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SENSITIVE</code></span></p></td>
221
<td>Indicates this object is sensitive, e.g. to user interaction.
232
222
STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
233
223
but may be found in the absence of STATE_ENABLED if the current visible state of the
234
224
control is "disconnected" from the application state. In such cases, direct user interaction
238
228
</td>
239
229
</tr>
240
230
<tr>
241
<td><p><a name="ATK-STATE-SHOWING--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SHOWING</code></span></p></td>
242
<td> Indicates this object, the object's parent, the object's parent's parent, and so on,
231
<td><p><a name="ATK-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SHOWING</code></span></p></td>
232
<td>Indicates this object, the object's parent, the object's parent's parent, and so on,
243
233
are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose
244
234
between this object and the top of the window stack.
245
235
</td>
246
236
</tr>
247
237
<tr>
248
<td><p><a name="ATK-STATE-SINGLE-LINE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SINGLE_LINE</code></span></p></td>
249
<td> Indicates this (text) object can contain only a single line of text
238
<td><p><a name="ATK-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SINGLE_LINE</code></span></p></td>
239
<td>Indicates this (text) object can contain only a single line of text
250
240
</td>
251
241
</tr>
252
242
<tr>
253
<td><p><a name="ATK-STATE-STALE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_STALE</code></span></p></td>
254
<td> Indicates that the information returned for this object may no longer be
243
<td><p><a name="ATK-STATE-STALE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_STALE</code></span></p></td>
244
<td>Indicates that the information returned for this object may no longer be
255
245
synchronized with the application state. This is implied if the object has STATE_TRANSIENT,
256
246
and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that
257
247
the index associated with this object has changed since the user accessed the object (in lieu of
259
249
</td>
260
250
</tr>
261
251
<tr>
262
<td><p><a name="ATK-STATE-TRANSIENT--CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRANSIENT</code></span></p></td>
263
<td> Indicates this object is transient, i.e. a snapshot which may not emit events when its
252
<td><p><a name="ATK-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRANSIENT</code></span></p></td>
253
<td>Indicates this object is transient, i.e. a snapshot which may not emit events when its
264
254
state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no
265
255
notification given when the cached data becomes obsolete.
266
256
</td>
267
257
</tr>
268
258
<tr>
269
<td><p><a name="ATK-STATE-VERTICAL--CAPS"></a><span class="term"><code class="literal">ATK_STATE_VERTICAL</code></span></p></td>
270
<td> Indicates the orientation of this object is vertical
271
</td>
272
</tr>
273
<tr>
274
<td><p><a name="ATK-STATE-VISIBLE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISIBLE</code></span></p></td>
275
<td> Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
276
</td>
277
</tr>
278
<tr>
279
<td><p><a name="ATK-STATE-MANAGES-DESCENDANTS--CAPS"></a><span class="term"><code class="literal">ATK_STATE_MANAGES_DESCENDANTS</code></span></p></td>
280
<td> Indicates that "active-descendant-changed" event
259
<td><p><a name="ATK-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VERTICAL</code></span></p></td>
260
<td>Indicates the orientation of this object is vertical
261
</td>
262
</tr>
263
<tr>
264
<td><p><a name="ATK-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISIBLE</code></span></p></td>
265
<td>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
266
</td>
267
</tr>
268
<tr>
269
<td><p><a name="ATK-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MANAGES_DESCENDANTS</code></span></p></td>
270
<td>Indicates that "active-descendant-changed" event
281
271
is sent when children become 'active' (i.e. are selected or navigated to onscreen).
282
272
Used to prevent need to enumerate all children in very large containers, like tables.
283
273
The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
289
279
</td>
290
280
</tr>
291
281
<tr>
292
<td><p><a name="ATK-STATE-INDETERMINATE--CAPS"></a><span class="term"><code class="literal">ATK_STATE_INDETERMINATE</code></span></p></td>
293
<td> Indicates that a check box is in a state other than checked or not checked.
282
<td><p><a name="ATK-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INDETERMINATE</code></span></p></td>
283
<td>Indicates that a check box is in a state other than checked or not checked.
294
284
This usually means that the boolean value reflected or
295
285
controlled by the object does not apply consistently to the entire current context.
296
286
For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
301
291
</td>
302
292
</tr>
303
293
<tr>
304
<td><p><a name="ATK-STATE-TRUNCATED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRUNCATED</code></span></p></td>
305
<td> Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
306
</td>
307
</tr>
308
<tr>
309
<td><p><a name="ATK-STATE-REQUIRED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_REQUIRED</code></span></p></td>
310
<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.
311
</td>
312
</tr>
313
<tr>
314
<td><p><a name="ATK-STATE-INVALID-ENTRY--CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID_ENTRY</code></span></p></td>
315
<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.
316
</td>
317
</tr>
318
<tr>
319
<td><p><a name="ATK-STATE-SUPPORTS-AUTOCOMPLETION--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
320
<td> Indicates that the object in question implements some form of ¨typeahead¨ or
294
<td><p><a name="ATK-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRUNCATED</code></span></p></td>
295
<td>Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
296
</td>
297
</tr>
298
<tr>
299
<td><p><a name="ATK-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_REQUIRED</code></span></p></td>
300
<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.
301
</td>
302
</tr>
303
<tr>
304
<td><p><a name="ATK-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID_ENTRY</code></span></p></td>
305
<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.
306
</td>
307
</tr>
308
<tr>
309
<td><p><a name="ATK-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
310
<td>Indicates that the object in question implements some form of ¨typeahead¨ or
321
311
pre-selection behavior whereby entering the first character of one or more sub-elements
322
312
causes those elements to scroll into view or become selected. Subsequent character input
323
313
may narrow the selection further as long as one or more sub-elements match the string.
328
318
</td>
329
319
</tr>
330
320
<tr>
331
<td><p><a name="ATK-STATE-SELECTABLE-TEXT--CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE_TEXT</code></span></p></td>
321
<td><p><a name="ATK-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE_TEXT</code></span></p></td>
332
322
<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>ATK_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.
333
323
</td>
334
324
</tr>
335
325
<tr>
336
<td><p><a name="ATK-STATE-DEFAULT--CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFAULT</code></span></p></td>
337
<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.
326
<td><p><a name="ATK-STATE-DEFAULT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFAULT</code></span></p></td>
327
<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.
338
328
</td>
339
329
</tr>
340
330
<tr>
341
<td><p><a name="ATK-STATE-ANIMATED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_ANIMATED</code></span></p></td>
342
<td> Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
331
<td><p><a name="ATK-STATE-ANIMATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ANIMATED</code></span></p></td>
332
<td>Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
343
333
<em class="parameter"><code>note</code></em> some applications, notably content viewers, may not be able to detect
344
334
all kinds of animated content. Therefore the absence of this state should not
345
335
be taken as definitive evidence that the object's visual representation is
347
337
</td>
348
338
</tr>
349
339
<tr>
350
<td><p><a name="ATK-STATE-VISITED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISITED</code></span></p></td>
351
<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".
340
<td><p><a name="ATK-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISITED</code></span></p></td>
341
<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".
352
342
</td>
353
343
</tr>
354
344
<tr>
355
<td><p><a name="ATK-STATE-LAST-DEFINED--CAPS"></a><span class="term"><code class="literal">ATK_STATE_LAST_DEFINED</code></span></p></td>
356
<td> Not a valid state, used for finding end of enumeration
345
<td><p><a name="ATK-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_LAST_DEFINED</code></span></p></td>
346
<td>Not a valid state, used for finding end of enumeration
357
347
</td>
358
348
</tr>
359
349
</tbody>
371
361
<hr>
372
362
<div class="refsect2" title="atk_state_type_register ()">
373
363
<a name="atk-state-type-register"></a><h3>atk_state_type_register ()</h3>
374
<pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> atk_state_type_register (const gchar *name);</pre>
375
<p>
376
Register a new object state.</p>
377
<p>
364
<pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> atk_state_type_register (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
365
<p>
366
Register a new object state.
378
367
</p>
379
368
<div class="variablelist"><table border="0">
380
369
<col align="left" valign="top">
381
370
<tbody>
382
371
<tr>
383
372
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
384
<td> a character string describing the new state.
373
<td>a character string describing the new state.
385
374
</td>
386
375
</tr>
387
376
<tr>
395
384
<hr>
396
385
<div class="refsect2" title="atk_state_type_get_name ()">
397
386
<a name="atk-state-type-get-name"></a><h3>atk_state_type_get_name ()</h3>
398
<pre class="programlisting">const gchar* atk_state_type_get_name (<a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> type);</pre>
399
<p>
400
Gets the description string describing the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> <em class="parameter"><code>type</code></em>.</p>
401
<p>
387
<pre class="programlisting">const <span class="returnvalue">gchar</span>* atk_state_type_get_name (<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> type</code></em>);</pre>
388
<p>
389
Gets the description string describing the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> <em class="parameter"><code>type</code></em>.
402
390
</p>
403
391
<div class="variablelist"><table border="0">
404
392
<col align="left" valign="top">
405
393
<tbody>
406
394
<tr>
407
395
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
408
<td> The <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> whose name is required
396
<td>The <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> whose name is required
409
397
</td>
410
398
</tr>
411
399
<tr>
419
407
<hr>
420
408
<div class="refsect2" title="atk_state_type_for_name ()">
421
409
<a name="atk-state-type-for-name"></a><h3>atk_state_type_for_name ()</h3>
422
<pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a> atk_state_type_for_name (const gchar *name);</pre>
423
<p>
424
Gets the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to the description string <em class="parameter"><code>name</code></em>.</p>
425
<p>
410
<pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> atk_state_type_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
411
<p>
412
Gets the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to the description string <em class="parameter"><code>name</code></em>.
426
413
</p>
427
414
<div class="variablelist"><table border="0">
428
415
<col align="left" valign="top">
429
416
<tbody>
430
417
<tr>
431
418
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
432
<td> a character string state name
419
<td>a character string state name
433
420
</td>
434
421
</tr>
435
422
<tr>
444
431
</div>
445
432
<div class="footer">
446
433
<hr>
447
Generated by GTK-Doc V1.11</div>
434
Generated by GTK-Doc V1.15</div>
448
435
</body>
449
</html>
436
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1