offapi/com/sun/star/awt/XDateField.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_XDateField_idl__
  29 #define __com_sun_star_awt_XDateField_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module awt {
  37
  38 //=============================================================================
  39
  40 /** gives access to the value and settings of a date field.
  41  */
  42 published interface XDateField: com::sun::star::uno::XInterface
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** sets the date value which is displayed in the date field.
  47
  48         <p>The date value must be specified in the format
  49         YYYYMMDD.</p>
  50      */
  51     [oneway] void setDate( [in] long Date );
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** returns the date value which is currently displayed in the date field.
  56      */
  57     long getDate();
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** sets the minimum date value that can be entered by the user.
  62      */
  63     [oneway] void setMin( [in] long Date );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns the currently set minimum date value that can be entered by
  68         the user.
  69      */
  70     long getMin();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** sets the maximum date value that can be entered by the user.
  75      */
  76     [oneway] void setMax( [in] long Date );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns the currently set maximum date value that can be entered by
  81         the user.
  82      */
  83     long getMax();
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** sets the first value to be set on POS1 key.
  88      */
  89     [oneway] void setFirst( [in] long Date );
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** returns the currently set first value which is set on POS1 key.
  94      */
  95     long getFirst();
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** sets the last value to be set on END key.
 100      */
 101     [oneway] void setLast( [in] long Date );
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** returns the currently set last value which is set on END key.
 106      */
 107     long getLast();
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** determines if the long date format is to be used.
 112      */
 113     [oneway] void setLongFormat( [in] boolean bLong );
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** determines if the long date format is currently used.
 118      */
 119     boolean isLongFormat();
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** sets an empty value for the date.
 124      */
 125     void setEmpty();
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** returns whether currently an empty value is set for the date.
 130      */
 131     boolean isEmpty();
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** determines if the format is checked during user input.
 136      */
 137     [oneway] void setStrictFormat( [in] boolean bStrict );
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** returns whether the format is currently checked during user input.
 142      */
 143     boolean isStrictFormat();
 144
 145 };
 146
 147 //=============================================================================
 148
 149 }; }; }; };
 150
 151 #endif
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */