offapi/com/sun/star/awt/XMetricField.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_XMetricField_idl__
  20 #define __com_sun_star_awt_XMetricField_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/MeasureUnit.idl>
  24
  25
  26  module com {  module sun {  module star {  module awt {
  27
  28
  29 /** gives access to the value and formatting of a metric field.
  30  */
  31 interface XMetricField: com::sun::star::uno::XInterface
  32 {
  33
  34     /** sets the value which is displayed in the metric field.
  35      */
  36     void setValue( [in] hyper Value, [in] short FieldUnit );
  37
  38
  39     /** sets the user value which is displayed in the metric field.
  40      */
  41     void setUserValue( [in] hyper Value, [in] short FieldUnit );
  42
  43
  44     /** returns the value which is currently displayed in the metric field.
  45      */
  46     hyper getValue( [in] short FieldUnit );
  47
  48
  49     /** returns the corrected value which is displayed in the metric field.
  50      */
  51     hyper getCorrectedValue( [in] short FieldUnit );
  52
  53
  54     /** sets the minimum value that can be entered by the user.
  55      */
  56     void setMin( [in] hyper Value, [in] short FieldUnit );
  57
  58
  59     /** returns the currently set minimum value that can be entered by the
  60         user.
  61      */
  62     hyper getMin( [in] short FieldUnit );
  63
  64
  65     /** sets the maximum value that can be entered by the user.
  66      */
  67     void setMax( [in] hyper Value, [in] short FieldUnit );
  68
  69
  70     /** returns the currently set maximum value that can be entered by the
  71         user.
  72      */
  73     hyper getMax( [in] short FieldUnit );
  74
  75
  76     /** sets the first value to be set on POS1 key.
  77      */
  78     void setFirst( [in] hyper Value, [in] short FieldUnit );
  79
  80
  81     /** returns the currently set first value which is set on POS1 key.
  82      */
  83     hyper getFirst( [in] short FieldUnit );
  84
  85
  86     /** sets the last value to be set on END key.
  87      */
  88     void setLast( [in] hyper Value, [in] short FieldUnit );
  89
  90
  91     /** returns the currently set last value which is set on END key.
  92      */
  93     hyper getLast( [in] short FieldUnit );
  94
  95
  96     /** sets the increment value for the spin button.
  97      */
  98     void setSpinSize( [in] hyper Value );
  99
 100
 101     /** returns the currently set increment value for the spin button.
 102      */
 103     hyper getSpinSize();
 104
 105
 106     /** sets the number of decimals.
 107      */
 108     void setDecimalDigits( [in] short nDigits );
 109
 110
 111     /** returns the currently set number of decimals.
 112      */
 113     short getDecimalDigits();
 114
 115
 116     /** determines if the format is checked during user input.
 117      */
 118     void setStrictFormat( [in] boolean bStrict );
 119
 120
 121     /** returns whether the format is currently checked during user input.
 122      */
 123     boolean isStrictFormat();
 124
 125 };
 126
 127
 128 }; }; }; };
 129
 130 #endif
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */