xref: /AOO41X/main/offapi/com/sun/star/awt/XNumericField.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XNumericField_idl__
24#define __com_sun_star_awt_XNumericField_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** gives access to the value and formatting of a numeric field.
38 */
39published interface XNumericField: com::sun::star::uno::XInterface
40{
41    //-------------------------------------------------------------------------
42
43    /** sets the value which is displayed in the numeric field.
44     */
45    [oneway] void setValue( [in] double Value );
46
47    //-------------------------------------------------------------------------
48
49    /** returns the value which is currently displayed in the numeric field.
50     */
51    double getValue();
52
53    //-------------------------------------------------------------------------
54
55    /** sets the minimum value that can be entered by the user.
56     */
57    [oneway] void setMin( [in] double Value );
58
59    //-------------------------------------------------------------------------
60
61    /** returns the currently set minimum value that can be entered by the
62        user.
63     */
64    double getMin();
65
66    //-------------------------------------------------------------------------
67
68    /** sets the maximum value that can be entered by the user.
69     */
70    [oneway] void setMax( [in] double Value );
71
72    //-------------------------------------------------------------------------
73
74    /** returns the currently set maximum value that can be entered by the
75        user.
76     */
77    double getMax();
78
79    //-------------------------------------------------------------------------
80
81    /** sets the first value to be set on POS1 key.
82     */
83    [oneway] void setFirst( [in] double Value );
84
85    //-------------------------------------------------------------------------
86
87    /** returns the currently set first value which is set on POS1 key.
88     */
89    double getFirst();
90
91    //-------------------------------------------------------------------------
92
93    /** sets the last value to be set on END key.
94     */
95    [oneway] void setLast( [in] double Value );
96
97    //-------------------------------------------------------------------------
98
99    /** returns the currently set last value which is set on END key.
100     */
101    double getLast();
102
103    //-------------------------------------------------------------------------
104
105    /** sets the increment value for the spin button.
106     */
107    [oneway] void setSpinSize( [in] double Value );
108
109    //-------------------------------------------------------------------------
110
111    /** returns the currently set increment value for the spin button.
112     */
113    double getSpinSize();
114
115    //-------------------------------------------------------------------------
116
117    /** sets the number of decimals.
118     */
119    [oneway] void setDecimalDigits( [in] short nDigits );
120
121    //-------------------------------------------------------------------------
122
123    /** returns the currently set number of decimals.
124     */
125    short getDecimalDigits();
126
127    //-------------------------------------------------------------------------
128
129    /** determines if the format is checked during user input.
130     */
131    [oneway] void setStrictFormat( [in] boolean bStrict );
132
133    //-------------------------------------------------------------------------
134
135    /** returns whether the format is currently checked during user input.
136     */
137    boolean isStrictFormat();
138
139};
140
141//=============================================================================
142
143}; }; }; };
144
145#endif
146