offapi/com/sun/star/i18n/Currency.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_i18n_Currency_idl__
  21 #define __com_sun_star_i18n_Currency_idl__
  22
  23
  24 module com { module sun { module star { module i18n {
  25
  26
  27 /**
  28     Symbols, names, and attributes of a specific currency, returned in a
  29     sequence by XLocaleData::getAllCurrencies().
  30
  31     @see XLocaleData
  32         for links to DTD of XML locale data files.
  33  */
  34
  35 published struct Currency
  36 {
  37     /** ISO 4217 currency code identifier, for example, <b>EUR</b> or
  38         <b>USD</b>. */
  39     string ID;
  40
  41     /** Currency symbol, for example, <b>$</b>. */
  42     string Symbol;
  43
  44     /** Currency abbreviation used by banks and in money exchange, for
  45         example, <b>EUR</b> or <b>USD</b>. This usually should be
  46         identical to the ISO 4217 currency code also used in the
  47         #ID, but doesn't necessarily have to be. */
  48     string BankSymbol;
  49
  50     /** Name of the currency, for example, <b>Euro</b> or <b>US
  51         Dollar</b>. Should be the localized name. */
  52     string Name;
  53
  54     /** If this currency is the default currency for a given locale. */
  55     boolean Default;
  56
  57     /** If this currency is the one used in compatible number format codes with
  58         FormatElement::formatIndex() values in the range 12..17.
  59         Those format codes are used to generate some old style currency format
  60         codes for compatibility with StarOffice5 and StarOffice4.
  61
  62         @see com::sun::star::i18n::NumberFormatIndex
  63      */
  64     boolean UsedInCompatibleFormatCodes;
  65
  66     /** The number of decimal places, for example, <b>2</b> for US Dollar
  67         or <b>0</b> for Italian Lira.  */
  68     short DecimalPlaces;
  69 };
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */