1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_util_XNumberFormatPreviewer_idl__
28#define __com_sun_star_util_XNumberFormatPreviewer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_util_Color_idl__
35#include <com/sun/star/util/Color.idl>
36#endif
37
38#ifndef __com_sun_star_lang_Locale_idl__
39#include <com/sun/star/lang/Locale.idl>
40#endif
41
42#ifndef __com_sun_star_util_MalformedNumberFormatException_idl__
43#include <com/sun/star/util/MalformedNumberFormatException.idl>
44#endif
45
46#ifndef __com_sun_star_util_Color_idl__
47#include <com/sun/star/util/Color.idl>
48#endif
49
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module util {
54
55//=============================================================================
56
57/** represents a number formatter which can preview number
58	formats without inserting them.
59
60	@see NumberFormatter
61 */
62published interface XNumberFormatPreviewer: com::sun::star::uno::XInterface
63{
64	//-------------------------------------------------------------------------
65
66	/** formats a value using a format string, without inserting a
67		number format into the list.
68
69		@param aFormat
70			is the format string that is used for formatting.
71
72		@param fValue
73			is the value that is formatted.
74
75		@param nLocale
76			is the locale that is used to interpret the format string.
77
78		@param bAllowEnglish
79			specifies if English language number format strings are accepted
80			in addition to those from the selected locale.
81
82		@returns
83			the formatted string.
84
85        @throws com::sun::star::util::MalformedNumberFormatException
86        	if the format string is invalid.
87
88	 */
89	string convertNumberToPreviewString( [in] string aFormat,
90			 [in] double fValue,
91			 [in] com::sun::star::lang::Locale nLocale,
92			 [in] boolean bAllowEnglish )
93			raises( com::sun::star::util::MalformedNumberFormatException );
94
95	//-------------------------------------------------------------------------
96
97	/** returns the color which is to be used for a number.
98
99		@param aFormat
100			is the format string that is used for formatting.
101
102		@param fValue
103			is the value that is formatted.
104
105		@param nLocale
106			is the locale that is used to interpret the format string.
107
108		@param bAllowEnglish
109			specifies if English language number format strings are accepted
110			in addition to those from the selected locale.
111
112		@param aDefaultColor
113			is the color that should be returned if no color is set by
114			the number format.
115
116		@returns
117			the color that should used to output the formatted string.
118
119        @throws com::sun::star::util::MalformedNumberFormatException
120        	if the format string is invalid.
121
122	 */
123	com::sun::star::util::Color queryPreviewColorForNumber( [in] string aFormat,
124			 [in] double fValue,
125			 [in] com::sun::star::lang::Locale nLocale,
126			 [in] boolean bAllowEnglish,
127			 [in] com::sun::star::util::Color aDefaultColor )
128			raises( com::sun::star::util::MalformedNumberFormatException );
129
130};
131
132//=============================================================================
133
134}; }; }; };
135
136#endif
137
138