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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XTimeField_idl__
  20 #define __com_sun_star_awt_XTimeField_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/Time.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module awt {
  28
  29
  30 /** gives access to the value and settings of a time field.
  31  */
  32 published interface XTimeField: com::sun::star::uno::XInterface
  33 {
  34
  35     /** sets the time value which is displayed in the time field.
  36      */
  37     void setTime( [in] com::sun::star::util::Time Time );
  38
  39
  40     /** returns the time value which is currently displayed in the time field.
  41      */
  42     com::sun::star::util::Time getTime();
  43
  44
  45     /** sets the minimum time value that can be entered by the user.
  46      */
  47     void setMin( [in] com::sun::star::util::Time Time );
  48
  49
  50     /** returns the currently set minimum time value that can be entered by
  51         the user.
  52      */
  53     com::sun::star::util::Time getMin();
  54
  55
  56     /** sets the maximum time value that can be entered by the user.
  57      */
  58     void setMax( [in] com::sun::star::util::Time Time );
  59
  60
  61     /** returns the currently set maximum time value that can be entered by
  62         the user.
  63      */
  64     com::sun::star::util::Time getMax();
  65
  66
  67     /** sets the first value to be set on POS1 key.
  68      */
  69     void setFirst( [in] com::sun::star::util::Time Time );
  70
  71
  72     /** returns the currently set first value which is set on POS1 key.
  73      */
  74     com::sun::star::util::Time getFirst();
  75
  76
  77     /** sets the last value to be set on END key.
  78      */
  79     void setLast( [in] com::sun::star::util::Time Time );
  80
  81
  82     /** returns the currently set last value which is set on END key.
  83      */
  84     com::sun::star::util::Time getLast();
  85
  86
  87     /** sets an empty value for the time.
  88      */
  89     void setEmpty();
  90
  91
  92     /** returns whether currently an empty value is set for the time.
  93      */
  94     boolean isEmpty();
  95
  96
  97     /** determines if the format is checked during user input.
  98      */
  99     void setStrictFormat( [in] boolean bStrict );
 100
 101
 102     /** returns whether the format is currently checked during user input.
 103      */
 104     boolean isStrictFormat();
 105
 106 };
 107
 108
 109 }; }; }; };
 110
 111 #endif
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */