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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/* -*- 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_XNumberFormats_idl__
#define __com_sun_star_util_XNumberFormats_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/util/MalformedNumberFormatException.idl>
module com { module sun { module star { module util {
/** provides access to multiple NumberFormats.
The number formats are managed by their unique key in the document.
*/
published interface XNumberFormats: com::sun::star::uno::XInterface
{
/** @returns
a readonly NumberFormatProperties.
@param nKey
the key for the format
*/
com::sun::star::beans::XPropertySet getByKey( [in] long nKey );
/** @returns
a sequence of the keys of all number formats with the specified type and language.
@param nType
the type of number formats to return. Must be one of the
NumberFormat constants.
@param nLocale
the locale of number formats to return.
@param bCreate
`TRUE`: create new entries if no formats for the selected language exist<BR>
`FALSE`: return an empty list if no formats for the selected language exist
*/
sequence<long> queryKeys( [in] short nType,
[in] com::sun::star::lang::Locale nLocale,
[in] boolean bCreate );
/** finds a number format by its format string and returns its key.
@returns
the key for the format if found, otherwise -1.
@param aFormat
the string representation of the number format
@param nLocale
the locale for number formats to find
@param bScan
reserved for future use and should be set to false
*/
long queryKey( [in] string aFormat,
[in] com::sun::star::lang::Locale nLocale,
[in] boolean bScan );
/** adds a new number format to the list, using a format string.
@returns
the key for new number format
@param aFormat
the string representation of the number format
@param nLocale
the locale for the number format
@throws com::sun::star::util::MalformedNumberFormatException
if incorrect number format is specified
*/
long addNew( [in] string aFormat,
[in] com::sun::star::lang::Locale nLocale )
raises( com::sun::star::util::MalformedNumberFormatException );
/** adds a new number format to the list, using a format
string in a different locale than the desired locale of the
resulting number format.
@returns
the key for added number format
@param aFormat
the key for the number format
@param nLocale
the original locale for the number format
@param nNewLocale
the new locale for the number format to be converted
@throws com::sun::star::util::MalformedNumberFormatException
if incorrect number format is specified
*/
long addNewConverted( [in] string aFormat,
[in] com::sun::star::lang::Locale nLocale,
[in] com::sun::star::lang::Locale nNewLocale )
raises( com::sun::star::util::MalformedNumberFormatException );
/** removes a number format from the list.
@param nKey
the key for the numberformat
*/
void removeByKey( [in] long nKey );
/** generates a format string from several parameters without
creating an actual number format.
@returns
the string representation for the number format
@param nBaseKey
the key for the number format to be used as base format
@param nLocale
the locale for the number format
@param bThousands
the thousands separator is shown or not
@param bRed
show negative number in red colored if `TRUE`
@param nDecimals
how many digits are shown after the decimal point
@param nLeading
how many number of leading zeros are shown
*/
string generateFormat( [in] long nBaseKey,
[in] com::sun::star::lang::Locale nLocale,
[in] boolean bThousands,
[in] boolean bRed,
[in] short nDecimals,
[in] short nLeading );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
