# DecimalFormatSymbols Class Reference

This class represents the set of symbols needed by DecimalFormat to format numbers. More...

`#include <dcfmtsym.h>`

Inheritance diagram for DecimalFormatSymbols:

## Public Types
enum | ENumberFormatSymbol { kDecimalSeparatorSymbol, kGroupingSeparatorSymbol, kPatternSeparatorSymbol, kPercentSymbol, kZeroDigitSymbol, kDigitSymbol, kMinusSignSymbol, kPlusSignSymbol, kCurrencySymbol, kIntlCurrencySymbol, kMonetarySeparatorSymbol, kExponentialSymbol, kPerMillSymbol, kPadEscapeSymbol, kInfinitySymbol, kNaNSymbol, kSignificantDigitSymbol, kMonetaryGroupingSeparatorSymbol, kFormatSymbolCount }
| Constants for specifying a number format symbol. More...
enum | ECurrencySpacing { kCurrencyMatch, kSurroundingMatch, kInsert, kCurrencySpacingCount }
| Constants for specifying currency spacing. More...
## Public Member Functions
| DecimalFormatSymbols (const Locale &locale, UErrorCode &status)
| Create a DecimalFormatSymbols object for the given locale.
| DecimalFormatSymbols (UErrorCode &status)
| Create a DecimalFormatSymbols object for the default locale.
| DecimalFormatSymbols (const DecimalFormatSymbols &)
| Copy constructor.
DecimalFormatSymbols & | operator= (const DecimalFormatSymbols &)
| Assignment operator.
virtual | ~DecimalFormatSymbols ()
| Destructor.
UBool | operator== (const DecimalFormatSymbols &other) const
| Return true if another object is semantically equal to this one.
UBool | operator!= (const DecimalFormatSymbols &other) const
| Return true if another object is semantically unequal to this one.
UnicodeString | getSymbol (ENumberFormatSymbol symbol) const
| Get one of the format symbols by its enum constant.
void | setSymbol (ENumberFormatSymbol symbol, const UnicodeString &value)
| Set one of the format symbols by its enum constant.
Locale | getLocale () const
| Returns the locale for which this object was constructed.
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const
| Returns the locale for this object.
const UnicodeString & | getPatternForCurrencySpacing (ECurrencySpacing type, UBool beforeCurrency, UErrorCode &status) const
| Get pattern string for 'CurrencySpacing' that can be applied to currency format.
void | setPatternForCurrencySpacing (ECurrencySpacing type, UBool beforeCurrency, const UnicodeString &pattern)
| Set pattern string for 'CurrencySpacing' that can be applied to currency format.
virtual UClassID | getDynamicClassID () const
| ICU "poor man's RTTI", returns a UClassID for the actual class.
const UnicodeString & | getConstSymbol (ENumberFormatSymbol symbol) const
| _Internal_ function - more efficient version of getSymbol, returning a const reference to one of the symbol strings.
const UChar * | getCurrencyPattern (void) const
| Returns that pattern stored in currecy info.
## Static Public Member Functions
static UClassID | getStaticClassID ()
| ICU "poor man's RTTI", returns a UClassID for this class.

## Detailed Description

This class represents the set of symbols needed by DecimalFormat to format numbers.

DecimalFormat creates for itself an instance of DecimalFormatSymbols from its locale data. If you need to change any of these symbols, you can get the DecimalFormatSymbols object from your DecimalFormat and modify it.

Here are the special characters used in the parts of the subpattern, with notes on their usage.

             Symbol   Meaning
              0      a digit
              #      a digit, zero shows as absent
              .      placeholder for decimal separator
              ,      placeholder for grouping separator.
              ;      separates formats.
              -      default negative prefix.
              %      divide by 100 and show as percentage
              X      any other characters can be used in the prefix or suffix
              '      used to quote special characters in a prefix or suffix.

[Notes]

If there is no explicit negative subpattern, - is prefixed to the positive form. That is, "0.00" alone is equivalent to "0.00;-0.00".

The grouping separator is commonly used for thousands, but in some countries for ten-thousands. The interval is a constant number of digits between the grouping characters, such as 100,000,000 or 1,0000,0000. If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. So "#,##,###,####" == "######,####" == "##,####,####".

