<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Selection Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Selection.html">Accessibility::Selection</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::Selection Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Selection" -->
<p><code>import "<a class="el" href="Accessibility__Selection_8idl_source.html">Accessibility_Selection.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" 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#aebc94ae86bca8bb0320fc2dacdeab656">getSelectedChild</a> (in long selectedChildIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#ac30a7385afa1c6cba907890fd6f55d6f">selectChild</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#ac97efd8694500609d66213f0aa9e05a9">deselectSelectedChild</a> (in long selectedChildIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a123a8908e194a4f98751ebecdd3b680e">isChildSelected</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a7da6ee19f32140f6c81d5028fbe2e11e">selectAll</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a5aacf20c047d18db1e618d0114cc5bb3">clearSelection</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a3e231f4f137238d83f07ccf2481312f8">deselectChild</a> (in long childIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a45038e16e28cd134ed737f3cf917f113">unImplemented</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a10039dc454b26ada632e168fbb165df2">unImplemented2</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a7d4f4a755cf4c3118d9c774c69e1a7ff">unImplemented3</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Selection.html#a84fcf301cc408eee5b86904454f987bc">nSelectedChildren</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed 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 <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. </p>
<dl class="note"><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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5aacf20c047d18db1e618d0114cc5bb3"></a><!-- doxytag: member="Accessibility::Selection::clearSelection" ref="a5aacf20c047d18db1e618d0114cc5bb3" 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></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"><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"><dt><b>Returns:</b></dt><dd><code>True</code> if the selections were successfully cleared, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a3e231f4f137238d83f07ccf2481312f8"></a><!-- doxytag: member="Accessibility::Selection::deselectChild" ref="a3e231f4f137238d83f07ccf2481312f8" 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></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"><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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully selected, <code>False</code> otherwise.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Selection.html#ac97efd8694500609d66213f0aa9e05a9">deselectSelectedChild</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>AT-SPI 1.8.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac97efd8694500609d66213f0aa9e05a9"></a><!-- doxytag: member="Accessibility::Selection::deselectSelectedChild" ref="ac97efd8694500609d66213f0aa9e05a9" 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></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>. </p>
<dl class="note"><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#ac30a7385afa1c6cba907890fd6f55d6f">Selection::selectChild</a> are asymmettric.</dd></dl>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully deselected, <code>False</code> otherwise.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Selection.html#a3e231f4f137238d83f07ccf2481312f8">deselectChild</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aebc94ae86bca8bb0320fc2dacdeab656"></a><!-- doxytag: member="Accessibility::Selection::getSelectedChild" ref="aebc94ae86bca8bb0320fc2dacdeab656" 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></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>. </p>
<dl class="note"><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#a448e709e5dc7065b6a0cd5cbc5a4e649">Accessible::getChildAtIndex()</a> or returned by <a class="el" href="interfaceAccessibility_1_1Accessible.html#ae11e9d81f6bb60f77e7020fc65adbe32">Accessible::getIndexInParent()</a>. <code>selectedChildIndex</code> must lie between 0 and <a class="el" href="interfaceAccessibility_1_1Selection.html#a84fcf301cc408eee5b86904454f987bc">Selection::nSelectedChildren</a>-1, inclusive. </dd></dl>
<dl><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a123a8908e194a4f98751ebecdd3b680e"></a><!-- doxytag: member="Accessibility::Selection::isChildSelected" ref="a123a8908e194a4f98751ebecdd3b680e" 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></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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the specified child is currently selected, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a7da6ee19f32140f6c81d5028fbe2e11e"></a><!-- doxytag: member="Accessibility::Selection::selectAll" ref="a7da6ee19f32140f6c81d5028fbe2e11e" 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></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"><dt><b>Returns:</b></dt><dd><code>True</code> if successful, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ac30a7385afa1c6cba907890fd6f55d6f"></a><!-- doxytag: member="Accessibility::Selection::selectChild" ref="ac30a7385afa1c6cba907890fd6f55d6f" 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></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>. </p>
<dl class="note"><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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the child was successfully selected, <code>False</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a45038e16e28cd134ed737f3cf917f113"></a><!-- doxytag: member="Accessibility::Selection::unImplemented" ref="a45038e16e28cd134ed737f3cf917f113" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>unImplemented:</p>
<p>placeholders for future expansion. </p>
</div>
</div>
<a class="anchor" id="a10039dc454b26ada632e168fbb165df2"></a><!-- doxytag: member="Accessibility::Selection::unImplemented2" ref="a10039dc454b26ada632e168fbb165df2" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d4f4a755cf4c3118d9c774c69e1a7ff"></a><!-- doxytag: member="Accessibility::Selection::unImplemented3" ref="a7d4f4a755cf4c3118d9c774c69e1a7ff" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a84fcf301cc408eee5b86904454f987bc"></a><!-- doxytag: member="Accessibility::Selection::nSelectedChildren" ref="a84fcf301cc408eee5b86904454f987bc" 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#a84fcf301cc408eee5b86904454f987bc">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. </p>
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
