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