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
|
/*************************************************************************
*
* 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_inspection_XNumericControl_idl__
#define __com_sun_star_inspection_XNumericControl_idl__
#ifndef __com_sun_star_inspection_XPropertyControl_idl__
#include <com/sun/star/inspection/XPropertyControl.idl>
#endif
#ifndef __com_sun_star_beans_Optional_idl__
#include <com/sun/star/beans/Optional.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//=============================================================================
module com { module sun { module star { module inspection {
//-----------------------------------------------------------------------------
/** defines the interface for an <type>XPropertyControl</type> which supports
displaying and entering numerical values.
@since OOo 2.0.3
*/
interface XNumericControl : XPropertyControl
{
/** describes the number of decimal digits to use for the value
*/
[attribute] short DecimalDigits;
/** describes the minimum value which is allowed to be entered in the control
*/
[attribute] com::sun::star::beans::Optional<double> MinValue;
/** describes the maximum value which is allowed to be entered in the control
*/
[attribute] com::sun::star::beans::Optional<double> MaxValue;
/** describes a <type scope="com::sun::star::util">MeasureUnit</type> to be applied
for displaying values.
<p>Only a certain set of <type scope="com::sun::star::util">MeasureUnit</type> values is
supported. In particular, every value which denotes a fraction of another
unit (like 100th millimiters) cannot be used as DisplayUnit.</p>
@throws com::sun::star::lang::IllegalArgumentException
if the caller attempts to set an unsupported <type scope="com::sun::star::util">MeasureUnit</type>
*/
[attribute] short DisplayUnit
{
set raises (com::sun::star::lang::IllegalArgumentException);
};
/** describes a <type scope="com::sun::star::util">MeasureUnit</type> to be
applied for transfering values.
<p>The core measurement unit for a property value might differ from the unit which
is used by the control to display it. For instance, your property value might require
that your values denote 100th millimeters, but to the user, you want to present the
value as, say, inches. In this case, a numeric control can automatically handle the
value conversion for you, if you give it a ValueUnit different from the DisplayUnit.</p>
@see XPropertyControl::Value
*/
[attribute] short ValueUnit;
};
//=============================================================================
}; }; }; };
#endif
|
