ICU 50.1.2
50.1.2
|
This class represents the set of symbols needed by DecimalFormat to format numbers. More...
#include <dcfmtsym.h>
Public Member Functions | |
DecimalFormatSymbols (const Locale &locale, UErrorCode &status) | |
Create a DecimalFormatSymbols object for the given locale. More... | |
DecimalFormatSymbols (UErrorCode &status) | |
Create a DecimalFormatSymbols object for the default locale. More... | |
DecimalFormatSymbols (const DecimalFormatSymbols &) | |
Copy constructor. More... | |
DecimalFormatSymbols & | operator= (const DecimalFormatSymbols &) |
Assignment operator. More... | |
virtual | ~DecimalFormatSymbols () |
Destructor. More... | |
UBool | operator== (const DecimalFormatSymbols &other) const |
Return true if another object is semantically equal to this one. More... | |
UBool | operator!= (const DecimalFormatSymbols &other) const |
Return true if another object is semantically unequal to this one. More... | |
UnicodeString | getSymbol (ENumberFormatSymbol symbol) const |
Get one of the format symbols by its enum constant. More... | |
void | setSymbol (ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits) |
Set one of the format symbols by its enum constant. More... | |
Locale | getLocale () const |
Returns the locale for which this object was constructed. More... | |
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const |
Returns the locale for this object. More... | |
const UnicodeString & | getPatternForCurrencySpacing (UCurrencySpacing type, UBool beforeCurrency, UErrorCode &status) const |
Get pattern string for 'CurrencySpacing' that can be applied to currency format. More... | |
void | setPatternForCurrencySpacing (UCurrencySpacing type, UBool beforeCurrency, const UnicodeString &pattern) |
Set pattern string for 'CurrencySpacing' that can be applied to currency format. More... | |
virtual UClassID | getDynamicClassID () const |
ICU "poor man's RTTI", returns a UClassID for the actual class. More... | |
const UnicodeString & | getConstSymbol (ENumberFormatSymbol symbol) const |
Internal function - more efficient version of getSymbol, returning a const reference to one of the symbol strings. More... | |
const UChar * | getCurrencyPattern (void) const |
Returns that pattern stored in currecy info. More... | |
![]() | |
virtual | ~UObject () |
Destructor. More... | |
Static Public Member Functions | |
static UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. More... | |
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 84 of file dcfmtsym.h.
Constants for specifying a number format symbol.
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.
|
kMonetaryGroupingSeparatorSymbol |
The monetary grouping separator.
|
kOneDigitSymbol |
One.
|
kTwoDigitSymbol |
Two.
|
kThreeDigitSymbol |
Three.
|
kFourDigitSymbol |
Four.
|
kFiveDigitSymbol |
Five.
|
kSixDigitSymbol |
Six.
|
kSevenDigitSymbol |
Seven.
|
kEightDigitSymbol |
Eight.
|
kNineDigitSymbol |
Nine.
|
kFormatSymbolCount |
count symbol constants |
Definition at line 90 of file dcfmtsym.h.
icu::DecimalFormatSymbols::DecimalFormatSymbols | ( | const Locale & | locale, |
UErrorCode & | status | ||
) |
Create a DecimalFormatSymbols object for the given locale.
locale | The locale to get symbols for. |
status | Input/output parameter, set to success or failure code upon return. |
icu::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.
status | Input/output parameter, set to success or failure code upon return. |
icu::DecimalFormatSymbols::DecimalFormatSymbols | ( | const DecimalFormatSymbols & | ) |
Copy constructor.
|
virtual |
Destructor.
|
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.
symbol | Constant to indicate a number format symbol. |
Definition at line 406 of file dcfmtsym.h.
|
inline |
Returns that pattern stored in currecy info.
Internal API for use by NumberFormat API.
Definition at line 448 of file dcfmtsym.h.
|
virtual |
ICU "poor man's RTTI", returns a UClassID for the actual class.
Implements icu::UObject.
|
inline |
Returns the locale for which this object was constructed.
Definition at line 442 of file dcfmtsym.h.
Locale icu::DecimalFormatSymbols::getLocale | ( | ULocDataLocaleType | type, |
UErrorCode & | status | ||
) | const |
Returns the locale for this object.
Two flavors are available: valid and actual locale.
const UnicodeString& icu::DecimalFormatSymbols::getPatternForCurrencySpacing | ( | UCurrencySpacing | 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.
type | : UNUM_CURRENCY_MATCH, UNUM_CURRENCY_SURROUNDING_MATCH or UNUM_CURRENCY_INSERT. |
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. |
|
static |
ICU "poor man's RTTI", returns a UClassID for this class.
|
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.
symbol | Constant to indicate a number format symbol. |
Definition at line 394 of file dcfmtsym.h.
|
inline |
Return true if another object is semantically unequal to this one.
other | the object to be compared with. |
Definition at line 226 of file dcfmtsym.h.
References icu::operator==().
DecimalFormatSymbols& icu::DecimalFormatSymbols::operator= | ( | const DecimalFormatSymbols & | ) |
Assignment operator.
UBool icu::DecimalFormatSymbols::operator== | ( | const DecimalFormatSymbols & | other | ) | const |
Return true if another object is semantically equal to this one.
other | the object to be compared with. |
void icu::DecimalFormatSymbols::setPatternForCurrencySpacing | ( | UCurrencySpacing | type, |
UBool | beforeCurrency, | ||
const UnicodeString & | pattern | ||
) |
Set pattern string for 'CurrencySpacing' that can be applied to currency format.
type | : UNUM_CURRENCY_MATCH, UNUM_CURRENCY_SURROUNDING_MATCH or UNUM_CURRENCY_INSERT. |
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. |
|
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.
symbol | Constant to indicate a number format symbol. |
value | value of the format symbol |
propogateDigits | If false, setting the zero digit will not automatically set 1-9. The default behavior is to automatically set 1-9 if zero is being set and the value it is being set to corresponds to a known Unicode zero digit. |
Definition at line 421 of file dcfmtsym.h.
References icu::UnicodeString::char32At(), icu::UnicodeString::countChar32(), and u_charDigitValue().