ICU 64.2
64.2
|
#include "unicode/numfmt.h"
Public Types | |
enum | ERoundingMode { kRoundCeiling, kRoundFloor, kRoundDown, kRoundUp, kRoundHalfEven, kRoundHalfDown, kRoundHalfUp, kRoundUnnecessary } |
Rounding mode. More... | |
enum | EAlignmentFields { kIntegerField = UNUM_INTEGER_FIELD, kFractionField = UNUM_FRACTION_FIELD, kDecimalSeparatorField = UNUM_DECIMAL_SEPARATOR_FIELD, kExponentSymbolField = UNUM_EXPONENT_SYMBOL_FIELD, kExponentSignField = UNUM_EXPONENT_SIGN_FIELD, kExponentField = UNUM_EXPONENT_FIELD, kGroupingSeparatorField = UNUM_GROUPING_SEPARATOR_FIELD, kCurrencyField = UNUM_CURRENCY_FIELD, kPercentField = UNUM_PERCENT_FIELD, kPermillField = UNUM_PERMILL_FIELD, kSignField = UNUM_SIGN_FIELD, kMeasureUnitField = UNUM_MEASURE_UNIT_FIELD, kCompactField = UNUM_COMPACT_FIELD, INTEGER_FIELD = UNUM_INTEGER_FIELD, FRACTION_FIELD = UNUM_FRACTION_FIELD } |
Alignment Field constants used to construct a FieldPosition object. More... | |
Public Member Functions | |
virtual | ~NumberFormat () |
Destructor. More... | |
virtual UBool | operator== (const Format &other) const |
Return true if the given Format objects are semantically equal. More... | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format an object to produce a string. More... | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format an object to produce a string. More... | |
virtual void | parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const |
Parse a string to produce an object. More... | |
UnicodeString & | format (double number, UnicodeString &appendTo) const |
Format a double number. More... | |
UnicodeString & | format (int32_t number, UnicodeString &appendTo) const |
Format a long number. More... | |
UnicodeString & | format (int64_t number, UnicodeString &appendTo) const |
Format an int64 number. More... | |
virtual UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos) const =0 |
Format a double number. More... | |
virtual UnicodeString & | format (double number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format a double number. More... | |
virtual UnicodeString & | format (double number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format a double number. More... | |
virtual UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos) const =0 |
Format a long number. More... | |
virtual UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format a long number. More... | |
virtual UnicodeString & | format (int32_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format an int32 number. More... | |
virtual UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos) const |
Format an int64 number. More... | |
virtual UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format an int64 number. More... | |
virtual UnicodeString & | format (int64_t number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format an int64 number. More... | |
virtual UnicodeString & | format (StringPiece number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format a decimal number. More... | |
virtual UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format a decimal number. More... | |
virtual UnicodeString & | format (const number::impl::DecimalQuantity &number, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Format a decimal number. More... | |
virtual void | parse (const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const =0 |
Return a long if possible (e.g. More... | |
virtual void | parse (const UnicodeString &text, Formattable &result, UErrorCode &status) const |
Parse a string as a numeric value, and return a Formattable numeric object. More... | |
virtual CurrencyAmount * | parseCurrency (const UnicodeString &text, ParsePosition &pos) const |
Parses text from the given string as a currency amount. More... | |
UBool | isParseIntegerOnly (void) const |
Return true if this format will parse numbers as integers only. More... | |
virtual void | setParseIntegerOnly (UBool value) |
Sets whether or not numbers should be parsed as integers only. More... | |
virtual void | setLenient (UBool enable) |
Sets whether lenient parsing should be enabled (it is off by default). More... | |
virtual UBool | isLenient (void) const |
Returns whether lenient parsing is enabled (it is off by default). More... | |
UBool | isGroupingUsed (void) const |
Returns true if grouping is used in this format. More... | |
virtual void | setGroupingUsed (UBool newValue) |
Set whether or not grouping will be used in this format. More... | |
int32_t | getMaximumIntegerDigits (void) const |
Returns the maximum number of digits allowed in the integer portion of a number. More... | |
virtual void | setMaximumIntegerDigits (int32_t newValue) |
Sets the maximum number of digits allowed in the integer portion of a number. More... | |
int32_t | getMinimumIntegerDigits (void) const |
Returns the minimum number of digits allowed in the integer portion of a number. More... | |
virtual void | setMinimumIntegerDigits (int32_t newValue) |
Sets the minimum number of digits allowed in the integer portion of a number. More... | |
int32_t | getMaximumFractionDigits (void) const |
Returns the maximum number of digits allowed in the fraction portion of a number. More... | |
virtual void | setMaximumFractionDigits (int32_t newValue) |
Sets the maximum number of digits allowed in the fraction portion of a number. More... | |
int32_t | getMinimumFractionDigits (void) const |
Returns the minimum number of digits allowed in the fraction portion of a number. More... | |
virtual void | setMinimumFractionDigits (int32_t newValue) |
Sets the minimum number of digits allowed in the fraction portion of a number. More... | |
virtual void | setCurrency (const char16_t *theCurrency, UErrorCode &ec) |
Sets the currency used to display currency amounts. More... | |
const char16_t * | getCurrency () const |
Gets the currency used to display currency amounts. More... | |
virtual void | setContext (UDisplayContext value, UErrorCode &status) |
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE. More... | |
virtual UDisplayContext | getContext (UDisplayContextType type, UErrorCode &status) const |
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION. More... | |
virtual ERoundingMode | getRoundingMode (void) const |
Get the rounding mode. More... | |
virtual void | setRoundingMode (ERoundingMode roundingMode) |
Set the rounding mode. More... | |
virtual UClassID | getDynamicClassID (void) const =0 |
Returns a unique class ID POLYMORPHICALLY. More... | |
Public Member Functions inherited from icu::Format | |
virtual | ~Format () |
Destructor. More... | |
UBool | operator!= (const Format &other) const |
Return true if the given Format objects are not semantically equal. More... | |
virtual Format * | clone () const =0 |
Clone this object polymorphically. More... | |
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const |
Formats an object to produce a string. More... | |
void | parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const |
Parses a string to produce an object. More... | |
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const |
Get the locale for this format object. More... | |
const char * | getLocaleID (ULocDataLocaleType type, UErrorCode &status) const |
Get the locale for this format object. More... | |
Public Member Functions inherited from icu::UObject | |
virtual | ~UObject () |
Destructor. More... | |
Static Public Member Functions | |
static NumberFormat * | createInstance (UErrorCode &) |
Create a default style NumberFormat for the current default locale. More... | |
static NumberFormat * | createInstance (const Locale &inLocale, UErrorCode &) |
Create a default style NumberFormat for the specified locale. More... | |
static NumberFormat * | createInstance (const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode) |
Create a specific style NumberFormat for the specified locale. More... | |
static NumberFormat * | internalCreateInstance (const Locale &desiredLocale, UNumberFormatStyle style, UErrorCode &errorCode) |
ICU use only. More... | |
static const SharedNumberFormat * | createSharedInstance (const Locale &inLocale, UNumberFormatStyle style, UErrorCode &status) |
ICU use only. More... | |
static NumberFormat * | createCurrencyInstance (UErrorCode &) |
Returns a currency format for the current default locale. More... | |
static NumberFormat * | createCurrencyInstance (const Locale &inLocale, UErrorCode &) |
Returns a currency format for the specified locale. More... | |
static NumberFormat * | createPercentInstance (UErrorCode &) |
Returns a percentage format for the current default locale. More... | |
static NumberFormat * | createPercentInstance (const Locale &inLocale, UErrorCode &) |
Returns a percentage format for the specified locale. More... | |
static NumberFormat * | createScientificInstance (UErrorCode &) |
Returns a scientific format for the current default locale. More... | |
static NumberFormat * | createScientificInstance (const Locale &inLocale, UErrorCode &) |
Returns a scientific format for the specified locale. More... | |
static const Locale * | getAvailableLocales (int32_t &count) |
Get the set of Locales for which NumberFormats are installed. More... | |
static URegistryKey | registerFactory (NumberFormatFactory *toAdopt, UErrorCode &status) |
Register a new NumberFormatFactory. More... | |
static UBool | unregister (URegistryKey key, UErrorCode &status) |
Unregister a previously-registered NumberFormatFactory using the key returned from the register call. More... | |
static StringEnumeration * | getAvailableLocales (void) |
Return a StringEnumeration over the locales available at the time of the call, including registered locales. More... | |
static UClassID | getStaticClassID (void) |
Return the class ID for this class. More... | |
Protected Member Functions | |
NumberFormat () | |
Default constructor for subclass use only. More... | |
NumberFormat (const NumberFormat &) | |
Copy constructor. More... | |
NumberFormat & | operator= (const NumberFormat &) |
Assignment operator. More... | |
virtual void | getEffectiveCurrency (char16_t *result, UErrorCode &ec) const |
Returns the currency in effect for this formatter. More... | |
Protected Member Functions inherited from icu::Format | |
void | setLocaleIDs (const char *valid, const char *actual) |
Format () | |
Default constructor for subclass use only. More... | |
Format (const Format &) | |
Format & | operator= (const Format &) |
Static Protected Member Functions | |
static NumberFormat * | makeInstance (const Locale &desiredLocale, UNumberFormatStyle style, UBool mustBeDecimalFormat, UErrorCode &errorCode) |
Creates the specified number format style of the desired locale. More... | |
Static Protected Member Functions inherited from icu::Format | |
static void | syntaxError (const UnicodeString &pattern, int32_t pos, UParseError &parseError) |
Simple function for initializing a UParseError from a UnicodeString. More... | |
Static Protected Attributes | |
static const int32_t | gDefaultMaxIntegerDigits |
static const int32_t | gDefaultMinIntegerDigits |
Friends | |
class | ICUNumberFormatFactory |
class | ICUNumberFormatService |
class | ::NumberFormatTest |
IMPORTANT: New users are strongly encouraged to see if numberformatter.h fits their use case. Although not deprecated, this header is provided for backwards compatibility only.
Abstract base class for all number formats. Provides interface for formatting and parsing a number. Also provides methods for determining which locales have number formats, and what their names are.
NumberFormat helps you to format and parse numbers for any locale. Your code can be completely independent of the locale conventions for decimal points, thousands-separators, or even the particular decimal digits used, or whether the number format is even decimal.
To format a number for the current Locale, use one of the static factory methods:
Note that there are additional factory methods within subclasses of NumberFormat.
If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.
To format a number for a different Locale, specify it in the call to createInstance()
.
You can use a NumberFormat
to parse also.
Use createInstance()
to get the normal number format for a Locale
. There are other static factory methods available. Use createCurrencyInstance()
to get the currency number format for that country. Use createPercentInstance()
to get a format for displaying percentages. With this format, a fraction from 0.53 is displayed as 53%.
The type of number formatting can be specified by passing a 'style' parameter to createInstance()
. For example, use
createInstance(locale, UNUM_DECIMAL, errorCode)
to get the normal number format,
createInstance(locale, UNUM_PERCENT, errorCode)
to get a format for displaying percentage,
createInstance(locale, UNUM_SCIENTIFIC, errorCode)
to get a format for displaying scientific number,
createInstance(locale, UNUM_CURRENCY, errorCode)
to get the currency number format, in which the currency is represented by its symbol, for example, "$3.00".
createInstance(locale, UNUM_CURRENCY_ISO, errorCode)
to get the currency number format, in which the currency is represented by its ISO code, for example "USD3.00".
createInstance(locale, UNUM_CURRENCY_PLURAL, errorCode)
to get the currency number format, in which the currency is represented by its full name in plural format, for example, "3.00 US dollars" or "1.00 US dollar".
You can also control the display of numbers with such methods as getMinimumFractionDigits()
. If you want even more control over the format or parsing, or want to give your users more control, you can try dynamic_casting the NumberFormat
you get from the factory methods to a DecimalFormat
. This will work for the vast majority of countries; just remember to test for NULL in case you encounter an unusual one.
You can also use forms of the parse and format methods with ParsePosition
and FieldPosition
to allow you to:
For example, you can align numbers in two ways.
If you are using a monospaced font with spacing for alignment, you can pass the FieldPosition
in your format call, with field = UNUM_INTEGER_FIELD
. On output, getEndIndex
will be set to the offset between the last character of the integer and the decimal. Add (desiredSpaceCount - getEndIndex) spaces at the front of the string.
If you are using proportional fonts, instead of padding with spaces, measure the width of the string in pixels from the start to getEndIndex. Then move the pen by (desiredPixelWidth - widthToAlignmentPoint) before drawing the text. It also works where there is no decimal, but possibly additional characters at the end, e.g. with parentheses in negative numbers: "(12)" for -12.
User subclasses are not supported. While clients may write subclasses, such code will not necessarily work and will not be guaranteed to work stably from release to release.
Alignment Field constants used to construct a FieldPosition object.
Signifies that the position of the integer part or fraction part of a formatted number should be returned.
Note: as of ICU 4.4, the values in this enum have been extended to support identification of all number format fields, not just those pertaining to alignment.
These constants are provided for backwards compatibility only. Please use the C style constants defined in the header file unum.h.
Enumerator | |
---|---|
kIntegerField |
|
kFractionField |
|
kDecimalSeparatorField |
|
kExponentSymbolField |
|
kExponentSignField |
|
kExponentField |
|
kGroupingSeparatorField |
|
kCurrencyField |
|
kPercentField |
|
kPermillField |
|
kSignField |
|
kMeasureUnitField |
|
kCompactField |
|
INTEGER_FIELD | These constants are provided for backwards compatibility only. Please use the constants defined in the header file unum.h.
|
FRACTION_FIELD |
|
Rounding mode.
For more detail on rounding modes, see: http://userguide.icu-project.org/formatparse/numbers/rounding-modes
Enumerator | |
---|---|
kRoundCeiling | Round towards positive infinity. |
kRoundFloor | Round towards negative infinity. |
kRoundDown | Round towards zero. |
kRoundUp | Round away from zero. |
kRoundHalfEven | Round towards the nearest integer, or towards the nearest even integer if equidistant. |
kRoundHalfDown | Round towards the nearest integer, or towards zero if equidistant. |
kRoundHalfUp | Round towards the nearest integer, or away from zero if equidistant. |
kRoundUnnecessary | Return U_FORMAT_INEXACT_ERROR if number does not format exactly.
|
|
virtual |
Destructor.
|
protected |
Default constructor for subclass use only.
|
protected |
Copy constructor.
|
static |
Returns a currency format for the current default locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
|
static |
Returns a currency format for the specified locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
inLocale | the given locale. |
|
static |
Create a default style NumberFormat for the current default locale.
The default formatting style is locale dependent.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
|
static |
Create a default style NumberFormat for the specified locale.
The default formatting style is locale dependent.
inLocale | the given locale. |
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
|
static |
Create a specific style NumberFormat for the specified locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
desiredLocale | the given locale. |
style | the given style. |
errorCode | Output param filled with success/failure status. |
|
static |
Returns a percentage format for the current default locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
|
static |
Returns a percentage format for the specified locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
inLocale | the given locale. |
|
static |
Returns a scientific format for the current default locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
|
static |
Returns a scientific format for the specified locale.
NOTE: New users are strongly encouraged to use icu::number::NumberFormatter instead of NumberFormat.
inLocale | the given locale. |
|
static |
ICU use only.
Returns handle to the shared, cached NumberFormat instance for given locale. On success, caller must call removeRef() on returned value once it is done with the shared instance.
|
virtual |
Format an object to produce a string.
This method handles Formattable objects with numeric types. If the Formattable object type is not a numeric type, then it returns a failing UErrorCode.
obj | The object to format. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | Output param filled with success/failure status. |
Implements icu::Format.
|
virtual |
Format an object to produce a string.
This method handles Formattable objects with numeric types. If the Formattable object type is not a numeric type, then it returns a failing UErrorCode.
obj | The object to format. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be NULL. |
status | Output param filled with success/failure status. |
Reimplemented from icu::Format.
UnicodeString& icu::NumberFormat::format | ( | double | number, |
UnicodeString & | appendTo | ||
) | const |
Format a double number.
These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
UnicodeString& icu::NumberFormat::format | ( | int32_t | number, |
UnicodeString & | appendTo | ||
) | const |
Format a long number.
These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
UnicodeString& icu::NumberFormat::format | ( | int64_t | number, |
UnicodeString & | appendTo | ||
) | const |
Format an int64 number.
These methods call the NumberFormat pure virtual format() methods with the default FieldPosition.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
|
pure virtual |
Format a double number.
Concrete subclasses must implement these pure virtual methods.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
Implemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, and icu::ChoiceFormat.
|
virtual |
Format a double number.
By default, the parent function simply calls the base class and does not return an error status. Therefore, the status may be ignored in some subclasses.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | error status |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format a double number.
Subclasses must implement this method.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be NULL. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat.
|
pure virtual |
Format a long number.
Concrete subclasses must implement these pure virtual methods.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
Implemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, and icu::ChoiceFormat.
|
virtual |
Format a long number.
Concrete subclasses may override this function to provide status return.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | the output status. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format an int32 number.
Subclasses must implement this method.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be NULL. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format an int64 number.
(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
Reimplemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, and icu::ChoiceFormat.
|
virtual |
Format an int64 number.
(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format an int64 number.
Subclasses must implement this method.
number | The value to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be NULL. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format a decimal number.
Subclasses must implement this method. The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal
number | The unformatted number, as a string, to be formatted. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. Can be NULL. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Format a decimal number.
The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that. Subclasses of NumberFormat that want to specifically handle big decimal numbers must override this method. class DecimalFormat does so.
number | The number, a DecimalQuantity format Decimal Floating Point. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat, and icu::RuleBasedNumberFormat.
|
virtual |
Format a decimal number.
The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation in NumberFormat converts the decimal number to a double and formats that. Subclasses of NumberFormat that want to specifically handle big decimal numbers must override this method. class DecimalFormat does so.
number | The number, a DecimalQuantity format Decimal Floating Point. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | Output param filled with success/failure status. |
Reimplemented in icu::DecimalFormat, and icu::RuleBasedNumberFormat.
|
static |
Get the set of Locales for which NumberFormats are installed.
count | Output param to receive the size of the locales |
|
static |
Return a StringEnumeration over the locales available at the time of the call, including registered locales.
|
virtual |
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.
type | The UDisplayContextType whose value to return |
status | Input/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function. |
const char16_t* icu::NumberFormat::getCurrency | ( | ) | const |
Gets the currency used to display currency amounts.
This may be an empty string for some subclasses.
|
pure virtual |
Returns a unique class ID POLYMORPHICALLY.
Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.
Reimplemented from icu::UObject.
Implemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, icu::ChoiceFormat, and icu::CompactDecimalFormat.
|
protectedvirtual |
Returns the currency in effect for this formatter.
Subclasses should override this method as needed. Unlike getCurrency(), this method should never return "".
int32_t icu::NumberFormat::getMaximumFractionDigits | ( | void | ) | const |
Returns the maximum number of digits allowed in the fraction portion of a number.
int32_t icu::NumberFormat::getMaximumIntegerDigits | ( | void | ) | const |
Returns the maximum number of digits allowed in the integer portion of a number.
int32_t icu::NumberFormat::getMinimumFractionDigits | ( | void | ) | const |
Returns the minimum number of digits allowed in the fraction portion of a number.
int32_t icu::NumberFormat::getMinimumIntegerDigits | ( | void | ) | const |
Returns the minimum number of digits allowed in the integer portion of a number.
|
virtual |
Get the rounding mode.
This will always return NumberFormat::ERoundingMode::kRoundUnnecessary if the subclass does not support rounding.
Reimplemented in icu::DecimalFormat, and icu::RuleBasedNumberFormat.
|
static |
Return the class ID for this class.
This is useful for comparing to a return value from getDynamicClassID(). Note that, because NumberFormat is an abstract base class, no fully constructed object will have the class ID returned by NumberFormat::getStaticClassID().
|
static |
ICU use only.
Creates NumberFormat instance without using the cache.
UBool icu::NumberFormat::isGroupingUsed | ( | void | ) | const |
Returns true if grouping is used in this format.
For example, in the English locale, with grouping on, the number 1234567 might be formatted as "1,234,567". The grouping separator as well as the size of each group is locale dependent and is determined by sub-classes of NumberFormat.
|
inlinevirtual |
Returns whether lenient parsing is enabled (it is off by default).
TRUE
if lenient parsing is enabled, FALSE
otherwise. Reimplemented in icu::RuleBasedNumberFormat.
Definition at line 1249 of file numfmt.h.
References U_NAMESPACE_END.
|
inline |
Return true if this format will parse numbers as integers only.
For example in the English locale, with ParseIntegerOnly true, the string "1234." would be parsed as the integer value 1234 and parsing would stop at the "." character. Of course, the exact format accepted by the parse operation is locale dependant and determined by sub-classes of NumberFormat.
|
staticprotected |
Creates the specified number format style of the desired locale.
If mustBeDecimalFormat is TRUE, then the returned pointer is either a DecimalFormat or it is NULL.
|
protected |
Assignment operator.
Return true if the given Format objects are semantically equal.
Objects of different subclasses are considered unequal.
Implements icu::Format.
Reimplemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, and icu::ChoiceFormat.
|
pure virtual |
Return a long if possible (e.g.
within range LONG_MAX, LONG_MAX], and with no decimals), otherwise a double. If IntegerOnly is set, will stop at a decimal point (or equivalent; e.g. for rational numbers "1 2/3", will stop after the 1).
If no object can be parsed, index is unchanged, and NULL is returned.
This is a pure virtual which concrete subclasses must implement.
text | The text to be parsed. |
result | Formattable to be set to the parse result. If parse fails, return contents are undefined. |
parsePosition | The position to start parsing at on input. On output, moved to after the last successfully parse character. On parse failure, does not change. |
Implemented in icu::DecimalFormat, icu::RuleBasedNumberFormat, icu::ChoiceFormat, and icu::CompactDecimalFormat.
|
virtual |
Parse a string as a numeric value, and return a Formattable numeric object.
This method parses integers only if IntegerOnly is set.
text | The text to be parsed. |
result | Formattable to be set to the parse result. If parse fails, return contents are undefined. |
status | Output parameter set to a failure error code when a failure occurs. |
Reimplemented in icu::CompactDecimalFormat.
|
virtual |
Parses text from the given string as a currency amount.
Unlike the parse() method, this method will attempt to parse a generic currency name, searching for a match of this object's locale's currency display names, or for a 3-letter ISO currency code. This method will fail if this format is not a currency format, that is, if it does not contain the currency pattern symbol (U+00A4) in its prefix or suffix.
text | the string to parse |
pos | input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output. |
Reimplemented in icu::DecimalFormat, and icu::CompactDecimalFormat.
|
virtual |
Parse a string to produce an object.
This methods handles parsing of numeric strings into Formattable objects with numeric types.
Before calling, set parse_pos.index to the offset you want to start parsing at in the source. After calling, parse_pos.index indicates the position after the successfully parsed text. If an error occurs, parse_pos.index is unchanged.
When parsing, leading whitespace is discarded (with successful parse), while trailing whitespace is left as is.
See Format::parseObject() for more.
source | The string to be parsed into an object. |
result | Formattable to be set to the parse result. If parse fails, return contents are undefined. |
parse_pos | The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged. |
Implements icu::Format.
|
static |
Register a new NumberFormatFactory.
The factory will be adopted. Because ICU may choose to cache NumberFormat objects internally, this must be called at application startup, prior to any calls to NumberFormat::createInstance to avoid undefined behavior.
toAdopt | the NumberFormatFactory instance to be adopted |
status | the in/out status code, no special meanings are assigned |
|
virtual |
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
value | The UDisplayContext value to set. |
status | Input/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function. |
Reimplemented in icu::RuleBasedNumberFormat.
|
virtual |
Sets the currency used to display currency amounts.
This takes effect immediately, if this format is a currency format. If this format is not a currency format, then the currency is used if and when this object becomes a currency format.
theCurrency | a 3-letter ISO code indicating new currency to use. It need not be null-terminated. May be the empty string or NULL to indicate no currency. |
ec | input-output error code |
Reimplemented in icu::DecimalFormat.
|
virtual |
Set whether or not grouping will be used in this format.
newValue | True, grouping will be used in this format. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Sets whether lenient parsing should be enabled (it is off by default).
enable | TRUE if lenient parsing should be used, FALSE otherwise. |
Reimplemented in icu::RuleBasedNumberFormat, and icu::DecimalFormat.
|
virtual |
Sets the maximum number of digits allowed in the fraction portion of a number.
maximumFractionDigits must be >= minimumFractionDigits. If the new value for maximumFractionDigits is less than the current value of minimumFractionDigits, then minimumFractionDigits will also be set to the new value.
newValue | the new value to be set. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Sets the maximum number of digits allowed in the integer portion of a number.
maximumIntegerDigits must be >= minimumIntegerDigits. If the new value for maximumIntegerDigits is less than the current value of minimumIntegerDigits, then minimumIntegerDigits will also be set to the new value.
newValue | the new value for the maximum number of digits allowed in the integer portion of a number. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Sets the minimum number of digits allowed in the fraction portion of a number.
minimumFractionDigits must be <= maximumFractionDigits. If the new value for minimumFractionDigits exceeds the current value of maximumFractionDigits, then maximumIntegerDigits will also be set to the new value
newValue | the new value to be set. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Sets the minimum number of digits allowed in the integer portion of a number.
minimumIntegerDigits must be <= maximumIntegerDigits. If the new value for minimumIntegerDigits exceeds the current value of maximumIntegerDigits, then maximumIntegerDigits will also be set to the new value.
newValue | the new value to be set. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Sets whether or not numbers should be parsed as integers only.
value | set True, this format will parse numbers as integers only. |
Reimplemented in icu::DecimalFormat.
|
virtual |
Set the rounding mode.
If a subclass does not support rounding, this will do nothing.
roundingMode | A rounding mode |
Reimplemented in icu::DecimalFormat.
|
static |
Unregister a previously-registered NumberFormatFactory using the key returned from the register call.
Key becomes invalid after a successful call and should not be used again. The NumberFormatFactory corresponding to the key will be deleted. Because ICU may choose to cache NumberFormat objects internally, this should be called during application shutdown, after all calls to NumberFormat::createInstance to avoid undefined behavior.
key | the registry key returned by a previous call to registerFactory |
status | the in/out status code, no special meanings are assigned |
|
staticprotected |
|
staticprotected |