/usr/share/gtk-doc/html/libatspi/libatspi-atspi-selection.html is in at-spi2-doc 2.4.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-selection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-table.html" title="atspi-table">
<link rel="next" href="AtspiEventListener.html" title="atspi-event-listener">
<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="libatspi-atspi-table.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libatspi Reference Manual</th>
<td><a accesskey="n" href="AtspiEventListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-selection.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-selection.description" class="shortcut">Description</a>
|
<a href="#libatspi-atspi-selection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libatspi-atspi-selection.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-selection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-selection.top_of_page"></a>atspi-selection</span></h2>
<p>atspi-selection — An interface which indicates that an object exposes a 'selection' model,
allowing the selection of one or more of its children.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-selection.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiSelection"></a><pre class="synopsis"> <a class="link" href="libatspi-atspi-selection.html#AtspiSelection-struct" title="AtspiSelection">AtspiSelection</a>;
<span class="returnvalue">gint</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-get-n-selected-children" title="atspi_selection_get_n_selected_children ()">atspi_selection_get_n_selected_children</a>
(<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * <a class="link" href="libatspi-atspi-selection.html#atspi-selection-get-selected-child" title="atspi_selection_get_selected_child ()">atspi_selection_get_selected_child</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selected_child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-select-child" title="atspi_selection_select_child ()">atspi_selection_select_child</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-deselect-selected-child" title="atspi_selection_deselect_selected_child ()">atspi_selection_deselect_selected_child</a>
(<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selected_child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-deselect-child" title="atspi_selection_deselect_child ()">atspi_selection_deselect_child</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-is-child-selected" title="atspi_selection_is_child_selected ()">atspi_selection_is_child_selected</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-select-all" title="atspi_selection_select_all ()">atspi_selection_select_all</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-selection.html#atspi-selection-clear-selection" title="atspi_selection_clear_selection ()">atspi_selection_clear_selection</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtspiSelection
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiSelection is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.description"></a><h2>Description</h2>
<p>
An interface which indicates that an object exposes a 'selection'
model, allowing the selection of one or more of its children.
Read-only Selection instances are possible, in which case the
interface is used to programmatically determine the selected-ness
of its children.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiSelection-struct"></a><h3>AtspiSelection</h3>
<pre class="programlisting">typedef struct _AtspiSelection AtspiSelection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-get-n-selected-children"></a><h3>atspi_selection_get_n_selected_children ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> atspi_selection_get_n_selected_children
(<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the number of children of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor which are
currently selected.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gint</span> indicating the number of <span class="type">Accessible</span> children
of the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor which are currently selected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-get-selected-child"></a><h3>atspi_selection_get_selected_child ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * atspi_selection_get_selected_child (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selected_child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the i-th selected <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
Note that <em class="parameter"><code>selected_child_index</code></em> refers to the index in the list
of 'selected'
children and generally differs from that used in
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-child-at-index" title="atspi_accessible_get_child_at_index ()"><span class="type">atspi_accessible_get_child_at_index</span></a> or returned by
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-index-in-parent" title="atspi_accessible_get_index_in_parent ()"><span class="type">atspi_accessible_get_index_in_parent</span></a>.
<em class="parameter"><code>selected_child_index</code></em> must lie between 0
and <a class="link" href="libatspi-atspi-selection.html#atspi-selection-get-n-selected-children" title="atspi_selection_get_n_selected_children ()"><span class="type">atspi_selection_get_n_selected_children</span></a> - 1, inclusive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selected_child_index</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which of the selected
children is specified.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a selected <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child
object, specified by <em class="parameter"><code>selected_child_index</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-select-child"></a><h3>atspi_selection_select_child ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_select_child (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Adds a child to the selected children list of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
For <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementors that only allow
single selections, this may replace the (single) current
selection.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_index</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which child of the <span class="type">Accessible</span>
is to be selected.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the child was successfully selected, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-deselect-selected-child"></a><h3>atspi_selection_deselect_selected_child ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_deselect_selected_child
(<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> selected_child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Removes a child from the selected children list of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
Note that <em class="parameter"><code>child_index</code></em> is the index in the selected-children list,
not the index in the parent container. <em class="parameter"><code>selectedChildIndex</code></em> in this
method, and <em class="parameter"><code>child_index</code></em> in <a class="link" href="libatspi-atspi-selection.html#atspi-selection-select-child" title="atspi_selection_select_child ()"><span class="type">atspi_selection_select_child</span></a>
are asymmetric.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>selected_child_index</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which of the selected children
of the <span class="type">Accessible</span> is to be selected.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the child was successfully deselected, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-deselect-child"></a><h3>atspi_selection_deselect_child ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_deselect_child (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Deselects a specific child of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
Note that <em class="parameter"><code>child_index</code></em> is the index of the child
in the parent container.
</p>
<p>
See <a class="link" href="libatspi-atspi-selection.html#atspi-selection-deselect-selected-child" title="atspi_selection_deselect_selected_child ()"><span class="type">atspi_selection_deselect_selected_child</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_index</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating which of the children
of the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> is to be de-selected.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the child was successfully deselected, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-is-child-selected"></a><h3>atspi_selection_is_child_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_is_child_selected (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Determines whether a particular child of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor
is currently selected. Note that <em class="parameter"><code>child_index</code></em> is the index into the
standard <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> container's list of children.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child_index</code></em> :</span></p></td>
<td>an index into the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>'s list of children.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the specified child is currently selected,
<span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-select-all"></a><h3>atspi_selection_select_all ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_select_all (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempts to select all of the children of an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor.
Not all <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementors support this operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-selection-clear-selection"></a><h3>atspi_selection_clear_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_selection_clear_selection (<em class="parameter"><code><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Clears the current selection, removing all selected children from the
specified <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor's selection list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|