<html> <head> <title>Service UnoControlButtonModel</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="UnoControlButtonModel-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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</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">awt</a> :: </p> </td> </tr> <tr> <td class="title">service UnoControlButtonModel</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the standard model of an <a href="UnoControlButton.html">UnoControlButton</a>. </dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="UnoControlModel.html">UnoControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an <a href="UnoControl.html">UnoControl</a> in the <em>Smalltalk model view controller design</em>. </dd> </dl> </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">short<br> <a href="#Align">Align</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the horizontal alignment of the text in the control. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#BackgroundColor">BackgroundColor</a></td> <td class="imsum_right">specifies the background color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#DefaultButton">DefaultButton</a></td> <td class="imsum_right">specifies that the button is the default button on the document. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Enabled">Enabled</a></td> <td class="imsum_right">determines whether the control is enabled or disabled. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#FocusOnClick">FocusOnClick</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the button control should grab the focus when clicked. </td> </tr> <tr> <td class="imsum_left"><a href="FontDescriptor.html">FontDescriptor</a><br> <a href="#FontDescriptor">FontDescriptor</a></td> <td class="imsum_right">specifies the font attributes of the text in the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#FontEmphasisMark">FontEmphasisMark</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#FontRelief">FontRelief</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpText">HelpText</a></td> <td class="imsum_right">specifies the help text of the control. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpURL">HelpURL</a></td> <td class="imsum_right">specifies the help URL of the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#ImageAlign">ImageAlign</a></td> <td class="imsum_right">specifies the alignment of the image inside the button as <a href="ImageAlign.html">ImageAlign</a> value. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#ImagePosition">ImagePosition</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the position of the image, if any, relative to the text, if any </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ImageURL">ImageURL</a></td> <td class="imsum_right">specifies an URL to an image to use for the button. </td> </tr> <tr> <td class="imsum_left">[ transient ] ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a><br> <a href="#Graphic">Graphic</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies a graphic to be displayed at the button </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Label">Label</a></td> <td class="imsum_right">specifies the label of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#MultiLine">MultiLine</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies that the text may be displayed on more than one line. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Printable">Printable</a></td> <td class="imsum_right">specifies that the control will be printed with the document. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#PushButtonType">PushButtonType</a></td> <td class="imsum_right">specifies the default action of the button as <a href="PushButtonType.html">PushButtonType</a> value. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Repeat">Repeat</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the control should show repeating behaviour. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#RepeatDelay">RepeatDelay</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the mouse repeat delay, in milliseconds. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#State">State</a></td> <td class="imsum_right">specifies the state of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Tabstop">Tabstop</a></td> <td class="imsum_right">specifies that the control can be reached with the TAB key. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#TextColor">TextColor</a></td> <td class="imsum_right">specifies the text color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#TextLineColor">TextLineColor</a></td> <td class="imsum_right">specifies the text line color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Toggle">Toggle</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the button should toggle on a single operation. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/VerticalAlignment.html">VerticalAlignment</a><br> <a href="#VerticalAlign">VerticalAlign</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the vertical alignment of the text in the control. </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="Align" class="membertitle">Align</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Align</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the horizontal alignment of the text in the control. </dd> <dd><pre> 0: left 1: center 2: right </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackgroundColor" class="membertitle">BackgroundColor</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="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>BackgroundColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the background color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DefaultButton" class="membertitle">DefaultButton</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>DefaultButton</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the button is the default button on the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Enabled" class="membertitle">Enabled</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Enabled</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control is enabled or disabled. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FocusOnClick" class="membertitle">FocusOnClick</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>FocusOnClick</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the button control should grab the focus when clicked. </dd> <dd><p>If set to <b>true</b> (which is the default), the button control automatically grabs the focus when the user clicks onto it with the mouse.<br/> If set to <b>false</b>, the focus is preserved when the user operates the button control with the mouse.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontDescriptor" class="membertitle">FontDescriptor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="FontDescriptor.html">FontDescriptor</a> <b>FontDescriptor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the font attributes of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontEmphasisMark" class="membertitle">FontEmphasisMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>FontEmphasisMark</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontRelief" class="membertitle">FontRelief</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>FontRelief</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpText" class="membertitle">HelpText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpText</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help text of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpURL" class="membertitle">HelpURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help URL of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ImageAlign" class="membertitle">ImageAlign</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>ImageAlign</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the alignment of the image inside the button as <a href="ImageAlign.html">ImageAlign</a> value. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ImagePosition" class="membertitle">ImagePosition</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>ImagePosition</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the position of the image, if any, relative to the text, if any </dd> <dd><p>Valid values of this property are specified with <a href="ImagePosition.html">ImagePosition</a>.</p> <p>If this property is present, it supersedes the <a href="#ImageAlign">ImageAlign</a> property - setting one of both properties sets the other one to the best possible match.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ImageURL" class="membertitle">ImageURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ImageURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies an URL to an image to use for the button. </dd> <dt><b>See also</b></dt> <dd><a href="#Graphic">Graphic</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Graphic" class="membertitle">Graphic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ transient ] ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> <b>Graphic</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies a graphic to be displayed at the button </dd> <dd><p>If this property is present, it interacts with the <a href="#ImageURL">ImageURL</a>in the following way: <ul><li>If <a href="#ImageURL">ImageURL</a> is set, <a href="#Graphic">Graphic</a> will be reset to an object as loaded from the given image URL, or <b>NULL</b> if <a href="#ImageURL">ImageURL</a> does not point to a valid image file.</li> <li>If <a href="#Graphic">Graphic</a> is set, <a href="#ImageURL">ImageURL</a> will be reset to an empty string.</li> </ul></p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Label" class="membertitle">Label</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Label</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the label of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MultiLine" class="membertitle">MultiLine</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>MultiLine</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies that the text may be displayed on more than one line. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Printable" class="membertitle">Printable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Printable</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the control will be printed with the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PushButtonType" class="membertitle">PushButtonType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>PushButtonType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the default action of the button as <a href="PushButtonType.html">PushButtonType</a> value. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Repeat" class="membertitle">Repeat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Repeat</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the control should show repeating behaviour. </dd> <dd><p>Normally, when you click a button with the mouse, you need to release the mouse button, and press it again. With this property set to <b>true</b>, the button is repeatedly pressed while you hold down the mouse button.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RepeatDelay" class="membertitle">RepeatDelay</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>RepeatDelay</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the mouse repeat delay, in milliseconds. </dd> <dd><p>When the user presses a mouse in a control area where this triggers an action (such as pressing the button), then usual control implementations allow to repeatedly trigger this action, without the need to release the mouse button and to press it again. The delay between two such triggers is specified with this property.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="State" class="membertitle">State</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>State</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the state of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Tabstop" class="membertitle">Tabstop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Tabstop</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the control can be reached with the TAB key. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextColor" class="membertitle">TextColor</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="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>TextColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextLineColor" class="membertitle">TextLineColor</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="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>TextLineColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text line color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Toggle" class="membertitle">Toggle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Toggle</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the button should toggle on a single operation. </dd> <dd><p>If this property is set to <b>true</b>, a single operation of the button control (pressing space while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not pressed</em> state.</p> <p>The default for this property is <b>false</b>, which means the button behaves like a usual push button.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="VerticalAlign" class="membertitle">VerticalAlign</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="../style/module-ix.html">style</a>::<a href="../style/VerticalAlignment.html">VerticalAlignment</a> <b>VerticalAlign</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the vertical alignment of the text in the control. </dd> <dt><b/></dt> <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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1004
