<html> <head> <title>Interface XStatusbarController</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="XStatusbarController-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 XStatusbarController</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 status bar. </dd> <dd><p> A generic status bar field is represented as a simple text field. A status bar controller can be added to a Statusbar and provide information or functions with a more sophisticated user interface.<br/> A typical example for status bar controller is a zoom chooser. It shows the current zoom and provides general zoom levels on a popup menu that can be activated by a mouse action for context menus. <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="#mouseButtonDown">mouseButtonDown</a></td> <td class="imsum_right">is called by a status bar if the mouse position is within the controller and a mouse button has been pressed. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </td> </tr> <tr> <td class="imsum_left"><a href="#mouseMove">mouseMove</a></td> <td class="imsum_right">is called by a status bar if the mouse position is within the controller and a mouse has been moved. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </td> </tr> <tr> <td class="imsum_left"><a href="#mouseButtonUp">mouseButtonUp</a></td> <td class="imsum_right">is called by a status bar if the mouse position is within the controller and a mouse button has been released. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </td> </tr> <tr> <td class="imsum_left"><a href="#command">command</a></td> <td class="imsum_right">is called by a status bar if a command event is available for a controller. </td> </tr> <tr> <td class="imsum_left"><a href="#paint">paint</a></td> <td class="imsum_right">is called by a status bar if the controller has to update the visual representation. </td> </tr> <tr> <td class="imsum_left"><a href="#click">click</a></td> <td class="imsum_right">is called by a status bar if the user clicked with mouse into the field of the corresponding control. </td> </tr> <tr> <td class="imsum_left"><a href="#doubleClick">doubleClick</a></td> <td class="imsum_right">is called by a status bar if the user double-clicked with mouse into the field of the corresponding control. </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="mouseButtonDown" class="membertitle">mouseButtonDown</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>mouseButtonDown</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/MouseEvent.html">MouseEvent</a></td> <td valign="bottom"> aMouseEvent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by a status bar if the mouse position is within the controller and a mouse button has been pressed. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </dd> <dt><b>Parameter aMouseEvent</b></dt> <dd>current information about the mouse pointer. </dd> <dt><b>Returns</b></dt> <dd>return <b>true</b> if the event should not be processed and <b>false</b> if the event should be processed by the status bar. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="mouseMove" class="membertitle">mouseMove</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>mouseMove</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/MouseEvent.html">MouseEvent</a></td> <td valign="bottom"> aMouseEvent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by a status bar if the mouse position is within the controller and a mouse has been moved. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </dd> <dt><b>Parameter aMouseEvent</b></dt> <dd>current information about the mouse pointer. </dd> <dt><b>Returns</b></dt> <dd>return <b>true</b> if the event should not be processed and <b>false</b> if the event should be processed by the status bar. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="mouseButtonUp" class="membertitle">mouseButtonUp</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>mouseButtonUp</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/MouseEvent.html">MouseEvent</a></td> <td valign="bottom"> aMouseEvent );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by a status bar if the mouse position is within the controller and a mouse button has been released. If the controller has captured the mouse input this function is also called when the mouse position is not within the controller. </dd> <dt><b>Parameter aMouseEvent</b></dt> <dd>current information about the mouse pointer. </dd> <dt><b>Returns</b></dt> <dd>return <b>true</b> if the event should not be processed and <b>false</b> if the event should be processed by the status bar. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="command" class="membertitle">command</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>command</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a></td> <td valign="bottom"> aPos,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCommand,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bMouseEvent,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> aData );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by a status bar if a command event is available for a controller. </dd> <dt><b>Parameter aPos</b></dt> <dd>the current mouse position in pixel. </dd> <dt><b>Parameter nCommand</b></dt> <dd>describes which command has been invoked. </dd> <dt><b>Parameter bMouseEvent</b></dt> <dd><b>true</b> if the command is based on a mouse event, otherwise <b>false</b>. </dd> <dt><b>Parameter aData</b></dt> <dd>for future use only. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="paint" class="membertitle">paint</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>paint</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XGraphics.html">XGraphics</a></td> <td valign="bottom"> xGraphics,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a></td> <td valign="bottom"> rOutputRectangle,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nStyle );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by a status bar if the controller has to update the visual representation. </dd> <dt><b>Parameter xGraphics</b></dt> <dd>a reference to a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XGraphics.html">XGraphics</a> which has to be used to update the visual representation. </dd> <dt><b>Parameter nCommand</b></dt> <dd>a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a> which determine the output rectangle for all drawing operations </dd> <dt><b>Parameter nItemID</b></dt> <dd>the unique ID of the control within the status bar. </dd> <dt><b>Parameter nStyle</b></dt> <dd>reserved for future use. </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>is called by a status bar if the user clicked with mouse into the field of the corresponding control. </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>is called by a status bar if the user double-clicked with mouse into the field of the corresponding control. </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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3542
