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