This class only handles localized digits where the 10 digits are contiguous in Unicode, from 0 to 9. Other digits sets (such as superscripts) would need a different subclass.

Definition at line 82 of file dcfmtsym.h.

## Member Enumeration Documentation

enum DecimalFormatSymbols::ECurrencySpacing

Constants for specifying currency spacing.

Draft:
  This API may be changed in the future versions and was introduced in ICU 4.2

Definition at line 136 of file dcfmtsym.h.

enum DecimalFormatSymbols::ENumberFormatSymbol

Constants for specifying a number format symbol.

Stable:
  ICU 2.0

Enumerator:

  kDecimalSeparatorSymbol | The decimal separator.
  kGroupingSeparatorSymbol | The grouping separator.
  kPatternSeparatorSymbol | The pattern separator.
  kPercentSymbol | The percent sign.
  kZeroDigitSymbol | Zero.
  kDigitSymbol | Character representing a digit in the pattern.
  kMinusSignSymbol | The minus sign.
  kPlusSignSymbol | The plus sign.
  kCurrencySymbol | The currency symbol.
  kIntlCurrencySymbol | The international currency symbol.
  kMonetarySeparatorSymbol | The monetary separator.
  kExponentialSymbol | The exponential symbol.
  kPerMillSymbol | Per mill symbol - replaces kPermillSymbol.
  kPadEscapeSymbol | Escape padding character.
  kInfinitySymbol | Infinity symbol.
  kNaNSymbol | Nan symbol.
  kSignificantDigitSymbol | Significant digit symbol. Stable: ICU 3.0
  kMonetaryGroupingSeparatorSymbol | The monetary grouping separator. Stable: ICU 3.6
  kFormatSymbolCount | count symbol constants

Definition at line 88 of file dcfmtsym.h.

## Constructor & Destructor Documentation

DecimalFormatSymbols::DecimalFormatSymbols | ( | const Locale & | locale,
|  | UErrorCode & | status |
| ) |  |  |

Create a DecimalFormatSymbols object for the given locale.

Parameters:

  | locale | The locale to get symbols for.
  | status | Input/output parameter, set to success or failure code upon return.

Stable:
  ICU 2.0

DecimalFormatSymbols::DecimalFormatSymbols | ( | UErrorCode & | status | ) |

Create a DecimalFormatSymbols object for the default locale.

This constructor will not fail. If the resource file data is not available, it will use hard-coded last-resort data and set status to U_USING_FALLBACK_ERROR.

Parameters:

  | status | Input/output parameter, set to success or failure code upon return.

Stable:
  ICU 2.0

DecimalFormatSymbols::DecimalFormatSymbols | ( | const DecimalFormatSymbols & |  | ) |

Copy constructor.

Stable:
  ICU 2.0

virtual DecimalFormatSymbols::~DecimalFormatSymbols | ( |  | ) | `[virtual]`

Destructor.

Stable:
  ICU 2.0

## Member Function Documentation

const UnicodeString & DecimalFormatSymbols::getConstSymbol | ( | ENumberFormatSymbol | symbol | ) | const`[inline]`

_Internal_ function - more efficient version of getSymbol, returning a const reference to one of the symbol strings.

The returned reference becomes invalid when the symbol is changed or when the DecimalFormatSymbols are destroyed. ### TODO markus 2002oct11: Consider proposing getConstSymbol() to be really public.

Parameters:

  | symbol | Constant to indicate a number format symbol.

Returns:
  the format symbol by the param 'symbol'

Internal:
  Do not use. This API is for internal use only.

Definition at line 382 of file dcfmtsym.h.

References kFormatSymbolCount.

const UChar * DecimalFormatSymbols::getCurrencyPattern | ( | void |  | ) | const`[inline]`

Returns that pattern stored in currecy info.

Internal API for use by NumberFormat API.

Internal:
  Do not use. This API is for internal use only.

Definition at line 409 of file dcfmtsym.h.

virtual UClassID DecimalFormatSymbols::getDynamicClassID | ( |  | ) | const`[virtual]`

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
  ICU 2.2

