Sophie

Sophie

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

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

<html>
<head>
<title>Interface XSubToolbarController</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="XSubToolbarController-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">frame</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 XSubToolbarController</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>special interface to support sub-toolbars in a controller implementation.

 </dd>
<dd><p>
 This interface is normally used to implement the toolbar button/sub-
 toolbar function feature. It exchanges the function of the toolbar 
 button, that opened the sub-toolbar, with the one that has been selected 
 on the sub-toolbar.
 </p>
 
 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.0</dd>
<dt><b>See also</b></dt>
<dd><a href="ToolbarController.html">ToolbarController</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="#opensSubToolbar">opensSubToolbar</a></td>
<td class="imsum_right">if the controller features a sub-toolbar. 

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSubToolbarName">getSubToolbarName</a></td>
<td class="imsum_right">provides the resource URL of the sub-toolbar this controller opens.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#functionSelected">functionSelected</a></td>
<td class="imsum_right">gets called to notify a controller that a sub-toolbar function has been 
 selected.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#updateImage">updateImage</a></td>
<td class="imsum_right">gets called to notify a controller that it should set an image which
 represents the current selected function.

 &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="opensSubToolbar" class="membertitle">opensSubToolbar</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>opensSubToolbar</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>if the controller features a sub-toolbar. 

 </dd>
<dt><b>Returns</b></dt>
<dd><b>true</b> if the controller offers a sub toolbar, otherwise <b>false</b>.

 <p>
 Enables implementations to dynamically decide to support sub-toolbars
 or not.
 </p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSubToolbarName" class="membertitle">getSubToolbarName</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>getSubToolbarName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>provides the resource URL of the sub-toolbar this controller opens.

 </dd>
<dt><b>Returns</b></dt>
<dd>name of the sub-toolbar this controller offers. A empty string 
 will be interpreted as if this controller offers no sub-toolbar.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="functionSelected" class="membertitle">functionSelected</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>functionSelected</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aCommand );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets called to notify a controller that a sub-toolbar function has been 
 selected.

 </dd>
<dt><b>Parameter aCommand</b></dt>
<dd>a string which identifies the function that has been selected by
 a user.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="updateImage" class="membertitle">updateImage</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>updateImage</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>gets called to notify a controller that it should set an image which
 represents the current selected function.

 </dd>
<dd><p>
 Only the controller instance is able to set the correct image for the
 current function. A toolbar implementation will ask sub-toolbar 
 controllers to update their image whenever it has to update the images
 of all its buttons.
 </p>
 </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>