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