offapi/com/sun/star/awt/UnoControlButtonModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: UnoControlButtonModel.idl,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_UnoControlButtonModel_idl__
  31 #define __com_sun_star_awt_UnoControlButtonModel_idl__
  32
  33 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  34 #include <com/sun/star/awt/FontDescriptor.idl>
  35 #endif
  36 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  37 #include <com/sun/star/awt/UnoControlModel.idl>
  38 #endif
  39 #ifndef __com_sun_star_style_VerticalAlignment_idl__
  40 #include <com/sun/star/style/VerticalAlignment.idl>
  41 #endif
  42 #ifndef com_sun_star_graphic_XGraphic_idl
  43 #include <com/sun/star/graphic/XGraphic.idl>
  44 #endif
  45 #ifndef __com_sun_star_util_Color_idl__
  46 #include <com/sun/star/util/Color.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module awt {
  53
  54 //=============================================================================
  55
  56 /** specifies the standard model of an <type>UnoControlButton</type>.
  57  */
  58 published service UnoControlButtonModel
  59 {
  60     service com::sun::star::awt::UnoControlModel;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies the horizontal alignment of the text in the control.
  65
  66         <pre>
  67         0: left
  68         1: center
  69         2: right
  70         </pre>
  71      */
  72     [optional, property] short Align;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** specifies the background color (RGB) of the control.
  77      */
  78     [property] com::sun::star::util::Color BackgroundColor;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** specifies that the button is the default button on the document.
  83      */
  84     [property] boolean DefaultButton;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** determines whether the control is enabled or disabled.
  89      */
  90     [property] boolean Enabled;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** specifies whether the button control should grab the focus when clicked.
  95
  96         <p>If set to <TRUE/> (which is the default), the button control automatically grabs the
  97         focus when the user clicks onto it with the mouse.<br/>
  98         If set to <FALSE/>, the focus is preserved when the user operates the button control with
  99         the mouse.</p>
 100
 101         @since OOo 2.0.0
 102      */
 103     [optional, property] boolean FocusOnClick;
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** specifies the font attributes of the text in the control.
 108      */
 109     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 114         value of the text in the control.
 115      */
 116     [property] short FontEmphasisMark;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 121         value of the text in the control.
 122      */
 123     [property] short FontRelief;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** specifies the help text of the control.
 128      */
 129     [property] string HelpText;
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** specifies the help URL of the control.
 134      */
 135     [property] string HelpURL;
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** specifies the alignment of the image inside the button as
 140         <type>ImageAlign</type> value.
 141      */
 142     [property] short ImageAlign;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** specifies the position of the image, if any, relative to the text, if any
 147
 148         <p>Valid values of this property are specified with <type>ImagePosition</type>.</p>
 149
 150         <p>If this property is present, it supersedes the <member>ImageAlign</member> property - setting
 151         one of both properties sets the other one to the best possible match.</p>
 152      */
 153     [optional, property] short ImagePosition;
 154
 155     //-------------------------------------------------------------------------
 156
 157     /** specifies an URL to an image to use for the button.
 158         @see Graphic
 159      */
 160     [property] string ImageURL;
 161
 162     //-------------------------------------------------------------------------
 163
 164     /** specifies a graphic to be displayed at the button
 165
 166         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 167         following way:
 168         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 169             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 170             does not point to a valid image file.</li>
 171             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 172             to an empty string.</li>
 173         </ul></p>
 174
 175         @since OOo 2.1
 176      */
 177     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** specifies the label of the control.
 182      */
 183     [property] string Label;
 184
 185     //-------------------------------------------------------------------------
 186
 187     /** specifies that the text may be displayed on more than one line.
 188
 189         @since OOo 2.0.0
 190      */
 191     [optional, property] boolean MultiLine;
 192
 193     //-------------------------------------------------------------------------
 194
 195     /** specifies that the control will be printed with the document.
 196      */
 197     [property] boolean Printable;
 198
 199     //-------------------------------------------------------------------------
 200
 201     /** specifies the default action of the button as <type>PushButtonType</type> value.
 202      */
 203     [property] short PushButtonType;
 204
 205     //-------------------------------------------------------------------------
 206
 207     /** specifies whether the control should show repeating behaviour.
 208
 209         <p>Normally, when you click a button with the mouse, you need to
 210         release the mouse button, and press it again. With this property
 211         set to <TRUE/>, the button is repeatedly pressed while you hold
 212         down the mouse button.</p>
 213
 214         @since OOo 2.0.0
 215      */
 216     [optional, property] boolean Repeat;
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** specifies the mouse repeat delay, in milliseconds.
 221
 222         <p>When the user presses a mouse in a control area where this triggers
 223         an action (such as pressing the button), then usual control implementations
 224         allow to repeatedly trigger this action, without the need to release the
 225         mouse button and to press it again. The delay between two such triggers
 226         is specified with this property.</p>
 227
 228         @since OOo 2.0.0
 229      */
 230     [optional, property] long RepeatDelay;
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** specifies the state of the control.
 235      */
 236     [property] short State;
 237
 238     //-------------------------------------------------------------------------
 239
 240     /** specifies that the control can be reached with the TAB key.
 241      */
 242     [property] boolean Tabstop;
 243
 244     //-------------------------------------------------------------------------
 245
 246     /** specifies the text color (RGB) of the control.
 247      */
 248     [property] com::sun::star::util::Color TextColor;
 249
 250     //-------------------------------------------------------------------------
 251
 252     /** specifies the text line color (RGB) of the control.
 253      */
 254     [property] com::sun::star::util::Color TextLineColor;
 255
 256     //-------------------------------------------------------------------------
 257
 258     /** specifies whether the button should toggle on a single operation.
 259
 260         <p>If this property is set to <TRUE/>, a single operation of the button control (pressing space
 261         while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not
 262         pressed</em> state.</p>
 263
 264         <p>The default for this property is <FALSE/>, which means the button behaves like a usual
 265         push button.</p>
 266
 267         @since OOo 2.0.0
 268      */
 269     [optional, property] boolean Toggle;
 270
 271     //-------------------------------------------------------------------------
 272
 273     /** specifies the vertical alignment of the text in the control.
 274
 275         @since OOo 2.0.0
 276      */
 277     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 278
 279 };
 280
 281 //=============================================================================
 282
 283 }; }; }; };
 284
 285 #endif