<html> <head> <title>Interface XMultiSelectionSupplier</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="XMultiSelectionSupplier-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">view</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XMultiSelectionSupplier</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XMultiSelectionSupplier</strong> ┗ <a href="XSelectionSupplier.html">XSelectionSupplier</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XSelectionSupplier.html">XSelectionSupplier</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>makes it possible to access and change the selection in a view. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>makes it possible to append and remove objects from a selection. </dd> <dd><p>The method <method>XSelectionSupplier::setSelection</method> for an instance that also supports </method> should be implemented that it also takes either a selectable object or a sequence of selectable objects.</p> <p>Adding an object more than once to a selection should not toggle the selection for that object but only select it once</p> </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="#addSelection">addSelection</a></td> <td class="imsum_right">adds the object or the objects represented by <var>Selection</var> to the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#removeSelection">removeSelection</a></td> <td class="imsum_right">remove the object or objects represented by <var>Selection</var> from the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#clearSelection">clearSelection</a></td> <td class="imsum_right">clears the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#getSelectionCount">getSelectionCount</a></td> <td class="imsum_right">returns the number of selected objects of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#createSelectionEnumeration">createSelectionEnumeration</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#createReverseSelectionEnumeration">createReverseSelectionEnumeration</a></td> <td class="imsum_right"> </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="addSelection" class="membertitle">addSelection</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>addSelection</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Selection )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds the object or the objects represented by <var>Selection</var> to the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </dd> <dt><b>Parameter Selection</b></dt> <dd>either an Object that is selectable or a sequence of objects that are selectable. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>/, if <var>Selection</var> was added to the current selection. <b>false</b>, if <var>Selection</var> or parts of <var>Selection</var> could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with <var>Selection</var> @raises com::sun::star::lang::IllegalArgumentException If <var>Selection</var> is not a selectable object for this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. <p>Adding an object to the selection that is already part of the selection should not raise this exception</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeSelection" class="membertitle">removeSelection</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>removeSelection</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Selection )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove the object or objects represented by <var>Selection</var> from the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </dd> <dt><b>Parameter Selection</b></dt> <dd>either an Object that is selectable or a sequence of objects that are selectable. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>/, if <var>Selection</var> was added to the current selection. <b>false</b>, if <var>Selection</var> or parts of <var>Selection</var> could not be added to the current selection. For example, if the selection already contains objects that are forbidden to be selected together with <var>Selection</var>. @raises com::sun::star::lang::IllegalArgumentException If <var>Selection</var> is not a selectable object for this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. <p>Removing an object from the selection that is not part of the selection should not raise this exception</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearSelection" class="membertitle">clearSelection</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>clearSelection</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clears the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSelectionCount" class="membertitle">getSelectionCount</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>getSelectionCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the number of selected objects of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createSelectionEnumeration" class="membertitle">createSelectionEnumeration</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumeration.html">XEnumeration</a></td> </tr> <tr> <td valign="top"><b>createSelectionEnumeration</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a new object to enumerate the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a>. It returns NULL if there are no objects in the selection. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createReverseSelectionEnumeration" class="membertitle">createReverseSelectionEnumeration</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumeration.html">XEnumeration</a></td> </tr> <tr> <td valign="top"><b>createReverseSelectionEnumeration</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a new object to enumerate the selection of this <a href="XMultiSelectionSupplier.html">XMultiSelectionSupplier</a> in reverse order. If the order of the selected objects It returns NULL if there are no objects in the selection. </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
>
7793
