4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>AtkSelection</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkRelationSet.html" title="AtkRelationSet">
10
10
<link rel="next" href="atk-AtkState.html" title="AtkState">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="atk.html" title="ATK Library">
14
14
<link rel="index" href="ix01.html" title="Index">
28
28
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
29
29
<td><a accesskey="n" href="atk-AtkState.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id371426" class="shortcut">Top</a>
33
<a href="#id372050" class="shortcut">Description</a>
35
<a href="#id371978" class="shortcut">Object Hierarchy</a>
37
<a href="#id372002" class="shortcut">Known Implementations</a>
39
<a href="#id372023" class="shortcut">Signals</a></nobr></td></tr>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id387493" class="shortcut">Top</a>
33
<a href="#id388117" class="shortcut">Description</a>
35
<a href="#id388046" class="shortcut">Object Hierarchy</a>
37
<a href="#id388069" class="shortcut">Known Implementations</a>
39
<a href="#id388091" class="shortcut">Signals</a></nobr></td></tr>
41
41
<div class="refentry" lang="en">
42
42
<a name="AtkSelection"></a><div class="titlepage"></div>
43
43
<div class="refnamediv"><table width="100%"><tr>
46
<a name="id371426"></a><span class="refentrytitle">AtkSelection</span>
46
<a name="id387493"></a><span class="refentrytitle">AtkSelection</span>
48
48
<p>AtkSelection —
49
The ATK interface implemented by container objects whose <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children
49
The ATK interface implemented by container objects whose <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children
50
50
can be selected.</p>
52
52
<td valign="top" align="right"></td>
60
<a href="AtkSelection.html#AtkSelection-struct">AtkSelection</a>;
61
gboolean <a href="AtkSelection.html#atk-selection-add-selection">atk_selection_add_selection</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
63
gboolean <a href="AtkSelection.html#atk-selection-clear-selection">atk_selection_clear_selection</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
64
<a href="AtkObject.html" title="AtkObject">AtkObject</a>* <a href="AtkSelection.html#atk-selection-ref-selection">atk_selection_ref_selection</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
66
gint <a href="AtkSelection.html#atk-selection-get-selection-count">atk_selection_get_selection_count</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
67
gboolean <a href="AtkSelection.html#atk-selection-is-child-selected">atk_selection_is_child_selected</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
69
gboolean <a href="AtkSelection.html#atk-selection-remove-selection">atk_selection_remove_selection</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
71
gboolean <a href="AtkSelection.html#atk-selection-select-all-selection">atk_selection_select_all_selection</a> (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
60
<a class="link" href="AtkSelection.html#AtkSelection-struct">AtkSelection</a>;
61
gboolean <a class="link" href="AtkSelection.html#atk-selection-add-selection">atk_selection_add_selection</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
63
gboolean <a class="link" href="AtkSelection.html#atk-selection-clear-selection">atk_selection_clear_selection</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
64
<a class="link" href="AtkObject.html" title="AtkObject">AtkObject</a>* <a class="link" href="AtkSelection.html#atk-selection-ref-selection">atk_selection_ref_selection</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
66
gint <a class="link" href="AtkSelection.html#atk-selection-get-selection-count">atk_selection_get_selection_count</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
67
gboolean <a class="link" href="AtkSelection.html#atk-selection-is-child-selected">atk_selection_is_child_selected</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
69
gboolean <a class="link" href="AtkSelection.html#atk-selection-remove-selection">atk_selection_remove_selection</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
71
gboolean <a class="link" href="AtkSelection.html#atk-selection-select-all-selection">atk_selection_select_all_selection</a> (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);
75
75
<div class="refsect1" lang="en">
76
<a name="id371978"></a><h2>Object Hierarchy</h2>
76
<a name="id388046"></a><h2>Object Hierarchy</h2>
77
77
<pre class="synopsis">
83
83
<div class="refsect1" lang="en">
84
<a name="id372002"></a><h2>Known Implementations</h2>
84
<a name="id388069"></a><h2>Known Implementations</h2>
86
86
AtkSelection is implemented by
87
<a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
87
<a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
89
89
<div class="refsect1" lang="en">
90
<a name="id372023"></a><h2>Signals</h2>
90
<a name="id388091"></a><h2>Signals</h2>
91
91
<pre class="synopsis">
93
"<a href="AtkSelection.html#AtkSelection-selection-changed">selection-changed</a>" : Run Last
93
"<a class="link" href="AtkSelection.html#AtkSelection-selection-changed">selection-changed</a>" : Run Last
96
96
<div class="refsect1" lang="en">
97
<a name="id372050"></a><h2>Description</h2>
97
<a name="id388117"></a><h2>Description</h2>
99
<a href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> should be implemented by UI components with children which
99
<a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> should be implemented by UI components with children which
100
100
are exposed by <span class="type">atk_object_ref_child</span> and <span class="type">atk_object_get_n_children</span>, if
101
101
the use of the parent UI component ordinarily involves selection of one
102
or more of the objects corresponding to those <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children - for
102
or more of the objects corresponding to those <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children - for
103
103
example, selectable lists.
106
106
Note that other types of "selection" (for instance text selection) are
107
accomplished a other ATK interfaces - <a href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> is limited to the
107
accomplished a other ATK interfaces - <a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> is limited to the
108
108
selection/deselection of children.
111
111
<div class="refsect1" lang="en">
112
<a name="id372113"></a><h2>Details</h2>
112
<a name="id388180"></a><h2>Details</h2>
113
113
<div class="refsect2" lang="en">
114
<a name="id372123"></a><h3>
114
<a name="id388190"></a><h3>
115
115
<a name="AtkSelection-struct"></a>AtkSelection</h3>
116
<a class="indexterm" name="id372136"></a><pre class="programlisting">typedef struct _AtkSelection AtkSelection;</pre>
116
<a class="indexterm" name="id388203"></a><pre class="programlisting">typedef struct _AtkSelection AtkSelection;</pre>
118
118
The AtkAction structure does not contain any fields.
123
123
<div class="refsect2" lang="en">
124
<a name="id372151"></a><h3>
124
<a name="id388218"></a><h3>
125
125
<a name="atk-selection-add-selection"></a>atk_selection_add_selection ()</h3>
126
<a class="indexterm" name="id372164"></a><pre class="programlisting">gboolean atk_selection_add_selection (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
126
<a class="indexterm" name="id388231"></a><pre class="programlisting">gboolean atk_selection_add_selection (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
129
129
Adds the specified accessible child of the object to the
135
135
<col align="left" valign="top">
138
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
138
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
139
139
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
143
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
143
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
144
144
<td> a <span class="type">gint</span> specifying the child index.
148
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
148
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
149
149
<td> TRUE if success, FALSE otherwise.
156
156
<div class="refsect2" lang="en">
157
<a name="id372261"></a><h3>
157
<a name="id388328"></a><h3>
158
158
<a name="atk-selection-clear-selection"></a>atk_selection_clear_selection ()</h3>
159
<a class="indexterm" name="id372274"></a><pre class="programlisting">gboolean atk_selection_clear_selection (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
159
<a class="indexterm" name="id388341"></a><pre class="programlisting">gboolean atk_selection_clear_selection (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
161
161
Clears the selection in the object so that no children in the object
162
162
are selected.</p>
167
167
<col align="left" valign="top">
170
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
170
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
171
171
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
175
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
175
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176
176
<td> TRUE if success, FALSE otherwise.
183
183
<div class="refsect2" lang="en">
184
<a name="id372342"></a><h3>
184
<a name="id388410"></a><h3>
185
185
<a name="atk-selection-ref-selection"></a>atk_selection_ref_selection ()</h3>
186
<a class="indexterm" name="id372355"></a><pre class="programlisting"><a href="AtkObject.html" title="AtkObject">AtkObject</a>* atk_selection_ref_selection (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
186
<a class="indexterm" name="id388422"></a><pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject">AtkObject</a>* atk_selection_ref_selection (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
189
189
Gets a reference to the accessible object representing the specified
199
199
<col align="left" valign="top">
202
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
202
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
203
203
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
207
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
207
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
208
208
<td> a <span class="type">gint</span> specifying the index in the selection set. (e.g. the
209
209
ith selection as opposed to the ith child).
213
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
214
<td> an <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the selected accessible , or <code class="literal">NULL</code>
213
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214
<td> an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the selected accessible , or <code class="literal">NULL</code>
215
215
if <em class="parameter"><code>selection</code></em> does not implement this interface.
222
222
<div class="refsect2" lang="en">
223
<a name="id372500"></a><h3>
223
<a name="id388567"></a><h3>
224
224
<a name="atk-selection-get-selection-count"></a>atk_selection_get_selection_count ()</h3>
225
<a class="indexterm" name="id372512"></a><pre class="programlisting">gint atk_selection_get_selection_count (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
225
<a class="indexterm" name="id388580"></a><pre class="programlisting">gint atk_selection_get_selection_count (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
227
227
Gets the number of accessible children currently selected.
228
228
Note: callers should not rely on <code class="literal">NULL</code> or on a zero value for
236
236
<col align="left" valign="top">
239
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
239
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
240
240
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
244
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
244
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
245
245
<td> a gint representing the number of items selected, or 0
246
246
if <em class="parameter"><code>selection</code></em> does not implement this interface.
253
253
<div class="refsect2" lang="en">
254
<a name="id372609"></a><h3>
254
<a name="id388677"></a><h3>
255
255
<a name="atk-selection-is-child-selected"></a>atk_selection_is_child_selected ()</h3>
256
<a class="indexterm" name="id372622"></a><pre class="programlisting">gboolean atk_selection_is_child_selected (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
256
<a class="indexterm" name="id388689"></a><pre class="programlisting">gboolean atk_selection_is_child_selected (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
259
259
Determines if the current child of this object is selected
268
268
<col align="left" valign="top">
271
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
271
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
272
272
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
276
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
276
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
277
277
<td> a <span class="type">gint</span> specifying the child index.
281
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
281
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
282
282
<td> a gboolean representing the specified child is selected, or 0
283
283
if <em class="parameter"><code>selection</code></em> does not implement this interface.
290
290
<div class="refsect2" lang="en">
291
<a name="id372747"></a><h3>
291
<a name="id388814"></a><h3>
292
292
<a name="atk-selection-remove-selection"></a>atk_selection_remove_selection ()</h3>
293
<a class="indexterm" name="id372760"></a><pre class="programlisting">gboolean atk_selection_remove_selection (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
293
<a class="indexterm" name="id388827"></a><pre class="programlisting">gboolean atk_selection_remove_selection (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection,
296
296
Removes the specified child of the object from the object's selection.</p>
301
301
<col align="left" valign="top">
304
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
304
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
305
305
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
309
<td><span class="term"><em class="parameter"><code>i</code></em> :</span></td>
309
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
310
310
<td> a <span class="type">gint</span> specifying the index in the selection set. (e.g. the
311
311
ith selection as opposed to the ith child).
315
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
315
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
316
316
<td> TRUE if success, FALSE otherwise.
323
323
<div class="refsect2" lang="en">
324
<a name="id372857"></a><h3>
324
<a name="id388924"></a><h3>
325
325
<a name="atk-selection-select-all-selection"></a>atk_selection_select_all_selection ()</h3>
326
<a class="indexterm" name="id372869"></a><pre class="programlisting">gboolean atk_selection_select_all_selection (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
326
<a class="indexterm" name="id388937"></a><pre class="programlisting">gboolean atk_selection_select_all_selection (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *selection);</pre>
328
328
Causes every child of the object to be selected if the object
329
329
supports multiple selections.</p>
334
334
<col align="left" valign="top">
337
<td><span class="term"><em class="parameter"><code>selection</code></em> :</span></td>
337
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
338
338
<td> a <span class="type">GObject</span> instance that implements AtkSelectionIface
342
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
342
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
343
343
<td> TRUE if success, FALSE otherwise.
350
350
<div class="refsect1" lang="en">
351
<a name="id372939"></a><h2>Signal Details</h2>
351
<a name="id389006"></a><h2>Signal Details</h2>
352
352
<div class="refsect2" lang="en">
353
<a name="id372949"></a><h3>
354
<a name="AtkSelection-selection-changed"></a>The "selection-changed" signal</h3>
355
<a class="indexterm" name="id372959"></a><pre class="programlisting">void user_function (<a href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *atkselection,
353
<a name="id389016"></a><h3>
354
<a name="AtkSelection-selection-changed"></a>The <code class="literal">"selection-changed"</code> signal</h3>
355
<a class="indexterm" name="id389032"></a><pre class="programlisting">void user_function (<a class="link" href="AtkSelection.html" title="AtkSelection">AtkSelection</a> *atkselection,
356
356
gpointer user_data) : Run Last</pre>
358
358
The "selection-changed" signal is emitted by an object which implements
362
362
<col align="left" valign="top">
365
<td><span class="term"><em class="parameter"><code>atkselection</code></em> :</span></td>
365
<td><p><span class="term"><em class="parameter"><code>atkselection</code></em> :</span></p></td>
366
366
<td>the object which received the signal.
371
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
371
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
372
372
<td>user data set when the signal handler was connected.</td>
378
378
<div class="refsect1" lang="en">
379
<a name="id373028"></a><h2>See Also</h2>
379
<a name="id389102"></a><h2>See Also</h2>
381
<a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
381
<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
384
<div class="refsect1" lang="en">
385
<a name="id389119"></a><div class="refsect2" lang="en"><a name="id389120"></a></div>
387
<div class="refsect2" lang="en"><a name="id389121"></a></div>