<html> <head> <title>Interface XUntitledNumbers</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="XUntitledNumbers-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">frame</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 XUntitledNumbers</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>knows all currently used and all free numbers for using with untitled but counted objects. </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="#leaseNumber">leaseNumber</a></td> <td class="imsum_right">calli has to lease a number befor he can use it within in its own title. Such number must be freed after using e.g. while the object was closed or get's another title (e.g. by saving a document to a real location on disc). </td> </tr> <tr> <td class="imsum_left"><a href="#releaseNumber">releaseNumber</a></td> <td class="imsum_right">has to be used to mark those number as "free for using". If the reqistered component does not use such leased number any longer it has to be released so it can be used for new components. Note: calling this method with an unknown (but normaly valid number) has to be ignored. No exceptions - no errors. </td> </tr> <tr> <td class="imsum_left"><a href="#releaseNumberForComponent">releaseNumberForComponent</a></td> <td class="imsum_right">does the same then releaseNumber () but it searches the corresponding number for the specified component and deregister it. </td> </tr> <tr> <td class="imsum_left"><a href="#getUntitledPrefix">getUntitledPrefix</a></td> <td class="imsum_right">returns the localized string value to be used for untitles objects in combination with the leased number. Note: Such string already contains leading spaces/tabs etcpp. ! The only thing which an outside code has todo then ... adding a leased number to the string. </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="leaseNumber" class="membertitle">leaseNumber</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>leaseNumber</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xComponent )</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>calli has to lease a number befor he can use it within in its own title. Such number must be freed after using e.g. while the object was closed or get's another title (e.g. by saving a document to a real location on disc). </dd> <dt><b>Parameter xComponent</b></dt> <dd>the component which has to be registered for the leased number. </dd> <dt><b>Returns</b></dt> <dd>the new number for these object or 0 if no further numbers are available. </dd> <dt><b>Throws</b></dt> <dd>[IllegalArgumentException] if an invalid object reference was provided to this method. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="releaseNumber" class="membertitle">releaseNumber</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>releaseNumber</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nNumber )</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>has to be used to mark those number as "free for using". If the reqistered component does not use such leased number any longer it has to be released so it can be used for new components. Note: calling this method with an unknown (but normaly valid number) has to be ignored. No exceptions - no errors. </dd> <dt><b>Parameter nNumber</b></dt> <dd>specify number for release. </dd> <dt><b>Throws</b></dt> <dd>[IllegalArgumentException] if the given number is the special value 0. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="releaseNumberForComponent" class="membertitle">releaseNumberForComponent</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>releaseNumberForComponent</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xComponent )</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>does the same then releaseNumber () but it searches the corresponding number for the specified component and deregister it. </dd> <dt><b>Parameter xComponent</b></dt> <dd>the component for deregistration. </dd> <dt><b>Throws</b></dt> <dd>[IllegalArgumentException] if an invalid object reference was provided to this method. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUntitledPrefix" class="membertitle">getUntitledPrefix</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">string</td> </tr> <tr> <td valign="top"><b>getUntitledPrefix</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the localized string value to be used for untitles objects in combination with the leased number. Note: Such string already contains leading spaces/tabs etcpp. ! The only thing which an outside code has todo then ... adding a leased number to the string. </dd> <dt><b>Returns</b></dt> <dd>the localized string for untitled components. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
3633
