<html> <head> <title>Interface XAccessibleSelection</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleSelection-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleSelection" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleSelection</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to represent a selection of accessible objects. </dd> <dd><p>This interface is the standard mechanism to obtain and modify the currently selected children. Every object that has children that can be selected should support this interface.</p> <p>The <a href="XAccessibleSelection.html">XAccessibleSelection</a> interface has to be implemented in conjunction with the <a href="XAccessibleContext.html">XAccessibleContext</a> interface that provides the children on which the first operates.</p> <p>It depends on the class implementing this interface, whether it supports single or multi selection.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleSelection">Accessibility - XAccessibleSelection</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#selectAccessibleChild">selectAccessibleChild</a></td> <td class="imsum_right">Selects the specified <a href="Accessible.html">Accessible</a> child of the object. </td> </tr> <tr> <td class="imsum_left"><a href="#isAccessibleChildSelected">isAccessibleChildSelected</a></td> <td class="imsum_right">Determines if the specified child of this object is selected. </td> </tr> <tr> <td class="imsum_left"><a href="#clearAccessibleSelection">clearAccessibleSelection</a></td> <td class="imsum_right">Clears the selection, so that no children of the object are selected. </td> </tr> <tr> <td class="imsum_left"><a href="#selectAllAccessibleChildren">selectAllAccessibleChildren</a></td> <td class="imsum_right">Select all children. </td> </tr> <tr> <td class="imsum_left"><a href="#getSelectedAccessibleChildCount">getSelectedAccessibleChildCount</a></td> <td class="imsum_right">Returns the number of Accessible children that are currently selected. </td> </tr> <tr> <td class="imsum_left"><a href="#getSelectedAccessibleChild">getSelectedAccessibleChild</a></td> <td class="imsum_right">Returns the specified selected Accessible child. </td> </tr> <tr> <td class="imsum_left"><a href="#deselectAccessibleChild">deselectAccessibleChild</a></td> <td class="imsum_right">Removes the specified child from the set of this object's selected children. Note that not all applications support deselection: calls to this method may be silently ignored. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="selectAccessibleChild" class="membertitle">selectAccessibleChild</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>selectAccessibleChild</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nChildIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Selects the specified <a href="Accessible.html">Accessible</a> child of the object. </dd> <dd><p>Depending on the implementing class the child is added to the current set a selected children (multi selection) or a previously selected child is deselected first (single selection).</p> </dd> <dt><b>Parameter nChildIndex</b></dt> <dd>Index of the child which is to add to the selection. This index referes to all the children of this object. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of <a href="XAccessibleContext.html">XAccessibleContext</a>::<a href="XAccessibleContext.html#getAccessibleChildCount">getAccessibleChildCount()</a>-1. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isAccessibleChildSelected" class="membertitle">isAccessibleChildSelected</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isAccessibleChildSelected</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nChildIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Determines if the specified child of this object is selected. </dd> <dt><b>Parameter nChildIndex</b></dt> <dd>Index of the child for which to detect whether it is selected. This index referes to all the children of this object. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if the specified child is selected and <b>false</b> if it is not selected. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of <a href="XAccessibleContext.html">XAccessibleContext</a>::<a href="XAccessibleContext.html#getAccessibleChildCount">getAccessibleChildCount()</a>-1. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearAccessibleSelection" class="membertitle">clearAccessibleSelection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>clearAccessibleSelection</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Clears the selection, so that no children of the object are selected. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="selectAllAccessibleChildren" class="membertitle">selectAllAccessibleChildren</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>selectAllAccessibleChildren</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Select all children. </dd> <dd><p>Causes every child of the object to be selected if the object supports multiple selections. If multiple selection is not supported then the first child, if it exists, is selected and all other children are deselected.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSelectedAccessibleChildCount" class="membertitle">getSelectedAccessibleChildCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getSelectedAccessibleChildCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of Accessible children that are currently selected. </dd> <dd><p>This number specifies the valid interval of indices that can be used as arguments for the methods <a href="XAccessibleSelection.html">XAccessibleSelection</a>::<a href="XAccessibleSelection.html#getSelectedChild">getSelectedChild</a> and <a href="XAccessibleSelection.html">XAccessibleSelection</a>::<a href="XAccessibleSelection.html#deselectSelectedChild">deselectSelectedChild</a>.</p> </dd> <dt><b>Returns</b></dt> <dd>Returns the number of selected children of this object or 0 if no child is selected. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSelectedAccessibleChild" class="membertitle">getSelectedAccessibleChild</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XAccessible.html">XAccessible</a></td> </tr> <tr> <td valign="top"><b>getSelectedAccessibleChild</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSelectedChildIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the specified selected Accessible child. </dd> <dt><b>Parameter nSelectedChildIndex</b></dt> <dd>This index refers only to the selected children, not to all the children of this object. Even if all children are selected, the indices enumerating the selected children need not be the same as those enumerating all children. If only single selection is supported the only valid value is 0. </dd> <dt><b>Returns</b></dt> <dd>If the index is valid, i.e. not negative and lower than the number of selected children, then a valid reference to the corresponding <a href="XAccessible.html">XAccessible</a> child is returned. Otherwise an exception is thrown. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to the result of <a href="XAccessibleRelationSet.html">XAccessibleRelationSet</a>::<a href="XAccessibleRelationSet.html#getAccessibleChildCount">getAccessibleChildCount()</a>-1. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deselectAccessibleChild" class="membertitle">deselectAccessibleChild</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>deselectAccessibleChild</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nChildIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes the specified child from the set of this object's selected children. Note that not all applications support deselection: calls to this method may be silently ignored. </dd> <dt><b>Parameter nChildIndex</b></dt> <dd>This index refers to all children not just the selected ones. If the specified child is not selected or it can not be deselected for any reason then the method call is silently ignored. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index does not lie in the valid range of 0 up to, but not including, the result of <a href="#getAccessibleChildCount()">getAccessibleChildCount()</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
722
