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