Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1DecimalFormatSymbols.html below:
ICU 77.1: icu::DecimalFormatSymbols Class Reference
This class represents the set of symbols needed by DecimalFormat to format numbers. More...
#include <dcfmtsym.h>
enum ENumberFormatSymbol {
kDecimalSeparatorSymbol , kGroupingSeparatorSymbol , kPatternSeparatorSymbol , kPercentSymbol ,
kZeroDigitSymbol , kDigitSymbol , kMinusSignSymbol , kPlusSignSymbol ,
kCurrencySymbol , kIntlCurrencySymbol , kMonetarySeparatorSymbol , kExponentialSymbol ,
kPerMillSymbol , kPadEscapeSymbol , kInfinitySymbol , kNaNSymbol ,
kSignificantDigitSymbol , kMonetaryGroupingSeparatorSymbol , kOneDigitSymbol , kTwoDigitSymbol ,
kThreeDigitSymbol , kFourDigitSymbol , kFiveDigitSymbol , kSixDigitSymbol ,
kSevenDigitSymbol , kEightDigitSymbol , kNineDigitSymbol , kExponentMultiplicationSymbol ,
kApproximatelySignSymbol , kFormatSymbolCount = kExponentMultiplicationSymbol + 2
} Constants for specifying a number format symbol. More...
DecimalFormatSymbols (const Locale &locale, UErrorCode &status) Create a DecimalFormatSymbols object for the given locale. More...
DecimalFormatSymbols (const Locale &locale, const NumberingSystem &ns, UErrorCode &status) Creates a DecimalFormatSymbols instance for the given locale with digits and symbols corresponding to the given NumberingSystem. 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...
bool operator== (const DecimalFormatSymbols &other) const Return true if another object is semantically equal to this one. More...
bool 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 propagateDigits) Set one of the format symbols by its enum constant. More...
void setCurrency (const char16_t *currency, UErrorCode &status) Loads symbols for the specified currency into this instance. 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 override ICU "poor man's RTTI", returns a UClassID for the actual class. More...
UBool isCustomCurrencySymbol () const UBool isCustomIntlCurrencySymbol () const UChar32 getCodePointZero () const 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 UnicodeString & getConstDigitSymbol (int32_t digit) const Returns the const UnicodeString reference, like getConstSymbol, corresponding to the digit with the given value. More...
const char16_t * getCurrencyPattern () const Returns that pattern stored in currency info. More...
const char * getNumberingSystemName () const Returns the numbering system with which this DecimalFormatSymbols was initialized. More...
virtual ~UObject () Destructor. 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 "#,##,###,####" == "######,####" == "##,####,####".
Definition at line 87 of file dcfmtsym.h.
◆ 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
kOneDigitSymbol
One.
-
Stable:
-
ICU 4.6
kTwoDigitSymbol
Two.
-
Stable:
-
ICU 4.6
kThreeDigitSymbol
Three.
-
Stable:
-
ICU 4.6
kFourDigitSymbol
Four.
-
Stable:
-
ICU 4.6
kFiveDigitSymbol
Five.
-
Stable:
-
ICU 4.6
kSixDigitSymbol
Six.
-
Stable:
-
ICU 4.6
kSevenDigitSymbol
Seven.
-
Stable:
-
ICU 4.6
kEightDigitSymbol
Eight.
-
Stable:
-
ICU 4.6
kNineDigitSymbol
Nine.
-
Stable:
-
ICU 4.6
kExponentMultiplicationSymbol
Multiplication sign.
-
Stable:
-
ICU 54
kApproximatelySignSymbol
Approximately sign.
-
Internal:
-
Do not use. This API is for internal use only.
kFormatSymbolCount
count symbol constants
Definition at line 93 of file dcfmtsym.h.
◆ DecimalFormatSymbols() [1/4] icu::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() [2/4]
Creates a DecimalFormatSymbols instance for the given locale with digits and symbols corresponding to the given NumberingSystem.
This constructor behaves equivalently to the normal constructor called with a locale having a "numbers=xxxx" keyword specifying the numbering system by name.
In this constructor, the NumberingSystem argument will be used even if the locale has its own "numbers=xxxx" keyword.
-
Parameters
-
locale The locale to get symbols for. ns The numbering system. status Input/output parameter, set to success or failure code upon return.
-
Stable:
-
ICU 60
◆ DecimalFormatSymbols() [3/4] 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.
-
Parameters
-
status Input/output parameter, set to success or failure code upon return.
-
Stable:
-
ICU 2.0
◆ DecimalFormatSymbols() [4/4] ◆ ~DecimalFormatSymbols() virtual icu::DecimalFormatSymbols::~DecimalFormatSymbols ( ) virtual ◆ createWithLastResortData()
Creates a DecimalFormatSymbols object with last-resort data.
Intended for callers who cache the symbols data and set all symbols on the resulting object.
The last-resort symbols are similar to those for the root data, except that the grouping separators are empty, the NaN symbol is U+FFFD rather than "NaN", and the CurrencySpacing patterns are empty.
-
Parameters
-
status Input/output parameter, set to success or failure code upon return.
-
Returns
-
last-resort symbols
-
Stable:
-
ICU 52
◆ getCodePointZero() UChar32 icu::DecimalFormatSymbols::getCodePointZero ( ) const inline
-
Internal:
-
Do not use.
This API is for internal use only. For ICU use only
Definition at line 415 of file dcfmtsym.h.
◆ getConstDigitSymbol() const UnicodeString & icu::DecimalFormatSymbols::getConstDigitSymbol ( int32_t digit ) const inline
Returns the const UnicodeString reference, like getConstSymbol, corresponding to the digit with the given value.
This is equivalent to accessing the symbol from getConstSymbol with the corresponding key, such as kZeroDigitSymbol or kOneDigitSymbol.
This is not currently stable API, but if you think it should be stable, post a comment on the following ticket and the ICU team will take a look: https://unicode-org.atlassian.net/browse/ICU-13580
-
Parameters
-
digit The digit, an integer between 0 and 9 inclusive. If outside the range 0 to 9, the zero digit is returned.
-
Returns
-
the format symbol for the given digit.
-
Internal:
-
Do not use. This API is for internal use only. This API is currently for ICU use only.
Definition at line 545 of file dcfmtsym.h.
◆ getConstSymbol()
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. Note: moved #ifndef U_HIDE_INTERNAL_API after this, since this is needed for inline in DecimalFormat
This is not currently stable API, but if you think it should be stable, post a comment on the following ticket and the ICU team will take a look: https://unicode-org.atlassian.net/browse/ICU-13580
-
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 534 of file dcfmtsym.h.
◆ getCurrencyPattern() const char16_t * icu::DecimalFormatSymbols::getCurrencyPattern ( ) const inline
Returns that pattern stored in currency info.
Internal API for use by NumberFormat API.
-
Internal:
-
Do not use. This API is for internal use only.
Definition at line 599 of file dcfmtsym.h.
◆ getDynamicClassID() virtual UClassID icu::DecimalFormatSymbols::getDynamicClassID ( ) const overridevirtual
ICU "poor man's RTTI", returns a UClassID for the actual class.
-
Stable:
-
ICU 2.2
Reimplemented from icu::UObject.
◆ getLocale() [1/2] Locale icu::DecimalFormatSymbols::getLocale ( ) const inline
Returns the locale for which this object was constructed.
-
Stable:
-
ICU 2.6
Definition at line 593 of file dcfmtsym.h.
◆ getLocale() [2/2]
Returns the locale for this object.
Two flavors are available: valid and actual locale.
-
Stable:
-
ICU 2.8
◆ getNumberingSystemName() const char * icu::DecimalFormatSymbols::getNumberingSystemName ( ) const inline ◆ getPatternForCurrencySpacing()
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 : 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.
-
Returns
-
pattern string for currencyMatch, surroundingMatch or spaceInsert. Return empty string if there is no data for this locale and its parent locales.
-
Stable:
-
ICU 4.8
◆ getStaticClassID() static UClassID icu::DecimalFormatSymbols::getStaticClassID ( ) static
ICU "poor man's RTTI", returns a UClassID for this class.
-
Stable:
-
ICU 2.2
◆ getSymbol()
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 522 of file dcfmtsym.h.
◆ isCustomCurrencySymbol() UBool icu::DecimalFormatSymbols::isCustomCurrencySymbol ( ) const inline
-
Internal:
-
Do not use.
This API is for internal use only. For ICU use only
Definition at line 401 of file dcfmtsym.h.
◆ isCustomIntlCurrencySymbol() UBool icu::DecimalFormatSymbols::isCustomIntlCurrencySymbol ( ) const inline
-
Internal:
-
Do not use.
This API is for internal use only. For ICU use only
Definition at line 408 of file dcfmtsym.h.
◆ operator!=()
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 274 of file dcfmtsym.h.
References icu::operator==().
◆ operator=()
Assignment operator.
-
Stable:
-
ICU 2.0
◆ operator==()
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
◆ setCurrency() void icu::DecimalFormatSymbols::setCurrency ( const char16_t * currency, UErrorCode & status )
Loads symbols for the specified currency into this instance.
This method is internal. If you think it should be public, file a ticket.
-
Internal:
-
Do not use. This API is for internal use only.
◆ setPatternForCurrencySpacing()
Set pattern string for 'CurrencySpacing' that can be applied to currency format.
-
Parameters
-
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.
-
Stable:
-
ICU 4.8
◆ setSymbol()
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 propagateDigits 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.
-
Stable:
-
ICU 2.0
Definition at line 560 of file dcfmtsym.h.
References icu::UnicodeString::char32At(), icu::UnicodeString::countChar32(), and u_charDigitValue().
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4