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