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

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