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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XNumberFormatPreviewer.idl,v $
* $Revision: 1.10 $
*
* 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_util_XNumberFormatPreviewer_idl__
#define __com_sun_star_util_XNumberFormatPreviewer_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_util_MalformedNumberFormatException_idl__
#include <com/sun/star/util/MalformedNumberFormatException.idl>
#endif
#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** represents a number formatter which can preview number
formats without inserting them.
@see NumberFormatter
*/
published interface XNumberFormatPreviewer: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** formats a value using a format string, without inserting a
number format into the list.
@param aFormat
is the format string that is used for formatting.
@param fValue
is the value that is formatted.
@param nLocale
is the locale that is used to interpret the format string.
@param bAllowEnglish
specifies if English language number format strings are accepted
in addition to those from the selected locale.
@returns
the formatted string.
@throws com::sun::star::util::MalformedNumberFormatException
if the format string is invalid.
*/
string convertNumberToPreviewString( [in] string aFormat,
[in] double fValue,
[in] com::sun::star::lang::Locale nLocale,
[in] boolean bAllowEnglish )
raises( com::sun::star::util::MalformedNumberFormatException );
//-------------------------------------------------------------------------
/** returns the color which is to be used for a number.
@param aFormat
is the format string that is used for formatting.
@param fValue
is the value that is formatted.
@param nLocale
is the locale that is used to interpret the format string.
@param bAllowEnglish
specifies if English language number format strings are accepted
in addition to those from the selected locale.
@param aDefaultColor
is the color that should be returned if no color is set by
the number format.
@returns
the color that should used to output the formatted string.
@throws com::sun::star::util::MalformedNumberFormatException
if the format string is invalid.
*/
com::sun::star::util::Color queryPreviewColorForNumber( [in] string aFormat,
[in] double fValue,
[in] com::sun::star::lang::Locale nLocale,
[in] boolean bAllowEnglish,
[in] com::sun::star::util::Color aDefaultColor )
raises( com::sun::star::util::MalformedNumberFormatException );
};
//=============================================================================
}; }; }; };
#endif
|
