offapi/com/sun/star/awt/XNumericField.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: XNumericField.idl,v $
  10  * $Revision: 1.12 $
  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_XNumericField_idl__
  31 #define __com_sun_star_awt_XNumericField_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 formatting of a numeric field.
  45  */
  46 published interface XNumericField: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** sets the value which is displayed in the numeric field.
  51      */
  52     [oneway] void setValue( [in] double Value );
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** returns the value which is currently displayed in the numeric field.
  57      */
  58     double getValue();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the minimum value that can be entered by the user.
  63      */
  64     [oneway] void setMin( [in] double Value );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** returns the currently set minimum value that can be entered by the
  69         user.
  70      */
  71     double getMin();
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** sets the maximum value that can be entered by the user.
  76      */
  77     [oneway] void setMax( [in] double Value );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns the currently set maximum value that can be entered by the
  82         user.
  83      */
  84     double getMax();
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** sets the first value to be set on POS1 key.
  89      */
  90     [oneway] void setFirst( [in] double Value );
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** returns the currently set first value which is set on POS1 key.
  95      */
  96     double getFirst();
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** sets the last value to be set on END key.
 101      */
 102     [oneway] void setLast( [in] double Value );
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** returns the currently set last value which is set on END key.
 107      */
 108     double getLast();
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** sets the increment value for the spin button.
 113      */
 114     [oneway] void setSpinSize( [in] double Value );
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** returns the currently set increment value for the spin button.
 119      */
 120     double getSpinSize();
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** sets the number of decimals.
 125      */
 126     [oneway] void setDecimalDigits( [in] short nDigits );
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** returns the currently set number of decimals.
 131      */
 132     short getDecimalDigits();
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** determines if the format is checked during user input.
 137      */
 138     [oneway] void setStrictFormat( [in] boolean bStrict );
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** returns whether the format is currently checked during user input.
 143      */
 144     boolean isStrictFormat();
 145
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif