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
24#ifndef __com_sun_star_inspection_XNumericControl_idl__
25#define __com_sun_star_inspection_XNumericControl_idl__
26
27#ifndef __com_sun_star_inspection_XPropertyControl_idl__
28#include <com/sun/star/inspection/XPropertyControl.idl>
29#endif
30#ifndef __com_sun_star_beans_Optional_idl__
31#include <com/sun/star/beans/Optional.idl>
32#endif
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36
37//=============================================================================
38module com {  module sun {  module star {  module inspection {
39
40//-----------------------------------------------------------------------------
41/** defines the interface for an <type>XPropertyControl</type> which supports
42    displaying and entering numerical values.
43
44    @since OpenOffice 2.0.3
45*/
46published interface XNumericControl : XPropertyControl
47{
48    /** describes the number of decimal digits to use for the value
49    */
50    [attribute] short   DecimalDigits;
51
52    /** describes the minimum value which is allowed to be entered in the control
53    */
54    [attribute] com::sun::star::beans::Optional<double> MinValue;
55
56    /** describes the maximum value which is allowed to be entered in the control
57    */
58    [attribute] com::sun::star::beans::Optional<double> MaxValue;
59
60    /** describes a <type scope="com::sun::star::util">MeasureUnit</type> to be applied
61        for displaying values.
62
63        <p>Only a certain set of <type scope="com::sun::star::util">MeasureUnit</type> values is
64        supported. In particular, every value which denotes a fraction of another
65        unit (like 100th millimiters) cannot be used as DisplayUnit.</p>
66
67        @throws com::sun::star::lang::IllegalArgumentException
68            if the caller attempts to set an unsupported <type scope="com::sun::star::util">MeasureUnit</type>
69    */
70    [attribute] short DisplayUnit
71    {
72        set raises (com::sun::star::lang::IllegalArgumentException);
73    };
74
75    /** describes a <type scope="com::sun::star::util">MeasureUnit</type> to be
76        applied for transfering values.
77
78        <p>The core measurement unit for a property value might differ from the unit which
79        is used by the control to display it. For instance, your property value might require
80        that your values denote 100th millimeters, but to the user, you want to present the
81        value as, say, inches. In this case, a numeric control can automatically handle the
82        value conversion for you, if you give it a ValueUnit different from the DisplayUnit.</p>
83
84        @see XPropertyControl::Value
85    */
86    [attribute] short ValueUnit;
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94
95