offapi/com/sun/star/awt/XMetricField.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: XMetricField.idl,v $
  10  * $Revision: 1.3 $
  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_XMetricField_idl__
  31 #define __com_sun_star_awt_XMetricField_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_util_MeasureUnit_idl__
  37 #include <com/sun/star/util/MeasureUnit.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module awt {
  43
  44 //=============================================================================
  45
  46 /** gives access to the value and formatting of a metric field.
  47  */
  48 interface XMetricField: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** sets the value which is displayed in the metric field.
  53      */
  54     void setValue( [in] hyper Value, [in] short FieldUnit );
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** sets the user value which is displayed in the metric field.
  59      */
  60     void setUserValue( [in] hyper Value, [in] short FieldUnit );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** returns the value which is currently displayed in the metric field.
  65      */
  66     hyper getValue( [in] short FieldUnit );
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** returns the corrected value which is displayed in the metric field.
  71      */
  72     hyper getCorrectedValue( [in] short FieldUnit );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** sets the minimum value that can be entered by the user.
  77      */
  78     void setMin( [in] hyper Value, [in] short FieldUnit );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** returns the currently set minimum value that can be entered by the
  83         user.
  84      */
  85     hyper getMin( [in] short FieldUnit );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** sets the maximum value that can be entered by the user.
  90      */
  91     void setMax( [in] hyper Value, [in] short FieldUnit );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** returns the currently set maximum value that can be entered by the
  96         user.
  97      */
  98     hyper getMax( [in] short FieldUnit );
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** sets the first value to be set on POS1 key.
 103      */
 104     void setFirst( [in] hyper Value, [in] short FieldUnit );
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** returns the currently set first value which is set on POS1 key.
 109      */
 110     hyper getFirst( [in] short FieldUnit );
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** sets the last value to be set on END key.
 115      */
 116     void setLast( [in] hyper Value, [in] short FieldUnit );
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** returns the currently set last value which is set on END key.
 121      */
 122     hyper getLast( [in] short FieldUnit );
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** sets the increment value for the spin button.
 127      */
 128     void setSpinSize( [in] hyper Value );
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** returns the currently set increment value for the spin button.
 133      */
 134     hyper getSpinSize();
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** sets the number of decimals.
 139      */
 140     void setDecimalDigits( [in] short nDigits );
 141
 142     //-------------------------------------------------------------------------
 143
 144     /** returns the currently set number of decimals.
 145      */
 146     short getDecimalDigits();
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** determines if the format is checked during user input.
 151      */
 152     void setStrictFormat( [in] boolean bStrict );
 153
 154     //-------------------------------------------------------------------------
 155
 156     /** returns whether the format is currently checked during user input.
 157      */
 158     boolean isStrictFormat();
 159
 160 };
 161
 162 //=============================================================================
 163
 164 }; }; }; };
 165
 166 #endif