/usr/share/gtk-doc/html/atk/AtkSelection.html is in libatk1.0-doc 2.4.0-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkSelection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkRelationSet.html" title="AtkRelationSet">
<link rel="next" href="atk-AtkSocket.html" title="AtkSocket">
<meta name="generator" content="GTK-Doc V1.18 (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="AtkRelationSet.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="atk-AtkSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AtkSelection.synopsis" class="shortcut">Top</a>
|
<a href="#AtkSelection.description" class="shortcut">Description</a>
|
<a href="#AtkSelection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#AtkSelection.implementations" class="shortcut">Known Implementations</a>
|
<a href="#AtkSelection.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="AtkSelection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkSelection.top_of_page"></a>AtkSelection</span></h2>
<p>AtkSelection — The ATK interface implemented by container objects whose <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children
can be selected.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtkSelection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="AtkSelection.html#AtkSelection-struct" title="AtkSelection">AtkSelection</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkSelection.html#atk-selection-add-selection" title="atk_selection_add_selection ()">atk_selection_add_selection</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkSelection.html#atk-selection-clear-selection" title="atk_selection_clear_selection ()">atk_selection_clear_selection</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * <a class="link" href="AtkSelection.html#atk-selection-ref-selection" title="atk_selection_ref_selection ()">atk_selection_ref_selection</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="AtkSelection.html#atk-selection-get-selection-count" title="atk_selection_get_selection_count ()">atk_selection_get_selection_count</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkSelection.html#atk-selection-is-child-selected" title="atk_selection_is_child_selected ()">atk_selection_is_child_selected</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkSelection.html#atk-selection-remove-selection" title="atk_selection_remove_selection ()">atk_selection_remove_selection</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkSelection.html#atk-selection-select-all-selection" title="atk_selection_select_all_selection ()">atk_selection_select_all_selection</a> (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="AtkSelection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkSelection
</pre>
</div>
<div class="refsect1">
<a name="AtkSelection.implementations"></a><h2>Known Implementations</h2>
<p>
AtkSelection is implemented by
<a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1">
<a name="AtkSelection.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="AtkSelection.html#AtkSelection-selection-changed" title='The "selection-changed" signal'>selection-changed</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="AtkSelection.description"></a><h2>Description</h2>
<p>
<a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> should be implemented by UI components with children which
are exposed by <span class="type">atk_object_ref_child</span> and <span class="type">atk_object_get_n_children</span>, if
the use of the parent UI component ordinarily involves selection of one
or more of the objects corresponding to those <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> children - for
example, selectable lists.
</p>
<p>
Note that other types of "selection" (for instance text selection) are
accomplished a other ATK interfaces - <a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> is limited to the
selection/deselection of children.
</p>
</div>
<div class="refsect1">
<a name="AtkSelection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtkSelection-struct"></a><h3>AtkSelection</h3>
<pre class="programlisting">typedef struct _AtkSelection AtkSelection;</pre>
<p>
The AtkAction structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-add-selection"></a><h3>atk_selection_add_selection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_selection_add_selection (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>
Adds the specified accessible child of the object to the
object's selection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the child index.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if success, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-clear-selection"></a><h3>atk_selection_clear_selection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_selection_clear_selection (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);</pre>
<p>
Clears the selection in the object so that no children in the object
are selected.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if success, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-ref-selection"></a><h3>atk_selection_ref_selection ()</h3>
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * atk_selection_ref_selection (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>
Gets a reference to the accessible object representing the specified
selected child of the object.
Note: callers should not rely on <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
<code class="function">atk_get_accessible_value()</code> convenience method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the index in the selection set. (e.g. the
ith selection as opposed to the ith child).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> representing the selected
accessible , or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>selection</code></em> does not implement this interface. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-get-selection-count"></a><h3>atk_selection_get_selection_count ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> atk_selection_get_selection_count (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);</pre>
<p>
Gets the number of accessible children currently selected.
Note: callers should not rely on <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
<code class="function">atk_get_accessible_value()</code> convenience method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a gint representing the number of items selected, or 0
if <em class="parameter"><code>selection</code></em> does not implement this interface.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-is-child-selected"></a><h3>atk_selection_is_child_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_selection_is_child_selected (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>
Determines if the current child of this object is selected
Note: callers should not rely on <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or on a zero value for
indication of whether AtkSelectionIface is implemented, they should
use type checking/interface checking macros or the
<code class="function">atk_get_accessible_value()</code> convenience method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the child index.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a gboolean representing the specified child is selected, or 0
if <em class="parameter"><code>selection</code></em> does not implement this interface.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-remove-selection"></a><h3>atk_selection_remove_selection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_selection_remove_selection (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
<p>
Removes the specified child of the object from the object's selection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> specifying the index in the selection set. (e.g. the
ith selection as opposed to the ith child).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if success, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-selection-select-all-selection"></a><h3>atk_selection_select_all_selection ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_selection_select_all_selection (<em class="parameter"><code><a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *selection</code></em>);</pre>
<p>
Causes every child of the object to be selected if the object
supports multiple selections.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance that implements AtkSelectionIface</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if success, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="AtkSelection.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AtkSelection-selection-changed"></a><h3>The <code class="literal">"selection-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkSelection.html" title="AtkSelection"><span class="type">AtkSelection</span></a> *atkselection,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "selection-changed" signal is emitted by an object which implements
AtkSelection interface when the selection changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>atkselection</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="AtkSelection.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|