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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_util_XNumberFormatter_idl__
#define __com_sun_star_util_XNumberFormatter_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#include <com/sun/star/util/NotNumericException.idl>
#include <com/sun/star/util/Color.idl>
//=============================================================================
module com { module sun { module star { module util {
//=============================================================================
/** represents a number formatter.
*/
published interface XNumberFormatter: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** attaches an <type>XNumberFormatsSupplier</type> to this
<type>NumberFormatter</type>.
<p>This <type>NumberFormatter</type> will only use the <type>NumberFormats</type>
specified in the attached <type>XNumberFormatsSupplier</type>. Without an attached
<type>XNumberFormatsSupplier</type>, no formatting is possible.</p>
*/
void attachNumberFormatsSupplier( [in] com::sun::star::util::XNumberFormatsSupplier xSupplier );
//-------------------------------------------------------------------------
/** @returns
the attached <type>XNumberFormatsSupplier</type>.
*/
com::sun::star::util::XNumberFormatsSupplier getNumberFormatsSupplier();
//-------------------------------------------------------------------------
/** detects the number format in a string which contains a formatted number.
*/
long detectNumberFormat( [in] long nKey,
[in] string aString )
raises( com::sun::star::util::NotNumericException );
//-------------------------------------------------------------------------
/** converts a string which contains a formatted number into a number.
<p>If this is a text format, the string will not be converted.</p>
*/
double convertStringToNumber( [in] long nKey,
[in] string aString )
raises( com::sun::star::util::NotNumericException );
//-------------------------------------------------------------------------
/** converts a number into a string.
*/
string convertNumberToString( [in] long nKey,
[in] double fValue );
//-------------------------------------------------------------------------
/** @returns
the color which is specified for the given value in the number format,
which is otherwise the value of <var>aDefaultColor</var>.
*/
com::sun::star::util::Color queryColorForNumber( [in] long nKey,
[in] double fValue,
[in] com::sun::star::util::Color aDefaultColor );
//-------------------------------------------------------------------------
/** converts a string into another string.
*/
string formatString( [in] long nKey,
[in] string aString );
//-------------------------------------------------------------------------
/** @returns
the color which is specified for the given string in the number format,
which is otherwise the value of <var>aDefaultColor</var>.
*/
com::sun::star::util::Color queryColorForString( [in] long nKey,
[in] string aString,
[in] com::sun::star::util::Color aDefaultColor );
//-------------------------------------------------------------------------
/** converts a number into a string with the specified format.
<p>This string can always be converted back to a number using the same
format.
</p>
*/
string getInputString( [in] long nKey,
[in] double fValue );
};
//=============================================================================
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
