offapi/com/sun/star/awt/UnoControlNumericFieldModel.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: UnoControlNumericFieldModel.idl,v $
  10  * $Revision: 1.16 $
  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_UnoControlNumericFieldModel_idl__
  31 #define __com_sun_star_awt_UnoControlNumericFieldModel_idl__
  32
  33 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  34 #include <com/sun/star/awt/FontDescriptor.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  38 #include <com/sun/star/awt/UnoControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_Color_idl__
  42 #include <com/sun/star/util/Color.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module awt {
  49
  50 //=============================================================================
  51
  52 /** specifies the standard model of an <type>UnoControlNumericField</type>.
  53  */
  54 published service UnoControlNumericFieldModel
  55 {
  56     service com::sun::star::awt::UnoControlModel;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** specifies the background color(RGB) of the control.
  61      */
  62     [property] com::sun::star::util::Color BackgroundColor;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** specifies the border style of the control.
  67
  68         <pre>
  69         0: No border
  70         1: 3D border
  71         2: simple border
  72         </pre>
  73      */
  74     [property] short Border;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** specifies the color of the border, if present
  79
  80         <p>Not every border style (see <member>Border</member>) may support coloring.
  81         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  82
  83         @since OOo 2.0.0
  84      */
  85     [optional, property] long BorderColor;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** specifies the decimal accuracy.
  90      */
  91     [property] short DecimalAccuracy;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** determines whether the control is enabled or disabled.
  96      */
  97     [property] boolean Enabled;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** specifies the font attributes of the text in the control.
 102      */
 103     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 108         value of the text in the control.
 109      */
 110     [property] short FontEmphasisMark;
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 115         value of the text in the control.
 116      */
 117     [property] short FontRelief;
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** specifies the help text of the control.
 122      */
 123     [property] string HelpText;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** specifies the help URL of the control.
 128      */
 129     [property] string HelpURL;
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** specifies whether the selection in the control should be hidden when
 134         the control is not active (focused).
 135
 136         @since OOo 2.0.0
 137      */
 138     [optional, property] boolean HideInactiveSelection;
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** specifies that the control will be printed with the document.
 143      */
 144     [property] boolean Printable;
 145
 146     //-------------------------------------------------------------------------
 147
 148     /** specifies that the content of the control cannot be modified by the
 149         user.
 150      */
 151     [property] boolean ReadOnly;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** specifies whether the mouse should show repeating behaviour, i.e.
 156         repeatedly trigger an action when keeping pressed.
 157
 158         @since OOo 2.0.0
 159      */
 160     [optional, property] boolean Repeat;
 161
 162     //-------------------------------------------------------------------------
 163
 164     /** specifies the mouse repeat delay, in milliseconds.
 165
 166         <p>When the user presses a mouse in a control area where this triggers
 167         an action (such as spinning the value), then usual control implementations
 168         allow to repeatedly trigger this action, without the need to release the
 169         mouse button and to press it again. The delay between two such triggers
 170         is specified with this property.</p>
 171
 172         @since OOo 2.0.0
 173      */
 174     [optional, property] long RepeatDelay;
 175
 176     //-------------------------------------------------------------------------
 177
 178     /** specifies whether the thousands separator is to be displayed.
 179      */
 180     [property] boolean ShowThousandsSeparator;
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** specifies that the control has a spin button.
 185      */
 186     [property] boolean Spin;
 187
 188     //-------------------------------------------------------------------------
 189
 190     /** specifies that the value is checked during the user input.
 191      */
 192     [property] boolean StrictFormat;
 193
 194     //-------------------------------------------------------------------------
 195
 196     /** specifies that the control can be reached with the TAB key.
 197      */
 198     [property] boolean Tabstop;
 199
 200     //-------------------------------------------------------------------------
 201
 202     /** specifies the text color (RGB) of the control.
 203      */
 204     [property] com::sun::star::util::Color TextColor;
 205
 206     //-------------------------------------------------------------------------
 207
 208     /** specifies the text line color (RGB) of the control.
 209      */
 210     [property] com::sun::star::util::Color TextLineColor;
 211
 212     //-------------------------------------------------------------------------
 213
 214     /** specifies the value displayed in the control.
 215      */
 216     [property] double Value;
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** specifies the maximum value that can be entered.
 221      */
 222     [property] double ValueMax;
 223
 224     //-------------------------------------------------------------------------
 225
 226     /** specifies the minimum value that can be entered.
 227      */
 228     [property] double ValueMin;
 229
 230     //-------------------------------------------------------------------------
 231
 232     /** specifies the value step when using the spin button.
 233      */
 234     [property] double ValueStep;
 235
 236     /** denotes the writing mode used in the control, as specified in the
 237         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 238
 239         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 240         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 241
 242         @since OOo 3.1
 243     */
 244     [optional, property] short WritingMode;
 245
 246     /** defines how the mouse wheel can be used to scroll through the control's content.
 247
 248         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 249         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 250         this is possible.</p>
 251     */
 252     [optional, property] short MouseWheelBehavior;
 253 };
 254
 255 //=============================================================================
 256
 257 }; }; }; };
 258
 259 #endif