summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XMetricField.idl
blob: 5bc6a7da40e2245d56043cd902dcf54de3640c1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_XMetricField_idl__
#define __com_sun_star_awt_XMetricField_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_MeasureUnit_idl__
#include <com/sun/star/util/MeasureUnit.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** gives access to the value and formatting of a metric field.
 */
interface XMetricField: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** sets the value which is displayed in the metric field.
     */
    void setValue( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the user value which is displayed in the metric field.
     */
    void setUserValue( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the value which is currently displayed in the metric field.
     */
    hyper getValue( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the corrected value which is displayed in the metric field.
     */
    hyper getCorrectedValue( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the minimum value that can be entered by the user.
     */
    void setMin( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the currently set minimum value that can be entered by the
        user.
     */
    hyper getMin( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the maximum value that can be entered by the user.
     */
    void setMax( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the currently set maximum value that can be entered by the
        user.
     */
    hyper getMax( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the first value to be set on POS1 key.
     */
    void setFirst( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the currently set first value which is set on POS1 key.
     */
    hyper getFirst( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the last value to be set on END key.
     */
    void setLast( [in] hyper Value, [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** returns the currently set last value which is set on END key.
     */
    hyper getLast( [in] short FieldUnit );

    //-------------------------------------------------------------------------

    /** sets the increment value for the spin button.
     */
    void setSpinSize( [in] hyper Value );

    //-------------------------------------------------------------------------

    /** returns the currently set increment value for the spin button.
     */
    hyper getSpinSize();

    //-------------------------------------------------------------------------

    /** sets the number of decimals.
     */
    void setDecimalDigits( [in] short nDigits );

    //-------------------------------------------------------------------------

    /** returns the currently set number of decimals.
     */
    short getDecimalDigits();

    //-------------------------------------------------------------------------

    /** determines if the format is checked during user input.
     */
    void setStrictFormat( [in] boolean bStrict );

    //-------------------------------------------------------------------------

    /** returns whether the format is currently checked during user input.
     */
    boolean isStrictFormat();

};

//=============================================================================

}; }; }; };

#endif