scuffed-code/icu4c/source/i18n/unicode/currency.h
2002-05-14 23:24:58 +00:00

78 lines
2.3 KiB
C++

/*
**********************************************************************
* Copyright (c) 2002, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* $Source: /xsrl/Nsvn/icu/icu/source/i18n/unicode/Attic/currency.h,v $
* $Revision: 1.3 $
**********************************************************************
*/
#ifndef UCURRENCY_H
#define UCURRENCY_H
#include "unicode/unistr.h"
U_NAMESPACE_BEGIN
class Locale;
/**
* A class encapsulating information about a currency, as defined by
* ISO 4217. A currency is represented by a 3-character string
* containing its ISO 4217 code. This class can return various data
* necessary the proper display of a currency:
*
* <ul><li>A display symbol, for a specific locale
* <li>The number of fraction digits to display
* <li>A rounding increment
* </ul>
*
* The <tt>DecimalFormat</tt> class uses these data to display
* currencies.
* @author Alan Liu
* @since ICU 2.2
*/
class U_I18N_API UCurrency {
public:
/**
* Returns a currency code for the default currency in the given
* locale.
* @param locale the locale for which to retrieve a currency code
* @param result pointer to a buffer of at least 4 chars
* to receive a null-terminated 3-letter ISO 4217 code
* @param ec error code
*/
static void forLocale(const Locale& locale,
char* result,
UErrorCode& ec);
/**
* Returns the display string for the given currency in the
* given locale. For example, the display string for the USD
* currency object in the en_US locale is "$".
*/
static UnicodeString getSymbol(const char* currency,
const Locale& locale);
/**
* Returns the number of the number of fraction digits that should
* be displayed for the given currency.
* @return a non-negative number of fraction digits to be
* displayed
*/
static int32_t getDefaultFractionDigits(const char* currency);
/**
* Returns the rounding increment for the given currency, or 0.0 if no
* rounding is done by the currency.
* @return the non-negative rounding increment, or 0.0 if none
*/
static double getRoundingIncrement(const char* currency);
};
U_NAMESPACE_END
#endif