xref: /aoo4110/main/offapi/com/sun/star/i18n/Currency.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_i18n_Currency_idl__
25#define __com_sun_star_i18n_Currency_idl__
26
27//============================================================================
28
29module com { module sun { module star { module i18n {
30
31//============================================================================
32
33/**
34    Symbols, names, and attributes of a specific currency, returned in a
35    sequence by <member>XLocaleData::getAllCurrencies()</member>.
36
37    @see XLocaleData
38        for links to DTD of XML locale data files.
39 */
40
41published struct Currency
42{
43    /** ISO 4217 currency code identifier, for example, <b>EUR</b> or
44        <b>USD</b>. */
45    string ID;
46
47    /** Currency symbol, for example, <b>$</b>. */
48    string Symbol;
49
50    /** Currency abbreviation used by banks and in money exchange, for
51        example, <b>EUR</b> or <b>USD</b>. This usually should be
52        identical to the ISO 4217 currency code also used in the
53        <member>ID</member>, but doesn't necessarily have to be. */
54    string BankSymbol;
55
56    /** Name of the currency, for example, <b>Euro</b> or <b>US
57        Dollar</b>. Should be the localized name. */
58    string Name;
59
60    /** If this currency is the default currency for a given locale. */
61    boolean Default;
62
63    /** If this currency is the one used in compatible number format codes with
64        <member>FormatElement::formatIndex</member> values in the range 12..17.
65        Those format codes are used to generate some old style currency format
66        codes for compatibility with StarOffice5 and StarOffice4.
67
68        @see com::sun::star::i18n::NumberFormatIndex
69     */
70    boolean UsedInCompatibleFormatCodes;
71
72    /** The number of decimal places, for example, <b>2</b> for US Dollar
73        or <b>0</b> for Italian Lira.  */
74    short DecimalPlaces;
75};
76
77//============================================================================
78}; }; }; };
79
80#endif
81