| Current File : //kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-selection.html |
<!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: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<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-cell.html" title="atspi-table-cell">
<link rel="next" href="AtspiEventListener.html" title="AtspiEventListener">
<meta name="generator" content="GTK-Doc V1.33.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libatspi-atspi-selection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libatspi-atspi-selection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#libatspi-atspi-selection.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libatspi-atspi-table-cell.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtspiEventListener.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-selection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-selection.html#atspi-selection-select-child" title="atspi_selection_select_child ()">atspi_selection_select_child</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-selection.html#atspi-selection-deselect-child" title="atspi_selection_deselect_child ()">atspi_selection_deselect_child</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-selection.html#atspi-selection-select-all" title="atspi_selection_select_all ()">atspi_selection_select_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-selection.html#atspi-selection-clear-selection" title="atspi_selection_clear_selection ()">atspi_selection_clear_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtspiSelection"></a><div class="refsect1">
<a name="libatspi-atspi-selection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libatspi-atspi-selection.html#AtspiSelection-struct" title="AtspiSelection">AtspiSelection</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> 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>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="atspi-selection-get-n-selected-children.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-get-n-selected-children.returns"></a><h4>Returns</h4>
<p> 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.</p>
</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="refsect3">
<a name="atspi-selection-get-selected-child.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected_child_index</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which of the selected
children is specified.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-get-selected-child.returns"></a><h4>Returns</h4>
<p>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>
. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</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="refsect3">
<a name="atspi-selection-select-child.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child_index</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which child of the <span class="type">Accessible</span>
is to be selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-select-child.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the child was successfully selected, <span class="type">FALSE</span> otherwise.</p>
</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="refsect3">
<a name="atspi-selection-deselect-selected-child.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selected_child_index</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which of the selected children
of the <span class="type">Accessible</span> is to be selected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-deselect-selected-child.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the child was successfully deselected, <span class="type">FALSE</span> otherwise.</p>
</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="refsect3">
<a name="atspi-selection-deselect-child.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child_index</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-deselect-child.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the child was successfully deselected, <span class="type">FALSE</span> otherwise.</p>
</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="refsect3">
<a name="atspi-selection-is-child-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child_index</p></td>
<td class="parameter_description"><p>an index into the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>'s list of children.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-is-child-selected.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the specified child is currently selected,
<span class="type">FALSE</span> otherwise.</p>
</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="refsect3">
<a name="atspi-selection-select-all.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-select-all.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</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="refsect3">
<a name="atspi-selection-clear-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>obj</p></td>
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> implementor on which to operate.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-selection-clear-selection.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-selection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiSelection-struct"></a><h3>AtspiSelection</h3>
<pre class="programlisting">typedef struct _AtspiSelection AtspiSelection;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>