Implements UObject.

Locale DecimalFormatSymbols::getLocale | ( | ULocDataLocaleType | type,
|  | UErrorCode & | status |
| ) |  |  | const

Returns the locale for this object.

Two flavors are available: valid and actual locale.

Stable:
  ICU 2.8

Locale DecimalFormatSymbols::getLocale | ( | void |  | ) | const`[inline]`

Returns the locale for which this object was constructed.

Stable:
  ICU 2.6

Definition at line 404 of file dcfmtsym.h.

const UnicodeString& DecimalFormatSymbols::getPatternForCurrencySpacing | ( | ECurrencySpacing | type,
|  | UBool | beforeCurrency,
|  | UErrorCode & | status |
| ) |  |  | const

Get pattern string for 'CurrencySpacing' that can be applied to currency format.

This API gets the CurrencySpacing data from ResourceBundle. The pattern can be empty if there is no data from current locale and its parent locales.

Parameters:

  | type | : kCurrencyMatch, kSurroundingMatch or kInsert.
  | beforeCurrency | : true if the pattern is for before currency symbol. false if the pattern is for after currency symbol.
  | status,: | Input/output parameter, set to success or failure code upon return.

Returns:
  pattern string for currencyMatch, surroundingMatch or spaceInsert. Return empty string if there is no data for this locale and its parent locales.

Draft:
  This API may be changed in the future versions and was introduced in ICU 4.2

static UClassID DecimalFormatSymbols::getStaticClassID | ( |  | ) | `[static]`

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:
  ICU 2.2

UnicodeString DecimalFormatSymbols::getSymbol | ( | ENumberFormatSymbol | symbol | ) | const`[inline]`

Get one of the format symbols by its enum constant.

Each symbol is stored as a string so that graphemes (characters with modifier letters) can be used.

Parameters:

  | symbol | Constant to indicate a number format symbol.

Returns:
  the format symbols by the param 'symbol'

Stable:
  ICU 2.0

Definition at line 371 of file dcfmtsym.h.

References kFormatSymbolCount.

UBool DecimalFormatSymbols::operator!= | ( | const DecimalFormatSymbols & | other | ) | const`[inline]`

Return true if another object is semantically unequal to this one.

Parameters:

  | other | the object to be compared with.

Returns:
  true if another object is semantically unequal to this one.

Stable:
  ICU 2.0

Definition at line 199 of file dcfmtsym.h.

References operator==().

DecimalFormatSymbols& DecimalFormatSymbols::operator= | ( | const DecimalFormatSymbols & |  | ) |

Assignment operator.

Stable:
  ICU 2.0

UBool DecimalFormatSymbols::operator== | ( | const DecimalFormatSymbols & | other | ) | const

Return true if another object is semantically equal to this one.

Parameters:

  | other | the object to be compared with.

Returns:
  true if another object is semantically equal to this one.

Stable:
  ICU 2.0

void DecimalFormatSymbols::setPatternForCurrencySpacing | ( | ECurrencySpacing | type,
|  | UBool | beforeCurrency,
|  | const UnicodeString & | pattern |
| ) |  |  |

Set pattern string for 'CurrencySpacing' that can be applied to currency format.

Parameters:

  | type | : kCurrencyMatch, kSurroundingMatch or kInsert.
  | beforeCurrency | : true if the pattern is for before currency symbol. false if the pattern is for after currency symbol.
  | pattern | : pattern string to override current setting.

Draft:
  This API may be changed in the future versions and was introduced in ICU 4.2

void DecimalFormatSymbols::setSymbol | ( | ENumberFormatSymbol | symbol,
|  | const UnicodeString & | value |
| ) |  |  | `[inline]`

Set one of the format symbols by its enum constant.

Each symbol is stored as a string so that graphemes (characters with modifier letters) can be used.

Parameters:

  | symbol | Constant to indicate a number format symbol.
  | value | value of the format symbol

Stable:
  ICU 2.0

Definition at line 395 of file dcfmtsym.h.

References kFormatSymbolCount.

The documentation for this class was generated from the following file:

- dcfmtsym.h

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines