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