<html> <head> <title>Interface XConfiguration</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="XConfiguration-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">drawing</a> :: <a href="module-ix.html" class="namechain">framework</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 XConfiguration</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XConfiguration</strong> ┗ ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>makes it possible to create a copy of the object which supports this interface. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>A configuration describes the resources of an application like panes, views, and tool bars and their relationships that are currently active or are requested to be activated. Resources are specified by ResourceId structures rather than references so that not only the current configuration but also a requested configuration can be represented. </dd> <dd><p>Direct manipulation of a configuration object is not advised with the exception of the <a href="ConfigurationController.html">ConfigurationController</a> and objects that implement the <a href="XConfigurationChangeRequest.html">XConfigurationChangeRequest</a> interface.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XConfigurationController.html">XConfigurationController</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="#getResources">getResources</a></td> <td class="imsum_right">Returns the list of resources that are bound directly and/or indirectly to the given anchor. A URL filter can reduce the set of returned resource ids. </td> </tr> <tr> <td class="imsum_left"><a href="#hasResource">hasResource</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#addResource">addResource</a></td> <td class="imsum_right">Add a resource to the configuration. </td> </tr> <tr> <td class="imsum_left"><a href="#removeResource">removeResource</a></td> <td class="imsum_right">Remove a resource from the configuration. </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="getResources" class="membertitle">getResources</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< <a href="XResourceId.html">XResourceId</a> ></td> </tr> <tr> <td valign="top"><b>getResources</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xAnchorId,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sTargetURLPrefix,</td> </tr> <tr> <td/><td valign="top">[in] <a href="AnchorBindingMode.html">AnchorBindingMode</a></td> <td valign="bottom"> eSearchMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the list of resources that are bound directly and/or indirectly to the given anchor. A URL filter can reduce the set of returned resource ids. </dd> <dt><b>Parameter xAnchorId</b></dt> <dd>This anchor typically is either a pane or an empty <a href="XResourceId.html">XResourceId</a> object. An empty reference is treated like an <a href="XResourceId.html">XResourceId</a> object. </dd> <dt><b>Parameter sURLPrefix</b></dt> <dd>When a non-empty string is given then resource ids are returned only when their resource URL matches this prefix, i.e. when it begins with this prefix or is equal to it. Characters with special meaning to URLs are not interpreted. In the typical usage the prefix specifies the type of a resource. A typical value is "private:resource/floater/", which is the prefix for pane URLs. In a recursive search, only resource ids at the top level are matched against this prefix. <p>Use an empty string to prevent filtering out resource ids.</p> </dd> <dt><b>Parameter eSearchMode</b></dt> <dd>This flag defines whether to return only resources that are directly bound to the given anchor or a recursive search is to be made. Note that for the recursive search and an empty anchor all resource ids are returned that belong to the configuration. </dd> <dt><b>Returns</b></dt> <dd>The set of returned resource ids may be empty when there are no resource ids that match all conditions. The resources in the sequence are ordered with respect to the XResourceId::compareTo() method. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasResource" class="membertitle">hasResource</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>hasResource</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xResourceId );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd><p>Returns wether the specified resource is part of the configuration.</p> This is independent of whether the resource does really exist and is active, i.e. has a visible representation in the GUI. </dd> <dt><b>Parameter xResourceId</b></dt> <dd>The id of a resource. May be empty (empty reference or empty <a href="XResourceId.html">XResourceId</a> object) in which case <b>false</b> is returned. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> when the resource is part of the configuration and <b>false</b> when it is not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addResource" class="membertitle">addResource</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>addResource</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xResourceId );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add a resource to the configuration. </dd> <dd><p>This method should be used only by objects that implement the ::XConfigurationRequest interface or by the configuration controller.</p> </dd> <dt><b>Parameter xResourceId</b></dt> <dd>The resource to add to the configuration. When the specified resource is already part of the configuration then this call is silently ignored. </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException When an empty resource id is given then an IllegalArgumentException is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeResource" class="membertitle">removeResource</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>removeResource</b>(</td> <td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td> <td valign="bottom"> xResource );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove a resource from the configuration. </dd> <dd><p>This method should be used only by objects that implement the ::XConfigurationRequest interface or by the configuration controller.</p> </dd> <dt><b>Parameter xResourceId</b></dt> <dd>The resource to remove from the configuration. When the specified resource is not part of the configuration then this call is silently ignored. </dd> <dt><b>Throws</b></dt> <dd>IllegalArgumentException When an empty resource id is given then an IllegalArgumentException 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 © 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
>
2885
