offapi/com/sun/star/awt/UnoControlTimeFieldModel.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 UnoControlTimeField.
  25  */
  26 published service UnoControlTimeFieldModel
  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     /** determines whether the control is enabled or disabled.
  58      */
  59     [property] boolean Enabled;
  60
  61
  62     /** specifies the font attributes of the text in the control.
  63      */
  64     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  65
  66
  67     /** specifies the com::sun::star::text::FontEmphasis
  68         value of the text in the control.
  69      */
  70     [property] short FontEmphasisMark;
  71
  72
  73     /** specifies the com::sun::star::text::FontRelief
  74         value of the text in the control.
  75      */
  76     [property] short FontRelief;
  77
  78
  79     /** specifies the help text of the control.
  80      */
  81     [property] string HelpText;
  82
  83
  84     /** specifies the help URL of the control.
  85      */
  86     [property] string HelpURL;
  87
  88
  89     /** specifies whether the selection in the control should be hidden when
  90         the control is not active (focused).
  91
  92         @since OOo 2.0
  93      */
  94     [optional, property] boolean HideInactiveSelection;
  95
  96
  97     /** specifies that the control will be printed with the document.
  98      */
  99     [property] boolean Printable;
 100
 101
 102     /** specifies that the content of the control cannot be modified by the user.
 103      */
 104     [property] boolean ReadOnly;
 105
 106
 107     /** specifies whether the mouse should show repeating behavior, i.e.
 108         repeatedly trigger an action when keeping pressed.
 109
 110         @since OOo 2.0
 111      */
 112     [optional, property] boolean Repeat;
 113
 114
 115     /** specifies the mouse repeat delay, in milliseconds.
 116
 117         <p>When the user presses a mouse in a control area where this triggers
 118         an action (such as spinning the value), then usual control implementations
 119         allow to repeatedly trigger this action, without the need to release the
 120         mouse button and to press it again. The delay between two such triggers
 121         is specified with this property.</p>
 122
 123         @since OOo 2.0
 124      */
 125     [optional, property] long RepeatDelay;
 126
 127
 128     /** specifies that the control has a spin button.
 129      */
 130     [property] boolean Spin;
 131
 132
 133     /** specifies that the date is checked during the user input.
 134      */
 135     [property] boolean StrictFormat;
 136
 137
 138     /** specifies that the control can be reached with the TAB key.
 139      */
 140     [property] boolean Tabstop;
 141
 142
 143     /** specifies the text displayed in the control.
 144
 145         @since OOo 2.0
 146      */
 147     [optional, property] string Text;
 148
 149
 150     /** specifies the text color (RGB) of the control.
 151      */
 152     [property] com::sun::star::util::Color TextColor;
 153
 154
 155     /** specifies the text line color (RGB) of the control.
 156      */
 157     [property] com::sun::star::util::Color TextLineColor;
 158
 159
 160     /** specifies the time displayed in the control.
 161      */
 162     [property] com::sun::star::util::Time Time;
 163
 164
 165     /** specifies the format of the displayed time.
 166
 167         <pre>
 168         0:  24h short
 169         1:  24h long
 170         2:  12h short
 171         3:  12h long
 172         4:  Duration short
 173         5:  Duration long
 174         </pre>
 175      */
 176     [property] short TimeFormat;
 177
 178
 179     /** specifies the maximum time that can be entered.
 180      */
 181     [property] com::sun::star::util::Time TimeMax;
 182
 183
 184     /** specifies the minimum time that can be entered.
 185      */
 186     [property] com::sun::star::util::Time TimeMin;
 187
 188     /** denotes the writing mode used in the control, as specified in the
 189         com::sun::star::text::WritingMode2 constants group.
 190
 191         <p>Only com::sun::star::text::WritingMode2::LR_TB and
 192         com::sun::star::text::WritingMode2::RL_TB are supported at the moment.</p>
 193
 194         @since OOo 3.1
 195     */
 196     [optional, property] short WritingMode;
 197
 198     /** defines how the mouse wheel can be used to scroll through the control's content.
 199
 200         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 201         and one of the MouseWheelBehavior constants, you can control under which circumstances
 202         this is possible.</p>
 203     */
 204     [optional, property] short MouseWheelBehavior;
 205
 206
 207     /** specifies the vertical alignment of the text in the control.
 208
 209         @since OOo 3.3
 210      */
 211     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 212
 213     /** specifies the background color (RGB) of selected text in the control which is highlighted.
 214
 215         @since LibreOffice 7.5
 216      */
 217     [optional, property] com::sun::star::util::Color HighlightColor;
 218
 219     /** specifies the text color (RGB) of selected text in the control which is highlighted.
 220
 221         @since LibreOffice 7.5
 222      */
 223     [optional, property] com::sun::star::util::Color HighlightTextColor;
 224 };
 225
 226
 227 }; }; }; };
 228
 229 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */