<html> <head> <title>Service CommandButton</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="CommandButton-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">form</a> :: <a href="module-ix.html" class="namechain">component</a> :: </p> </td> </tr> <tr> <td class="title">service CommandButton</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the control model for a clickable button which is part of a form component hierarchy. </dd> <dt><b>See also</b></dt> <dd><a href="ImageButton.html">ImageButton</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButtonModel.html">UnoControlButtonModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButton.html">UnoControlButton</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a control model within a form. </dd> </dl> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XImageProducerSupplier.html">XImageProducerSupplier</a></td> <td class="imsum_right"><p>supplies the image producer when the button is to display an image. (<a href="#XImageProducerSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></td> <td class="imsum_right"><p>allows resetting the button (<a href="#XReset">details</a>)</p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a><br> <a href="#ButtonType">ButtonType</a></td> <td class="imsum_right">describes the action to be executed by the button when pressed. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TargetFrame">TargetFrame</a></td> <td class="imsum_right">describes the frame, where to open the document specified by the TargetURL. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TargetURL">TargetURL</a></td> <td class="imsum_right">specifies the URL, which should be opened if the button was clicked. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#DefaultState">DefaultState</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the default toggle state for the button, used when it is reset. </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="UnoControlButtonModel" class="membertitle">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButtonModel.html">UnoControlButtonModel</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButton.html">UnoControlButton</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="FormControlModel" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a control model within a form. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XImageProducerSupplier" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XImageProducerSupplier.html">XImageProducerSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>supplies the image producer when the button is to display an image. </dd> <dd><p>If the ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButtonModel.html">UnoControlButtonModel</a>::<a href="../../awt/UnoControlButtonModel.html#ImageURL">ImageURL</a> points to the location of an image to be displayed on the button, this interface can be used to retrieve an image producer, which itself will supply the image.</p> <p>Usually, a control belonging to the model will use this interface to obtain the image to be painted</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XReset" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows resetting the button </dd> <dd><p>This property is meaningful only when ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButtonModel.html">UnoControlButtonModel</a>::<a href="../../awt/UnoControlButtonModel.html#Toggle">Toggle</a> is <b>true</b>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will be reset, when ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a>::<a href="../XReset.html#reset">reset</a> is invoked.</p> <p>For a given implementation of the interface, if this (optional) interface is present, then also the optional property <a href="CommandButton.html#DefaultState">DefaultState</a> must be present.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ButtonType" class="membertitle">ButtonType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a> <b>ButtonType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes the action to be executed by the button when pressed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TargetFrame" class="membertitle">TargetFrame</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TargetFrame</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes the frame, where to open the document specified by the TargetURL. </dd> <dd><p>This property is evaluated if the button is of type URL.</p> <p>As always, there is a number of target names which have a special meaning, and force a special ::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/Frame.html">Frame</a> to be used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TargetURL" class="membertitle">TargetURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TargetURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the URL, which should be opened if the button was clicked. </dd> <dd><p>This property is evaluated if the button is of type URL.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DefaultState" class="membertitle">DefaultState</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>DefaultState</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the default toggle state for the button, used when it is reset. </dd> <dd><p>This property is meaningful only when ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlButtonModel.html">UnoControlButtonModel</a>::<a href="../../awt/UnoControlButtonModel.html#Toggle">Toggle</a> is <b>true</b>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will be reset.</p> <p>For a given implementation of the interface, if this (optional) property is present, then also the optional interface ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a> must be present.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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
>
3219
