Sophie

Sophie

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

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

<html>
<head>
<title>Interface XToolBarFactory</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="XToolBarFactory-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">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 XToolBarFactory</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Factory and possibly cache for creating and releasing tool bars.
 </dd>
<dd><p>A tool bar factory is registered at and used by an
 <a href="XToolBarController.html">XToolBarController</a> object.</p>
 <p>A factory may want to implement a cache to reuse previously released
 tool bars.</p>
 </dd>
<dt><b>See also</b></dt>
<dd><a href="XToolBarController.html">XToolBarController</a>, <a href="XToolBar.html">XToolBar</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="#createToolBar">createToolBar</a></td>
<td class="imsum_right">Create a tool bar for the given URL. When the tool bar is not used
 anymore then call <a href="#releaseToolBar()">releaseToolBar()</a>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#releaseToolBar">releaseToolBar</a></td>
<td class="imsum_right">Call this method to tell a factory that the given toll bar is no
 longer in use in any configuration. The factory can decide whether
 to release its reference (and thus destroy the tool bar) or to keep it
 in a cache in order to reuse it later.
 &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="createToolBar" class="membertitle">createToolBar</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="XToolBar.html">XToolBar</a></td>
</tr>
<tr>
<td valign="top"><b>createToolBar</b>(</td>
<td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td>
<td valign="bottom">&nbsp;xToolBarId,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Create a tool bar for the given URL. When the tool bar is not used
 anymore then call <a href="#releaseToolBar()">releaseToolBar()</a>.
 </dd>
<dt><b>Parameter xToolBarId</b></dt>
<dd>This <a href="XResourceId.html">XResourceId</a> object specifies both the type of
 the tool bar to create as well as to which anchor to link it. Valid
 values for the resource URL are those for which the factory
 has been registered at the <a href="XToolBarController.html">XToolBarController</a>.
 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The controller to which the new tool bar will be connected.
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns a tool bar object that has been just created or was taken
 from a cache.
 </dd>
<dt><b>Throws</b></dt>
<dd>InvalidArgumentException
 when the ResourceURL field of the aToolBarId is not supported by
 the factory.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="releaseToolBar" class="membertitle">releaseToolBar</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>releaseToolBar</b>(</td>
<td valign="top">[in] <a href="XToolBar.html">XToolBar</a></td>
<td valign="bottom">&nbsp;xToolBar );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Call this method to tell a factory that the given toll bar is no
 longer in use in any configuration. The factory can decide whether
 to release its reference (and thus destroy the tool bar) or to keep it
 in a cache in order to reuse it later.
 </dd>
<dt><b>Parameter xToolBar</b></dt>
<dd>The given pane has to be one created by the same factory.
 </dd>
<dt><b>Throws</b></dt>
<dd>InvalidArgumentException
 when the given pane was not created by the same factory.
 </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>