xref: /aoo41x/main/offapi/com/sun/star/i18n/Currency.idl (revision cdf0e10c)
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
28#ifndef __com_sun_star_i18n_Currency_idl__
29#define __com_sun_star_i18n_Currency_idl__
30
31//============================================================================
32
33module com { module sun { module star { module i18n {
34
35//============================================================================
36
37/**
38    Symbols, names, and attributes of a specific currency, returned in a
39    sequence by <member>XLocaleData::getAllCurrencies()</member>.
40
41    @see XLocaleData
42        for links to DTD of XML locale data files.
43 */
44
45published struct Currency
46{
47    /** ISO 4217 currency code identifier, for example, <b>EUR</b> or
48        <b>USD</b>. */
49    string ID;
50
51    /** Currency symbol, for example, <b>$</b>. */
52    string Symbol;
53
54    /** Currency abbreviation used by banks and in money exchange, for
55        example, <b>EUR</b> or <b>USD</b>. This usually should be
56        identical to the ISO 4217 currency code also used in the
57        <member>ID</member>, but doesn't necessarily have to be. */
58    string BankSymbol;
59
60    /** Name of the currency, for example, <b>Euro</b> or <b>US
61        Dollar</b>. Should be the localized name. */
62    string Name;
63
64    /** If this currency is the default currency for a given locale. */
65    boolean Default;
66
67    /** If this currency is the one used in compatible number format codes with
68        <member>FormatElement::formatIndex</member> values in the range 12..17.
69        Those format codes are used to generate some old style currency format
70        codes for compatibility with StarOffice5 and StarOffice4.
71
72        @see com::sun::star::i18n::NumberFormatIndex
73     */
74    boolean UsedInCompatibleFormatCodes;
75
76    /** The number of decimal places, for example, <b>2</b> for US Dollar
77        or <b>0</b> for Italian Lira.  */
78    short DecimalPlaces;
79};
80
81//============================================================================
82}; }; }; };
83
84#endif
85