<html> <head> <title>Interface XToolbarController</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="XToolbarController-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">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 XToolbarController</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is an abstract service for a component which offers a more complex user interface to users within a toolbar. </dd> <dd><p> A generic toolbar function is represented as a button which has a state (enabled,disabled and selected, not selected). A toolbar controller can be added to a toolbar and provide information or functions with a more sophisticated user interface.<br/> A typical example for toolbar controller is a font chooser on a toolbar. It provides all available fonts in a dropdown box and shows the current chosen font. <p> </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd><a href="XDispatchProvider.html">XDispatchProvider</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="#execute">execute</a></td> <td class="imsum_right">provides a function to execute the command which is bound to the toolbar controller. </td> </tr> <tr> <td class="imsum_left"><a href="#click">click</a></td> <td class="imsum_right">notifies a component that a single click has been made on the toolbar item. </td> </tr> <tr> <td class="imsum_left"><a href="#doubleClick">doubleClick</a></td> <td class="imsum_right">notifies a component that a double click has been made on the toolbar item. </td> </tr> <tr> <td class="imsum_left"><a href="#createPopupWindow">createPopupWindow</a></td> <td class="imsum_right">requests to create a popup window for additional functions. </td> </tr> <tr> <td class="imsum_left"><a href="#createItemWindow">createItemWindow</a></td> <td class="imsum_right">requests to create an item window which can be added to the toolbar. </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="execute" class="membertitle">execute</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>execute</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> KeyModifier );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides a function to execute the command which is bound to the toolbar controller. </dd> <dt><b>Parameter a</b></dt> <dd>combination of ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/KeyModifier.html">KeyModifier</a> value that represent the current state of the modifier keys. <p> This function is usally called by a toolbar implementation when a user clicked on a toolbar button or pressed enter on the keyboard when the item has the input focus. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="click" class="membertitle">click</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>click</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies a component that a single click has been made on the toolbar item. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="doubleClick" class="membertitle">doubleClick</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>doubleClick</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies a component that a double click has been made on the toolbar item. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createPopupWindow" class="membertitle">createPopupWindow</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">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> </tr> <tr> <td valign="top"><b>createPopupWindow</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>requests to create a popup window for additional functions. </dd> <dt><b>Returns</b></dt> <dd>a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> which provides additional functions to the user. The reference must be empty if component does not want to provide a separate window. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createItemWindow" class="membertitle">createItemWindow</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">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> </tr> <tr> <td valign="top"><b>createItemWindow</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> Parent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>requests to create an item window which can be added to the toolbar. </dd> <dt><b>Parameter Parent</b></dt> <dd>a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> which must be used as a parent for the requested item window. </dd> <dt><b>Returns</b></dt> <dd>a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> which can be added to a toolbar. The reference must be empty if a component does not want to provide an item window. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>