Sophie

Sophie

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

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

<html>
<head>
<title>Interface XContentProviderManager</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="XContentProviderManager-xref.html" class="navimain">Use</a></td>
<td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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 XContentProviderManager</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>makes it possible to query/register/deregister content providers.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="XContentProvider.html">XContentProvider</a></dd>
</dl>
<a name="devmanual"> </a><dl>
<dt><b>Developers Guide</b></dt>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/UCB/Content_Provider_Proxies">UCB - Content Provider Proxies</a></dd>
<dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/UCB/Unconfigured_UCBs">UCB - Unconfigured UCBs</a></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="#registerContentProvider">registerContentProvider</a></td>
<td class="imsum_right">registers a content provider for a specific URL template.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#deregisterContentProvider">deregisterContentProvider</a></td>
<td class="imsum_right">deregisters a content provider.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryContentProviders">queryContentProviders</a></td>
<td class="imsum_right">returns a list of information on all registered content providers.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#queryContentProvider">queryContentProvider</a></td>
<td class="imsum_right">returns the currently active content provider for a content
 identifier.

 &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="registerContentProvider" class="membertitle">registerContentProvider</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"><a href="XContentProvider.html">XContentProvider</a></td>
</tr>
<tr>
<td valign="top"><b>registerContentProvider</b>(</td>
<td valign="top">[in] <a href="XContentProvider.html">XContentProvider</a></td>
<td valign="bottom">&nbsp;Provider,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Scheme,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;ReplaceExisting )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="DuplicateProviderException.html">DuplicateProviderException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>registers a content provider for a specific URL template.

 </dd>
<dt><b>Parameter Provider</b></dt>
<dd>the content provider to register.

 <p>This may be <b>NULL</b>, in which case a later
 <a href="XContentProvider.html">XContentProvider</a>::<a href="XContentProvider.html#queryContent">queryContent</a> with an
 <a href="XContentIdentifier.html">XContentIdentifier</a> that matches the <var>Scheme</var>
 will simply return <b>NULL</b>. These "dummy" content providers are useful
 in combination with other content providers that are registered on a
 wildcard URL template: For example, imagine that you want to route all
 http URLs to a HTTP content provider, but want to block all URLs for
 the server <code>www.dont.go</code>. One solution would be to register
 the HTTP content provider on the <var>Scheme</var> <code>http</code>,
 and to register a "dummy" (i.e., <b>NULL</b>) content provider on the
 <var>Scheme</var> <code>"http://www.dont.go"([/?#].*)?</code>.

 </dd>
<dt><b>Parameter Scheme</b></dt>
<dd>the URL scheme for the provided contents. More generally, this may not
 only be a URL scheme, but a URL template.

 <p>A URL template is a regular expression (represented as a string) that
 specifies a subset of the set of all possible URLs (this subset
 consists of exactly those URLs that match the regular expression). The
 language to denote the regular expressions is initially quite limited,
 but it may be extended in the future:

 <p><ul>
 <li><code>regexp = scheme / simple / translation</code></li>
 <li><code>scheme = ALPHA *(ALPHA / DIGIT / "+" / "-" / ".")</code></li>
 <li><code>simple = simple-prefix / simple-authority / simple-domain</code></li>
 <li><code>translation = trans-prefix / trans-authority / trans-domain</code></li>
 <li><code>simple-prefix = [string] ".*"</code></li>
 <li><code>trans-prefix = [string] "(.*)->" [string] "\1"</code></li>
 <li><code>simple-authority = [string] "([/?#].*)?"</code></li>
 <li><code>trans-authority = [string] "(([/?#].*)?)->" string "\1"</code></li>
 <li><code>simple-domain = [string] "[^/?#]*" string "([/?#].*)?"</code></li>
 <li><code>trans-domain = [string] "([^/?#]*" string "([/?#].*)?)->" string "\1"</code></li>
 <li><code>string = DQUOTE 1*(schar / sescape) DQUOTE ; DQUOTE is "</code></li>
 <li><code>schar = &lt any UTF-16 character except " or \></code></li>
 <li><code>sescape = "\" (DQUOTE / "\")</code></li>
 </ul>

 <p>A <code>&lt;scheme&gt:</code> matches any URL of exactly the given
 scheme (ignoring case), keeping the extension from URL schemes to URL
 templates backwards compatible. The <code>&lt;simple&gt:</code>
 regexps match any URL starting with a given string literal, followed
 by arbitrary characters (<code>&lt;simple-prefix&gt:</code>), or
 by arbitrary characters that start with one of '/', '?', or '#', if any
 (<code>&lt;simple-authority&gt:</code>), or by arbitrary characters not
 including any of '/', '?', or '#', followed by a given string literal,
 followed by arbitrary characters that start with one of '/', '?', or
 '#', if any. The comparision of string literals is done ignoring the
 case of ASCII letters. The <code>&lt;translation&gt:</code> regexps
 match the same URLs as their <code>&lt;simple&gt:</code> counterparts,
 but they also describe how a (local) URL is mapped to another (remote)
 URL. This mapping is only relevant for methods of the
 <a href="RemoteAccessContentProvider.html">RemoteAccessContentProvider</a>'s
 <a href="XParameterizedContentProvider.html">XParameterizedContentProvider</a> interface; in all other
 cases, <code>&lt;translation&gt:</code> regexps have the same semantics
 as their <code>&lt;simple&gt:</code> counterparts.

 </dd>
<dt><b>Parameter ReplaceExisting</b></dt>
<dd><b>true</b>: replace the provider possibly registered for the given URL
 template. The replaced provider will not be deregistered automatically!
 If the superseding provider gets deregistered, the superseded one will
 become active again.
 <p><b>false</b>: do not register, if another provider is already registered
 for the given URL template.

 </dd>
<dt><b>Returns</b></dt>
<dd>the replaced content provider, if there was one.
 </dd>
<dt><b>See also</b></dt>
<dd><a href="XContentIdentifier.html">XContentIdentifier</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="deregisterContentProvider" class="membertitle">deregisterContentProvider</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">[oneway] void</td>
</tr>
<tr>
<td valign="top"><b>deregisterContentProvider</b>(</td>
<td valign="top">[in] <a href="XContentProvider.html">XContentProvider</a></td>
<td valign="bottom">&nbsp;Provider,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Scheme );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>deregisters a content provider.

 </dd>
<dt><b>Parameter Provider</b></dt>
<dd>a content provider to deregister.

 </dd>
<dt><b>Parameter Scheme</b></dt>
<dd>the URL scheme for the provided contents. More generally, this
 may not only be a URL scheme, but a URL template (see
 <a href="#registerContentProvider">registerContentProvider</a> for a discussion of URL
 templates).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryContentProviders" class="membertitle">queryContentProviders</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">sequence&lt; <a href="ContentProviderInfo.html">ContentProviderInfo</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>queryContentProviders</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns a list of information on all registered content providers.

 </dd>
<dt><b>Returns</b></dt>
<dd>a list information on content providers.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="queryContentProvider" class="membertitle">queryContentProvider</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"><a href="XContentProvider.html">XContentProvider</a></td>
</tr>
<tr>
<td valign="top"><b>queryContentProvider</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Identifier );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>returns the currently active content provider for a content
 identifier.

 </dd>
<dt><b>Parameter Identifier</b></dt>
<dd>a content identifier (i.e., a URL).

 </dd>
<dt><b>Returns</b></dt>
<dd>a content provider.
 </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>