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

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