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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Currency.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_i18n_Currency_idl__
  32 #define __com_sun_star_i18n_Currency_idl__
  33
  34 //============================================================================
  35
  36 module com { module sun { module star { module i18n {
  37
  38 //============================================================================
  39
  40 /**
  41     Symbols, names, and attributes of a specific currency, returned in a
  42     sequence by <member>XLocaleData::getAllCurrencies()</member>.
  43
  44     @see XLocaleData
  45         for links to DTD of XML locale data files.
  46  */
  47
  48 published struct Currency
  49 {
  50     /** ISO 4217 currency code identifier, for example, <b>EUR</b> or
  51         <b>USD</b>. */
  52     string ID;
  53
  54     /** Currency symbol, for example, <b>$</b>. */
  55     string Symbol;
  56
  57     /** Currency abbreviation used by banks and in money exchange, for
  58         example, <b>EUR</b> or <b>USD</b>. This usually should be
  59         identical to the ISO 4217 currency code also used in the
  60         <member>ID</member>, but doesn't necessarily have to be. */
  61     string BankSymbol;
  62
  63     /** Name of the currency, for example, <b>Euro</b> or <b>US
  64         Dollar</b>. Should be the localized name. */
  65     string Name;
  66
  67     /** If this currency is the default currency for a given locale. */
  68     boolean Default;
  69
  70     /** If this currency is the one used in compatible number format codes with
  71         <member>FormatElement::formatIndex</member> values in the range 12..17.
  72         Those format codes are used to generate some old style currency format
  73         codes for compatibility with StarOffice5 and StarOffice4.
  74
  75         @see com::sun::star::i18n::NumberFormatIndex
  76      */
  77     boolean UsedInCompatibleFormatCodes;
  78
  79     /** The number of decimal places, for example, <b>2</b> for US Dollar
  80         or <b>0</b> for Italian Lira.  */
  81     short DecimalPlaces;
  82 };
  83
  84 //============================================================================
  85 }; }; }; };
  86
  87 #endif