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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_UnoControlFormattedFieldModel_idl__
  29 #define __com_sun_star_awt_UnoControlFormattedFieldModel_idl__
  30
  31 #include <com/sun/star/awt/FontDescriptor.idl>
  32 #include <com/sun/star/awt/UnoControlModel.idl>
  33 #include <com/sun/star/util/Color.idl>
  34 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  35 #include <com/sun/star/style/VerticalAlignment.idl>
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module awt {
  40
  41 //=============================================================================
  42
  43 /** specifies the standard model of an <type>UnoControlFormattedField </type>.
  44  */
  45 published service UnoControlFormattedFieldModel
  46 {
  47     service com::sun::star::awt::UnoControlModel;
  48
  49     //-------------------------------------------------------------------------
  50
  51     /** specifies the horizontal alignment of the text in the control.
  52
  53         <pre>
  54         0: left
  55         1: center
  56         2: right
  57         </pre>
  58      */
  59     [property] short Align;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** specifies the background color (RGB) of the control.
  64      */
  65     [property] com::sun::star::util::Color BackgroundColor;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** specifies the border style of the control.
  70
  71         <pre>
  72         0: No border
  73         1: 3D border
  74         2: simple border
  75         </pre>
  76      */
  77     [property] short Border;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** specifies the color of the border, if present
  82
  83         <p>Not every border style (see <member>Border</member>) may support coloring.
  84         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  85
  86         @since OOo 2.0
  87      */
  88     [optional, property] long BorderColor;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** specifies the default value of the formatted field.
  93
  94         <p>This may be a numeric value (double) or a string, depending on
  95         the formatting of the field.</p>
  96      */
  97     [property] any EffectiveDefault;
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** specifies the maximum value that can be entered.
 102
 103         <p>This property is ignored if the format of the field is no numeric
 104         format.</p>
 105      */
 106     [property] double EffectiveMax;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies the minimum value that can be entered.
 111
 112         <p>This property is ignored if the format of the field is no numeric
 113         format.</p>
 114      */
 115     [property] double EffectiveMin;
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** specifies the current value of the formatted field.
 120
 121         <p>This may be a numeric value (double) or a string, depending on
 122         the formatting of the field.</p>
 123      */
 124     [property] double EffectiveValue;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** determines whether the control is enabled or disabled.
 129      */
 130     [property] boolean Enabled;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** specifies the font attributes of the text in the control.
 135      */
 136     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 141         value of the text in the control.
 142      */
 143     [property] short FontEmphasisMark;
 144
 145     //-------------------------------------------------------------------------
 146
 147     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 148         value of the text in the control.
 149      */
 150     [property] short FontRelief;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** specifies the format to be used when formatting the field input
 155         and output.
 156
 157         <p>This value is meaningful relative to the FormatsSupplier property
 158         only.</p>
 159      */
 160     [property] long FormatKey;
 161
 162     //-------------------------------------------------------------------------
 163
 164     /** supplies the formats the field should work with.
 165      */
 166     [property] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier;
 167
 168     //-------------------------------------------------------------------------
 169
 170     /** specifies the help text of the control.
 171      */
 172     [property] string HelpText;
 173
 174     //-------------------------------------------------------------------------
 175
 176     /** specifies the help URL of the control.
 177      */
 178     [property] string HelpURL;
 179
 180
 181     //-------------------------------------------------------------------------
 182
 183     /** specifies whether the selection in the control should be hidden when
 184         the control is not active (focused).
 185
 186         @since OOo 2.0
 187      */
 188     [optional, property] boolean HideInactiveSelection;
 189
 190     //-------------------------------------------------------------------------
 191
 192     /** specifies the maximum character count.
 193
 194         <p>There's no limitation, if set to 0.</p>
 195      */
 196     [property] short MaxTextLen;
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** specifies that the control will be printed with the document.
 201      */
 202     [property] boolean Printable;
 203
 204     //-------------------------------------------------------------------------
 205
 206     /** specifies that the content of the control cannot be modified by the
 207         user.
 208      */
 209     [property] boolean ReadOnly;
 210
 211     //-------------------------------------------------------------------------
 212
 213     /** specifies whether the mouse should show repeating behavior, i.e.
 214         repeatedly trigger an action when keeping pressed.
 215
 216         @since OOo 2.0
 217      */
 218     [optional, property] boolean Repeat;
 219
 220     //-------------------------------------------------------------------------
 221
 222     /** specifies the mouse repeat delay, in milliseconds.
 223
 224         <p>When the user presses a mouse in a control area where this triggers
 225         an action (such as spinning the value), then usual control implementations
 226         allow to repeatedly trigger this action, without the need to release the
 227         mouse button and to press it again. The delay between two such triggers
 228         is specified with this property.</p>
 229
 230         @since OOo 2.0
 231      */
 232     [optional, property] long RepeatDelay;
 233
 234     //-------------------------------------------------------------------------
 235
 236     /** specifies that the control has a spin button.
 237      */
 238     [property] boolean Spin;
 239
 240     //-------------------------------------------------------------------------
 241
 242     /** specifies that the text is checked during the user input.
 243
 244         <p>This property is optional - not every component implementing this
 245         service is required to provide it, as real-time input checking on a
 246         formatted field may be pretty expensive.</p>
 247      */
 248     [optional, property] boolean StrictFormat;
 249
 250     //-------------------------------------------------------------------------
 251
 252     /** specifies that the control can be reached with the TAB key.
 253      */
 254     [property] boolean Tabstop;
 255
 256     //-------------------------------------------------------------------------
 257
 258     /** specifies the text displayed in the control.
 259      */
 260     [property] string Text;
 261
 262     //-------------------------------------------------------------------------
 263
 264     /** specifies the text color (RGB) of the control.
 265      */
 266     [property] com::sun::star::util::Color TextColor;
 267
 268     //-------------------------------------------------------------------------
 269
 270     /** specifies the text line color (RGB) of the control.
 271      */
 272     [property] com::sun::star::util::Color TextLineColor;
 273
 274     //-------------------------------------------------------------------------
 275
 276     /** specifies that the text is treated as a number.
 277      */
 278     [property] boolean TreatAsNumber;
 279
 280     /** denotes the writing mode used in the control, as specified in the
 281         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 282
 283         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 284         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 285
 286         @since OOo 3.1
 287     */
 288     [optional, property] short WritingMode;
 289
 290     /** defines how the mouse wheel can be used to scroll through the control's content.
 291
 292         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 293         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 294         this is possible.</p>
 295     */
 296     [optional, property] short MouseWheelBehavior;
 297
 298     //-------------------------------------------------------------------------
 299
 300     /** specifies the vertical alignment of the text in the control.
 301
 302         @since OOo 3.3
 303      */
 304     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 305 };
 306
 307 //=============================================================================
 308
 309 }; }; }; };
 310
 311 #endif
 312
 313 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */