Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 4856

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XLibraryContainer2</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="XLibraryContainer2-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">script</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XLibraryContainer2</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XLibraryContainer2</strong>
&#x2517 <a href="XLibraryContainer.html">XLibraryContainer</a>
   &#x2517 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a>
      &#x2517 ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XLibraryContainer.html">XLibraryContainer</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Provides access to a library system. 
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Extension of <a href="XLibraryContainer.html">XLibraryContainer</a> to provide additional information
 about the libraries contained in a library container
 </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="#isLibraryLink">isLibraryLink</a></td>
<td class="imsum_right">returns true if the accessed library item is a link,
 e.g., created by createLibraryLink, otherwise false.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getLibraryLinkURL">getLibraryLinkURL</a></td>
<td class="imsum_right">returns the location of the library link target.
 Should return the same URL that was passed to 
 createLibraryLink in the StorageURL parameter.

 If the accessed library item exists but isn't a 
 link, a IllegalArgumentException is thrown
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isLibraryReadOnly">isLibraryReadOnly</a></td>
<td class="imsum_right">returns true if the accessed library item (library or library 
 link) is read only. A library can be read only because it was 
 set to read only using the methods provided by this interface 
 or because of other reasons depending on the implementation 
 (e.g., file system write protection)
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setLibraryReadOnly">setLibraryReadOnly</a></td>
<td class="imsum_right">Sets the accessed library item (library or library link) to
 read only according to the flag bReadOnly (true means read only)
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#renameLibrary">renameLibrary</a></td>
<td class="imsum_right">renames the library item with the specified name. If the accessed 
 library item is a link only the link is renamed, not the target library.
 If a library with the new name exists already a 
 com::sun::star::container::ElementExistException is thrown.
 &nbsp;</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="isLibraryLink" class="membertitle">isLibraryLink</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>isLibraryLink</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns true if the accessed library item is a link,
 e.g., created by createLibraryLink, otherwise false.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getLibraryLinkURL" class="membertitle">getLibraryLinkURL</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>getLibraryLinkURL</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name )</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>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the location of the library link target.
 Should return the same URL that was passed to 
 createLibraryLink in the StorageURL parameter.

 If the accessed library item exists but isn't a 
 link, a IllegalArgumentException is thrown
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isLibraryReadOnly" class="membertitle">isLibraryReadOnly</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>isLibraryReadOnly</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns true if the accessed library item (library or library 
 link) is read only. A library can be read only because it was 
 set to read only using the methods provided by this interface 
 or because of other reasons depending on the implementation 
 (e.g., file system write protection)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setLibraryReadOnly" class="membertitle">setLibraryReadOnly</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>setLibraryReadOnly</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;bReadOnly )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Sets the accessed library item (library or library link) to
 read only according to the flag bReadOnly (true means read only)
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="renameLibrary" class="membertitle">renameLibrary</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>renameLibrary</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;NewName )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>renames the library item with the specified name. If the accessed 
 library item is a link only the link is renamed, not the target library.
 If a library with the new name exists already a 
 com::sun::star::container::ElementExistException is thrown.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>