<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>at-spi-idl: Accessibility::Selection Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a></div>
<h1>Accessibility::Selection Interface Reference</h1><!-- doxytag: class="Accessibility::Selection" --><code>import "<a class="el" href="Accessibility__Selection_8idl-source.html">Accessibility_Selection.idl</a>";</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#b1d6fbf2d310ee96438597734ca2043f">getSelectedChild</a> (in long selectedChildIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#6fcc1ea545779beb50c89c37d1e138f7">selectChild</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#ae4ad5000d8458bd2b401deb1529ef3f">deselectSelectedChild</a> (in long selectedChildIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#96ca47404ad8f9b4b9fa47fa9d7220e4">isChildSelected</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#c766bfc86baf72724013a7d3cd8f204b">selectAll</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#c5f3783f821d518957a69958de8e9f88">clearSelection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#80f2c655f04354903d265b678dca99af">deselectChild</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#48fd049ae266477efe389ff6125a1cef">unImplemented</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#43e7415f8bd7a8f90256aea6feef056e">unImplemented2</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#fc798815b1d9ee44c16441d4b3f1447e">unImplemented3</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#7dee6f2d5c19d12dd8f8a1efd4544640">nSelectedChildren</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An interface which indicates that an object exposes a 'selection' model, allowing the selection of one or more of its children. Read-only <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> instances are possible, in which case the interface is used to programmatically determine the selected-ness of its children. A selected child has State::STATE_SELECTED, and a child which may hypothetically be selected (though possibly not programmatically selectable) has State::STATE_SELECTABLE. <dl class="note" compact><dt><b>Note:</b></dt><dd>Events emitted by implementors of <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> include: <ul>
<li><code>"object:selection-changed"</code> An instance of <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> has undergone a change in the 'selected-ness' of its children, i.e. had a selection added, removed, and/or modified. Usually accompanied by corresponding <code>"object:state-changed:selected"</code> events from the corresponding children, unless the children are previously un-queried via AT-SPI and the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> instance has State::STATE_MANAGES_DESCENDANTS. </li>
</ul>
</dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b1d6fbf2d310ee96438597734ca2043f"></a><!-- doxytag: member="Accessibility::Selection::getSelectedChild" ref="b1d6fbf2d310ee96438597734ca2043f" args="(in long selectedChildIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Selection::getSelectedChild </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>selectedChildIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the i-th selected <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> child of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>. <dl class="note" compact><dt><b>Note:</b></dt><dd><code>selectedChildIndex</code> refers to the index in the list of 'selected' children as opposed to the more general 'child index' of an object; as such it generally differs from that used in <a class="el" href="interfaceAccessibility_1_1Accessible.html#6381e601a679708ae5afb1fd35db3b62">Accessible::getChildAtIndex()</a> or returned by <a class="el" href="interfaceAccessibility_1_1Accessible.html#1d6f8f5b86a368b4dee012db0d5e6ab8">Accessible::getIndexInParent()</a>. <code>selectedChildIndex</code> must lie between 0 and <a class="el" href="interfaceAccessibility_1_1Selection.html#7dee6f2d5c19d12dd8f8a1efd4544640">Selection::nSelectedChildren</a>-1, inclusive. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>selectedChildIndex,:</em> </td><td>a long integer indicating which of the selected children of an object is being requested. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to a selected <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> child object, specified by <code>selectedChildIndex</code>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6fcc1ea545779beb50c89c37d1e138f7"></a><!-- doxytag: member="Accessibility::Selection::selectChild" ref="6fcc1ea545779beb50c89c37d1e138f7" args="(in long childIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::selectChild </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>childIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a child to the selected children list of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>. <dl class="note" compact><dt><b>Note:</b></dt><dd>For <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementors that only allow single selections, this call may result in the replacement of the (single) current selection. The call may return <code>False</code> if the child is not selectable (i.e. does not have State::STATE_SELECTABLE), if the user does not have permission to change the selection, or if the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> instance does not have State::STATE_SENSITIVE.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>childIndex,:</em> </td><td>a long integer indicating which child of the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> is to be selected.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully selected, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ae4ad5000d8458bd2b401deb1529ef3f"></a><!-- doxytag: member="Accessibility::Selection::deselectSelectedChild" ref="ae4ad5000d8458bd2b401deb1529ef3f" args="(in long selectedChildIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::deselectSelectedChild </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>selectedChildIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a child to the selected children list of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>. <dl class="note" compact><dt><b>Note:</b></dt><dd><code>childIndex</code> is the index in the selected-children list, not the index in the parent container. <code>selectedChildIndex</code> in this method, and <code>childIndex</code> in <a class="el" href="interfaceAccessibility_1_1Selection.html#6fcc1ea545779beb50c89c37d1e138f7">Selection::selectChild</a> are asymmettric.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>selectedChildIndex,:</em> </td><td>a long integer indicating which of the selected children of the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> is to be deselected. The index is a zero-offset index into the 'selected child list', not a zero-offset index into the list of all children of the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully deselected, <code>False</code> otherwise.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Selection.html#80f2c655f04354903d265b678dca99af">deselectChild</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="96ca47404ad8f9b4b9fa47fa9d7220e4"></a><!-- doxytag: member="Accessibility::Selection::isChildSelected" ref="96ca47404ad8f9b4b9fa47fa9d7220e4" args="(in long childIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::isChildSelected </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>childIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine whether a particular child of an <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementor is currently selected. Note that <code>childIndex</code> is the zero-offset index into the standard <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> container's list of children.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>childIndex,:</em> </td><td>an index into the Selection's list of children.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the specified child is currently selected, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c766bfc86baf72724013a7d3cd8f204b"></a><!-- doxytag: member="Accessibility::Selection::selectAll" ref="c766bfc86baf72724013a7d3cd8f204b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::selectAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempt to select all of the children of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementor. Not all <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementors support this operation (for instance, implementations which support only "single selection" do not support this operation).<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if successful, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c5f3783f821d518957a69958de8e9f88"></a><!-- doxytag: member="Accessibility::Selection::clearSelection" ref="c5f3783f821d518957a69958de8e9f88" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::clearSelection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempt to clear all selections (i.e. deselect all children) of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>. Not all <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementations allow the removal of all selections.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>this operation may fail if the object must have at least one selected child, if the user does not have permission to change the selection, or if the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> does not have State::STATE_SENSITIVE.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the selections were successfully cleared, <code>False</code> otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="80f2c655f04354903d265b678dca99af"></a><!-- doxytag: member="Accessibility::Selection::deselectChild" ref="80f2c655f04354903d265b678dca99af" args="(in long childIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Selection::deselectChild </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>childIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a child from the selected children list of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a>, if the child is currently selected.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>unlike deselectSelectedChild, <code>childIndex</code> is the zero-offset index into the <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> instance's list of children, not the index into the 'selected child list'.</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>childIndex,:</em> </td><td>a long integer (the zero offset index into the <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> object's list of children) indicating which child of the <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> is to be selected.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully selected, <code>False</code> otherwise.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Selection.html#ae4ad5000d8458bd2b401deb1529ef3f">deselectSelectedChild</a></dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>AT-SPI 1.8.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="48fd049ae266477efe389ff6125a1cef"></a><!-- doxytag: member="Accessibility::Selection::unImplemented" ref="48fd049ae266477efe389ff6125a1cef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Selection::unImplemented </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
unImplemented:<p>
placeholders for future expansion.
</div>
</div><p>
<a class="anchor" name="43e7415f8bd7a8f90256aea6feef056e"></a><!-- doxytag: member="Accessibility::Selection::unImplemented2" ref="43e7415f8bd7a8f90256aea6feef056e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Selection::unImplemented2 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="fc798815b1d9ee44c16441d4b3f1447e"></a><!-- doxytag: member="Accessibility::Selection::unImplemented3" ref="fc798815b1d9ee44c16441d4b3f1447e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::Selection::unImplemented3 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="7dee6f2d5c19d12dd8f8a1efd4544640"></a><!-- doxytag: member="Accessibility::Selection::nSelectedChildren" ref="7dee6f2d5c19d12dd8f8a1efd4544640" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Selection.html#7dee6f2d5c19d12dd8f8a1efd4544640">Accessibility::Selection::nSelectedChildren</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of children of a <a class="el" href="interfaceAccessibility_1_1Selection.html">Selection</a> implementor which are currently selected.
</div>
</div><p>
<hr>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Selection_8idl-source.html">Accessibility_Selection.idl</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
