Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 7614

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XFileIdentifierConverter</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="XFileIdentifierConverter-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">ucb</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XFileIdentifierConverter</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>specifies methods to convert between (file) URLs and file paths in system
 dependent notation.

 </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="#getFileProviderLocality">getFileProviderLocality</a></td>
<td class="imsum_right">Get information about the 'locality' of a file content provider.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getFileURLFromSystemPath">getFileURLFromSystemPath</a></td>
<td class="imsum_right">converts a file path in system dependent notation to a (file) URL.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSystemPathFromFileURL">getSystemPathFromFileURL</a></td>
<td class="imsum_right">converts a (file) URL to a file path in system dependent notation.

 &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="getFileProviderLocality" class="membertitle">getFileProviderLocality</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>getFileProviderLocality</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;BaseURL );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Get information about the 'locality' of a file content provider.

 </dd>
<dd><p>The returned information can be used to chose the 'best' among a
 number of file content providers implementing this interface.

 </dd>
<dt><b>Parameter BaseURL</b></dt>
<dd>the base (file) URL used to specify a file content provider.

 </dd>
<dt><b>Returns</b></dt>
<dd>an appropriat value representing the 'locality' of the specified file
 content provider. Generally, higher (non-negative) numbers denote
 file content providers that are more 'local', and negative numbers
 denote content providers that are not file content providers at all.
 As a convention (and to keep this useful), values should be restricted
 to the range from -1 to +10, inclusive.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getFileURLFromSystemPath" class="membertitle">getFileURLFromSystemPath</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>getFileURLFromSystemPath</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;BaseURL,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;SystemPath );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>converts a file path in system dependent notation to a (file) URL.

 </dd>
<dt><b>Parameter BaseURL</b></dt>
<dd>the base (file) URL relative to which the file path shall be
 interpreted.

 </dd>
<dt><b>Parameter SystemPath</b></dt>
<dd>a file path in system dependent notation.

 </dd>
<dt><b>Returns</b></dt>
<dd>the URL corresponding to the file path, or an empty string if the file
 path cannot be converted into a URL.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSystemPathFromFileURL" class="membertitle">getSystemPathFromFileURL</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>getSystemPathFromFileURL</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;URL );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>converts a (file) URL to a file path in system dependent notation.

 </dd>
<dt><b>Parameter URL</b></dt>
<dd>a (file) URL.

 </dd>
<dt><b>Returns</b></dt>
<dd>the file path corresponding to the URL, or an empty string if the URL
 cannot be converted into a file path.
 </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; 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>