<html> <head> <title>Interface XOfficeInstallationDirectories</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="XOfficeInstallationDirectories-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">util</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 XOfficeInstallationDirectories</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>encapsulates access to the current office installation directory and office user data directory, provides functionality to create URLs containing relocatable (not absolute) references to the current office installation directory and user data directory and vice versa. </dd> <dd><p>This functionality is useful when data containing references to the current office installation directory must be made persistent and re-read later. In many cases, storing the reference directly would destroy the relocatability of an office installation. </dd> <dt><b/></dt> <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="#getOfficeInstallationDirectoryURL">getOfficeInstallationDirectoryURL</a></td> <td class="imsum_right">returns the absolute URL containing the directory of the current office installation (e.g. "file:///opt/OpenOffice.org".) </td> </tr> <tr> <td class="imsum_left"><a href="#getOfficeUserDataDirectoryURL">getOfficeUserDataDirectoryURL</a></td> <td class="imsum_right">returns the absolute URL containing the directory where the current office installation expects its user data (e.g. "file:///home/kso".) </td> </tr> <tr> <td class="imsum_left"><a href="#makeRelocatableURL">makeRelocatableURL</a></td> <td class="imsum_right">calculates a relocatable URL from the given URL. </td> </tr> <tr> <td class="imsum_left"><a href="#makeAbsoluteURL">makeAbsoluteURL</a></td> <td class="imsum_right">the counterpart of <code>makeRelocatableURL</code>. </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="getOfficeInstallationDirectoryURL" class="membertitle">getOfficeInstallationDirectoryURL</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>getOfficeInstallationDirectoryURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the absolute URL containing the directory of the current office installation (e.g. "file:///opt/OpenOffice.org".) </dd> <dt><b>Returns</b></dt> <dd>the absolute URL containing the directory of the current office installation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getOfficeUserDataDirectoryURL" class="membertitle">getOfficeUserDataDirectoryURL</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>getOfficeUserDataDirectoryURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the absolute URL containing the directory where the current office installation expects its user data (e.g. "file:///home/kso".) </dd> <dt><b>Returns</b></dt> <dd>the absolute URL containing the directory of the current office user data. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="makeRelocatableURL" class="membertitle">makeRelocatableURL</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>makeRelocatableURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>calculates a relocatable URL from the given URL. </dd> <dd><p>If the given URL contains an absolute reference to the current office installation directory or office user data directory, this method will replace the absolute reference by an opaque placeholder string. <code>makeRelocatableURL</code> must be used in order to re-replace the placeholder by an absolute reference. </dd> <dt><b>Parameter URL</b></dt> <dd>The URL for that a relocatable URL is requested. In case the URL does not contain a reference to the current office installation or to the office user data directory, the input URL will be returned unchanged. </dd> <dt><b>Returns</b></dt> <dd>The relocatable URL. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="makeAbsoluteURL" class="membertitle">makeAbsoluteURL</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>makeAbsoluteURL</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>the counterpart of <code>makeRelocatableURL</code>. </dd> <dd><p>If the given URL contains a placeholder for an absolute reference to the current office installation directory or for the office user data directory, that was created using <code>makeRelocatableURL</code>, the respective placeholder will be replaced by an absolute reference to the current office installation directory or office user data directory. </dd> <dt><b>Parameter URL</b></dt> <dd>The URL for that an absolaute URL is requested. In case the URL does not contain the opaque relocation placholder used by <code>makeRelocatableURL</code>, the input URL will be returned unchanged. </dd> <dt><b>Returns</b></dt> <dd>The absolute URL. </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
>
7701
