offapi/com/sun/star/awt/XTimeField.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: XTimeField.idl,v $
  10  * $Revision: 1.9 $
  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_XTimeField_idl__
  31 #define __com_sun_star_awt_XTimeField_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 time field.
  45  */
  46 published interface XTimeField: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** sets the time value which is displayed in the time field.
  51
  52         <p>The time value must be specified in the format HHMMSShh,
  53         where HH are hours, MM are minutes, SS are seconds and hh are
  54         hundredth seconds.</p>
  55      */
  56     [oneway] void setTime( [in] long Time );
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** returns the time value which is currently displayed in the time field.
  61      */
  62     long getTime();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the minimum time value that can be entered by the user.
  67      */
  68     [oneway] void setMin( [in] long Time );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** returns the currently set minimum time value that can be entered by
  73         the user.
  74      */
  75     long getMin();
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** sets the maximum time value that can be entered by the user.
  80      */
  81     [oneway] void setMax( [in] long Time );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** returns the currently set maximum time value that can be entered by
  86         the user.
  87      */
  88     long getMax();
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** sets the first value to be set on POS1 key.
  93      */
  94     [oneway] void setFirst( [in] long Time );
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** returns the currently set first value which is set on POS1 key.
  99      */
 100     long getFirst();
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** sets the last value to be set on END key.
 105      */
 106     [oneway] void setLast( [in] long Time );
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** returns the currently set last value which is set on END key.
 111      */
 112     long getLast();
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** sets an empty value for the time.
 117      */
 118     void setEmpty();
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** returns whether currently an empty value is set for the time.
 123      */
 124     boolean isEmpty();
 125
 126     //-------------------------------------------------------------------------
 127
 128     /** determines if the format is checked during user input.
 129      */
 130     [oneway] void setStrictFormat( [in] boolean bStrict );
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** returns whether the format is currently checked during user input.
 135      */
 136     boolean isStrictFormat();
 137
 138 };
 139
 140 //=============================================================================
 141
 142 }; }; }; };
 143
 144 #endif