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