libatk1.0-doc 2.10.0-2ubuntu2 / usr / share / gtk-doc / html / atk / atk-AtkState.html

This file is indexed.

/usr/share/gtk-doc/html/atk/atk-AtkState.html is in libatk1.0-doc 2.10.0-2ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkState</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="atk-AtkSocket.html" title="AtkSocket">
<link rel="next" href="AtkStateSet.html" title="AtkStateSet">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="atk-AtkSocket.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkStateSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#atk-AtkState.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#atk-AtkState.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="atk-AtkState"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="atk-AtkState.top_of_page"></a>AtkState</span></h2>
<p>AtkState — An AtkState describes a component's particular state.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="atk-AtkState.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a>;
typedef             <a class="link" href="atk-AtkState.html#AtkState" title="AtkState">AtkState</a>;
<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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <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>);
<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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="atk-AtkState.description"></a><h2>Description</h2>
<p>
An AtkState describes a component's particular state. The actual
state of an component is described by its AtkStateSet, which is a
set of AtkStates.
</p>
</div>
<div class="refsect1">
<a name="atk-AtkState.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtkStateType"></a><h3>enum AtkStateType</h3>
<pre class="programlisting">typedef enum {
  ATK_STATE_INVALID,
  ATK_STATE_ACTIVE,
  ATK_STATE_ARMED,
  ATK_STATE_BUSY,
  ATK_STATE_CHECKED,
  ATK_STATE_DEFUNCT,
  ATK_STATE_EDITABLE,
  ATK_STATE_ENABLED,
  ATK_STATE_EXPANDABLE,
  ATK_STATE_EXPANDED,
  ATK_STATE_FOCUSABLE,
  ATK_STATE_FOCUSED,
  ATK_STATE_HORIZONTAL,
  ATK_STATE_ICONIFIED,
  ATK_STATE_MODAL,
  ATK_STATE_MULTI_LINE,
  ATK_STATE_MULTISELECTABLE,
  ATK_STATE_OPAQUE,
  ATK_STATE_PRESSED,
  ATK_STATE_RESIZABLE,
  ATK_STATE_SELECTABLE,
  ATK_STATE_SELECTED,
  ATK_STATE_SENSITIVE,
  ATK_STATE_SHOWING,
  ATK_STATE_SINGLE_LINE,
  ATK_STATE_STALE,
  ATK_STATE_TRANSIENT,
  ATK_STATE_VERTICAL,
  ATK_STATE_VISIBLE,
  ATK_STATE_MANAGES_DESCENDANTS,
  ATK_STATE_INDETERMINATE,
  ATK_STATE_TRUNCATED,
  ATK_STATE_REQUIRED,
  ATK_STATE_INVALID_ENTRY,
  ATK_STATE_SUPPORTS_AUTOCOMPLETION,
  ATK_STATE_SELECTABLE_TEXT,
  ATK_STATE_DEFAULT,
  ATK_STATE_ANIMATED,
  ATK_STATE_VISITED,
	
  ATK_STATE_LAST_DEFINED
} AtkStateType;
</pre>
<p>
The possible types of states of an object
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ATK-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID</code></span></p></td>
<td>Indicates an invalid state - probably an error condition.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ACTIVE</code></span></p></td>
<td>Indicates a window is currently the active window, or is an active subelement within a container or table
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ARMED</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_BUSY</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_CHECKED</code></span></p></td>
<td>Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFUNCT</code></span></p></td>
<td>Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EDITABLE</code></span></p></td>
<td>Indicates the user can change the contents of this object
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ENABLED</code></span></p></td>
<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
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDABLE</code></span></p></td>
<td>Indicates this object allows progressive disclosure of its children
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDED</code></span></p></td>
<td>Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSABLE</code></span></p></td>
<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
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSED</code></span></p></td>
<td>Indicates this object currently has the keyboard focus
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_HORIZONTAL</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ICONIFIED</code></span></p></td>
<td>Indicates this object is minimized and is represented only by an icon
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MODAL</code></span></p></td>
<td>Indicates something must be done with this object before the user can interact with an object in a different window
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTI_LINE</code></span></p></td>
<td>Indicates this (text) object can contain multiple lines of text
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTISELECTABLE</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_OPAQUE</code></span></p></td>
<td>Indicates this object paints every pixel within its rectangular region.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_PRESSED</code></span></p></td>
<td>Indicates this object is currently pressed; c.f. ATK_STATE_ARMED
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_RESIZABLE</code></span></p></td>
<td>Indicates the size of this object is not fixed
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE</code></span></p></td>
<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
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTED</code></span></p></td>
<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
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SENSITIVE</code></span></p></td>
<td>Indicates this object is sensitive, e.g. to user interaction. 
STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
but may be found in the absence of STATE_ENABLED if the current visible state of the 
control is "disconnected" from the application state.  In such cases, direct user interaction
can often result in the object gaining STATE_SENSITIVE, for instance if a user makes 
an explicit selection using an object whose current state is ambiguous or undefined.
<em class="parameter"><code>see</code></em> STATE_ENABLED, STATE_INDETERMINATE.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SHOWING</code></span></p></td>
<td>Indicates this object, the object's parent, the object's parent's parent, and so on, 
are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose
between this object and the top of the window stack.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SINGLE_LINE</code></span></p></td>
<td>Indicates this (text) object can contain only a single line of text
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-STALE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_STALE</code></span></p></td>
<td>Indicates that the information returned for this object may no longer be
synchronized with the application state.  This is implied if the object has STATE_TRANSIENT,
and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that 
the index associated with this object has changed since the user accessed the object (in lieu of
"index-in-parent-changed" events).
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRANSIENT</code></span></p></td>
<td>Indicates this object is transient, i.e. a snapshot which may not emit events when its
state changes.  Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no
notification given when the cached data becomes obsolete.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VERTICAL</code></span></p></td>
<td>Indicates the orientation of this object is vertical
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISIBLE</code></span></p></td>
<td>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MANAGES_DESCENDANTS</code></span></p></td>
<td>Indicates that "active-descendant-changed" event
is sent when children become 'active' (i.e. are selected or navigated to onscreen).
Used to prevent need to enumerate all children in very large containers, like tables.
The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
that the children should not, and need not, be enumerated by the client.
Objects implementing this state are expected to provide relevant state
notifications to listening clients, for instance notifications of visibility
changes and activation of their contained child objects, without the client 
having previously requested references to those children.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INDETERMINATE</code></span></p></td>
<td>Indicates that a check box is in a state other than checked or not checked.
This usually means that the boolean value reflected or 
controlled by the object does not apply consistently to the entire current context.
For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
if the currently selected text contains a mixture of weight attributes.  
In many cases interacting with a STATE_INDETERMINATE object will cause 
the context's corresponding boolean attribute to be homogenized, whereupon the object
will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRUNCATED</code></span></p></td>
<td>Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_REQUIRED</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID_ENTRY</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
<td>Indicates that the object in question implements some form of ¨typeahead¨ or 
pre-selection behavior whereby entering the first character of one or more sub-elements
causes those elements to scroll into view or become selected.  Subsequent character input
may narrow the selection further as long as one or more sub-elements match the string.
This state is normally only useful and encountered on objects that implement Selection.
In some cases the typeahead behavior may result in full or partial ¨completion¨ of 
the data in the input field, in which case these input events may trigger text-changed
events from the AtkText interface.  This state supplants <em class="parameter"><code>ATK_ROLE_AUTOCOMPLETE</code></em>.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE_TEXT</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-DEFAULT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFAULT</code></span></p></td>
<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.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-ANIMATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ANIMATED</code></span></p></td>
<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.
<em class="parameter"><code>note</code></em> some applications, notably content viewers, may not be able to detect
all kinds of animated content.  Therefore the absence of this state should not
be taken as definitive evidence that the object's visual representation is
static; this state is advisory.
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISITED</code></span></p></td>
<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".
</td>
</tr>
<tr>
<td><p><a name="ATK-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_LAST_DEFINED</code></span></p></td>
<td>Not a valid state, used for finding end of enumeration
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AtkState"></a><h3>AtkState</h3>
<pre class="programlisting">typedef guint64      AtkState;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-state-type-register"></a><h3>atk_state_type_register ()</h3>
<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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Register a new object state.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a character string describing the new state.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> value for the new state.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-state-type-get-name"></a><h3>atk_state_type_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
<p>
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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> whose name is required</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the string describing the AtkStateType</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-state-type-for-name"></a><h3>atk_state_type_for_name ()</h3>
<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 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a character string state name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to <em class="parameter"><code>name</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.