offapi/com/sun/star/awt/UnoControlDateFieldModel.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_UnoControlDateFieldModel_idl__
  29 #define __com_sun_star_awt_UnoControlDateFieldModel_idl__
  30
  31 #include <com/sun/star/awt/FontDescriptor.idl>
  32 #include <com/sun/star/awt/UnoControlModel.idl>
  33
  34 #include <com/sun/star/util/Color.idl>
  35
  36 #include <com/sun/star/style/VerticalAlignment.idl>
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** specifies the standard model of an <type>UnoControlDateField</type>.
  45  */
  46 published service UnoControlDateFieldModel
  47 {
  48     service com::sun::star::awt::UnoControlModel;
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** specifies the background color(RGB) of the control.
  53      */
  54     [property] com::sun::star::util::Color BackgroundColor;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the border style of the control.
  59
  60         <pre>
  61         0: No border
  62         1: 3D border
  63         2: simple border
  64         </pre>
  65      */
  66     [property] short Border;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** specifies the color of the border, if present
  71
  72         <p>Not every border style (see <member>Border</member>) may support coloring.
  73         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  74
  75         @since OOo 2.0
  76      */
  77     [optional, property] long BorderColor;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** specifies the date displayed in the control.
  82
  83         <p>The date must be specified in the format YYYYMMDD.</p>
  84      */
  85     [property] long Date;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** specifies the format of the displayed date.
  90
  91         <pre>
  92         0:   system short
  93         1:   system short YY
  94         2:   system short YYYY
  95         3:   system long
  96         4:   short DDMMYY
  97         5:   short MMDDYY
  98         6:   short YYMMDD
  99         7:   short DDMMYYYY
 100         8:   short MMDDYYYY
 101         9:   short YYYYMMDD
 102         10:  short YYMMDD DIN5008
 103         11:  short YYYYMMDD DIN5008
 104         </pre>
 105      */
 106     [property] short DateFormat;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies the maximum date that can be entered.
 111      */
 112     [property] long DateMax;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the minimum date that can be entered.
 117      */
 118     [property] long DateMin;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies, if the date century is displayed.
 123      */
 124     [property] boolean DateShowCentury;
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** specifies, if the control has a dropdown button.
 129      */
 130     [property] boolean Dropdown;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** determines whether the control is enabled or disabled.
 135      */
 136     [property] boolean Enabled;
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** specifies the font attributes of the text in the control.
 141      */
 142     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 147         value of the text in the control.
 148      */
 149     [property] short FontEmphasisMark;
 150
 151     //-------------------------------------------------------------------------
 152
 153     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 154         value of the text in the control.
 155      */
 156     [property] short FontRelief;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** specifies the help text of the control.
 161      */
 162     [property] string HelpText;
 163
 164     //-------------------------------------------------------------------------
 165
 166     /** specifies the help URL of the control.
 167      */
 168     [property] string HelpURL;
 169
 170     //-------------------------------------------------------------------------
 171
 172     /** specifies whether the selection in the control should be hidden when
 173         the control is not active (focused).
 174
 175         @since OOo 2.0
 176      */
 177     [optional, property] boolean HideInactiveSelection;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** specifies that the control will be printed with the document.
 182      */
 183     [property] boolean Printable;
 184
 185     //-------------------------------------------------------------------------
 186
 187     /** specifies that the content of the control cannot be modified by the user.
 188      */
 189     [property] boolean ReadOnly;
 190
 191     //-------------------------------------------------------------------------
 192
 193     /** specifies whether the mouse should show repeating behavior, i.e.
 194         repeatedly trigger an action when keeping pressed.
 195
 196         @since OOo 2.0
 197      */
 198     [optional, property] boolean Repeat;
 199
 200     //-------------------------------------------------------------------------
 201
 202     /** specifies the mouse repeat delay, in milliseconds.
 203
 204         <p>When the user presses a mouse in a control area where this triggers
 205         an action (such as spinning the value), then usual control implementations
 206         allow to repeatedly trigger this action, without the need to release the
 207         mouse button and to press it again. The delay between two such triggers
 208         is specified with this property.</p>
 209
 210         @since OOo 2.0
 211      */
 212     [optional, property] long RepeatDelay;
 213
 214     //-------------------------------------------------------------------------
 215
 216     /** specifies that the control has a spin button.
 217      */
 218     [property] boolean Spin;
 219
 220     //-------------------------------------------------------------------------
 221
 222     /** specifies that the date is checked during the user input.
 223      */
 224     [property] boolean StrictFormat;
 225
 226     //-------------------------------------------------------------------------
 227
 228     /** specifies that the control can be reached with the TAB key.
 229      */
 230     [property] boolean Tabstop;
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** specifies the text displayed in the control.
 235
 236         @since OOo 2.0
 237      */
 238     [optional, property] string Text;
 239
 240     //-------------------------------------------------------------------------
 241
 242     /** specifies the text color (RGB) of the control.
 243      */
 244     [property] com::sun::star::util::Color TextColor;
 245
 246     //-------------------------------------------------------------------------
 247
 248     /** specifies the text line color (RGB) of the control.
 249      */
 250     [property] com::sun::star::util::Color TextLineColor;
 251
 252     /** denotes the writing mode used in the control, as specified in the
 253         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 254
 255         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 256         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 257
 258         @since OOo 3.1
 259     */
 260     [optional, property] short WritingMode;
 261
 262     /** defines how the mouse wheel can be used to scroll through the control's content.
 263
 264         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 265         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 266         this is possible.</p>
 267     */
 268     [optional, property] short MouseWheelBehavior;
 269
 270     //-------------------------------------------------------------------------
 271
 272     /** specifies the vertical alignment of the text in the control.
 273
 274         @since OOo 3.3
 275      */
 276     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 277 };
 278
 279 //=============================================================================
 280
 281 }; }; }; };
 282
 283 #endif
 284
 285 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */