Movatterモバイル変換


[0]ホーム

URL:


ICU 78.1  78.1
Public Member Functions |Static Public Member Functions
icu::CompactDecimalFormat Class Reference

IMPORTANT: New users are strongly encouraged to see ifnumberformatter.h fits their use case.More...

#include <compactdecimalformat.h>

Inheritance diagram for icu::CompactDecimalFormat:

Public Member Functions

 CompactDecimalFormat (constCompactDecimalFormat &source)
 Copy constructor.More...
 
 ~CompactDecimalFormat () override
 Destructor.More...
 
CompactDecimalFormatoperator= (constCompactDecimalFormat &rhs)
 Assignment operator.More...
 
CompactDecimalFormatclone () const override
 Clone thisFormat object polymorphically.More...
 
void parse (constUnicodeString &text,Formattable &result,ParsePosition &parsePosition) const override
 CompactDecimalFormat does not support parsing.More...
 
void parse (constUnicodeString &text,Formattable &result,UErrorCode &status) const override
 CompactDecimalFormat does not support parsing.More...
 
CurrencyAmountparseCurrency (constUnicodeString &text,ParsePosition &pos) const override
 Parses text from the given string as a currency amount.More...
 
UClassID getDynamicClassID () const override
 Returns a unique class ID POLYMORPHICALLY.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (StringPiece number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a decimal number.More...
 
UnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a decimal number.More...
 
UnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a decimal number.More...
 
- Public Member Functions inherited fromicu::DecimalFormat
 DecimalFormat (UErrorCode &status)
 Create aDecimalFormat using the default pattern and symbols for the default locale.More...
 
 DecimalFormat (constUnicodeString &pattern,UErrorCode &status)
 Create aDecimalFormat from the given pattern and the symbols for the default locale.More...
 
 DecimalFormat (constUnicodeString &pattern,DecimalFormatSymbols *symbolsToAdopt,UErrorCode &status)
 Create aDecimalFormat from the given pattern and symbols.More...
 
 DecimalFormat (constUnicodeString &pattern,DecimalFormatSymbols *symbolsToAdopt,UNumberFormatStyle style,UErrorCode &status)
 This API is for ICU use only.More...
 
virtualDecimalFormatsetAttribute (UNumberFormatAttribute attr, int32_t newValue,UErrorCode &status)
 Set an integer attribute on thisDecimalFormat.More...
 
virtual int32_t getAttribute (UNumberFormatAttribute attr,UErrorCode &status) const
 Get an integer May return U_UNSUPPORTED_ERROR if this instance does not support the specified attribute.More...
 
void setGroupingUsed (UBool newValue) override
 Set whether or not grouping will be used in this format.More...
 
void setParseIntegerOnly (UBool value) override
 Sets whether or not numbers should be parsed as integers only.More...
 
void setLenient (UBool enable) override
 Sets whether lenient parsing should be enabled (it is off by default).More...
 
 DecimalFormat (constUnicodeString &pattern,DecimalFormatSymbols *symbolsToAdopt,UParseError &parseError,UErrorCode &status)
 Create aDecimalFormat from the given pattern and symbols.More...
 
 DecimalFormat (constUnicodeString &pattern, constDecimalFormatSymbols &symbols,UErrorCode &status)
 Create aDecimalFormat from the given pattern and symbols.More...
 
 DecimalFormat (constDecimalFormat &source)
 Copy constructor.More...
 
DecimalFormatoperator= (constDecimalFormat &rhs)
 Assignment operator.More...
 
 ~DecimalFormat () override
 Destructor.More...
 
DecimalFormatclone () const override
 Clone thisFormat object polymorphically.More...
 
bool operator== (constFormat &other) const override
 Return true if the givenFormat objects are semantically equal.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a double or long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a long number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format an int64 number using base-10 representation.More...
 
UnicodeStringformat (StringPiece number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a decimal number.More...
 
UnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format a decimal number.More...
 
UnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format a decimal number.More...
 
void parse (constUnicodeString &text,Formattable &result,ParsePosition &parsePosition) const override
 Parse the given string using this object's choices.More...
 
CurrencyAmountparseCurrency (constUnicodeString &text,ParsePosition &pos) const override
 Parses text from the given string as a currency amount.More...
 
virtual constDecimalFormatSymbolsgetDecimalFormatSymbols () const
 Returns the decimal format symbols, which is generally not changed by the programmer or user.More...
 
virtual void adoptDecimalFormatSymbols (DecimalFormatSymbols *symbolsToAdopt)
 Sets the decimal format symbols, which is generally not changed by the programmer or user.More...
 
virtual void setDecimalFormatSymbols (constDecimalFormatSymbols &symbols)
 Sets the decimal format symbols, which is generally not changed by the programmer or user.More...
 
virtual constCurrencyPluralInfogetCurrencyPluralInfo () const
 Returns the currency plural format information, which is generally not changed by the programmer or user.More...
 
virtual void adoptCurrencyPluralInfo (CurrencyPluralInfo *toAdopt)
 Sets the currency plural format information, which is generally not changed by the programmer or user.More...
 
virtual void setCurrencyPluralInfo (constCurrencyPluralInfo &info)
 Sets the currency plural format information, which is generally not changed by the programmer or user.More...
 
UnicodeStringgetPositivePrefix (UnicodeString &result) const
 Get the positive prefix.More...
 
virtual void setPositivePrefix (constUnicodeString &newValue)
 Set the positive prefix.More...
 
UnicodeStringgetNegativePrefix (UnicodeString &result) const
 Get the negative prefix.More...
 
virtual void setNegativePrefix (constUnicodeString &newValue)
 Set the negative prefix.More...
 
UnicodeStringgetPositiveSuffix (UnicodeString &result) const
 Get the positive suffix.More...
 
virtual void setPositiveSuffix (constUnicodeString &newValue)
 Set the positive suffix.More...
 
UnicodeStringgetNegativeSuffix (UnicodeString &result) const
 Get the negative suffix.More...
 
virtual void setNegativeSuffix (constUnicodeString &newValue)
 Set the negative suffix.More...
 
UBool isSignAlwaysShown () const
 Whether to show the plus sign on positive (non-negative) numbers; for example, "+12".More...
 
void setSignAlwaysShown (UBool value)
 Set whether to show the plus sign on positive (non-negative) numbers; for example, "+12".More...
 
int32_t getMultiplier () const
 Get the multiplier for use in percent, permill, etc.More...
 
virtual void setMultiplier (int32_t newValue)
 Set the multiplier for use in percent, permill, etc.More...
 
int32_t getMultiplierScale () const
 Gets the power of ten by which number should be multiplied before formatting, which can be combined withsetMultiplier() to multiply by any arbitrary decimal value.More...
 
void setMultiplierScale (int32_t newValue)
 Sets a power of ten by which number should be multiplied before formatting, which can be combined withsetMultiplier() to multiply by any arbitrary decimal value.More...
 
virtual double getRoundingIncrement () const
 Get the rounding increment.More...
 
virtual void setRoundingIncrement (double newValue)
 Set the rounding increment.More...
 
virtualERoundingMode getRoundingMode () const override
 Get the rounding mode.More...
 
virtual void setRoundingMode (ERoundingMode roundingMode) override
 Set the rounding mode.More...
 
virtual int32_t getFormatWidth () const
 Get the width to which the output offormat() is padded.More...
 
virtual void setFormatWidth (int32_t width)
 Set the width to which the output offormat() is padded.More...
 
virtualUnicodeString getPadCharacterString () const
 Get the pad character used to pad to the format width.More...
 
virtual void setPadCharacter (constUnicodeString &padChar)
 Set the character used to pad to the format width.More...
 
virtualEPadPosition getPadPosition () const
 Get the position at which padding will take place.More...
 
virtual void setPadPosition (EPadPosition padPos)
 Set the position at which padding will take place.More...
 
virtualUBool isScientificNotation () const
 Return whether or not scientific notation is used.More...
 
virtual void setScientificNotation (UBool useScientific)
 Set whether or not scientific notation is used.More...
 
virtual int8_t getMinimumExponentDigits () const
 Return the minimum exponent digits that will be shown.More...
 
virtual void setMinimumExponentDigits (int8_t minExpDig)
 Set the minimum exponent digits that will be shown.More...
 
virtualUBool isExponentSignAlwaysShown () const
 Return whether the exponent sign is always shown.More...
 
virtual void setExponentSignAlwaysShown (UBool expSignAlways)
 Set whether the exponent sign is always shown.More...
 
int32_t getGroupingSize () const
 Return the grouping size.More...
 
virtual void setGroupingSize (int32_t newValue)
 Set the grouping size.More...
 
int32_t getSecondaryGroupingSize () const
 Return the secondary grouping size.More...
 
virtual void setSecondaryGroupingSize (int32_t newValue)
 Set the secondary grouping size.More...
 
int32_t getMinimumGroupingDigits () const
 Returns the minimum number of grouping digits.More...
 
void setMinimumGroupingDigits (int32_t newValue)
 Sets the minimum grouping digits.More...
 
UBool isDecimalSeparatorAlwaysShown () const
 Allows you to get the behavior of the decimal separator with integers.More...
 
virtual void setDecimalSeparatorAlwaysShown (UBool newValue)
 Allows you to set the behavior of the decimal separator with integers.More...
 
UBool isDecimalPatternMatchRequired () const
 Allows you to get the parse behavior of the pattern decimal mark.More...
 
virtual void setDecimalPatternMatchRequired (UBool newValue)
 Allows you to set the parse behavior of the pattern decimal mark.More...
 
UBool isParseNoExponent () const
 Returns whether to ignore exponents when parsing.More...
 
void setParseNoExponent (UBool value)
 Specifies whether to stop parsing when an exponent separator is encountered.More...
 
UBool isParseCaseSensitive () const
 Returns whether parsing is sensitive to case (lowercase/uppercase).More...
 
void setParseCaseSensitive (UBool value)
 Whether to pay attention to case when parsing; default is to ignore case (perform case-folding).More...
 
UBool isFormatFailIfMoreThanMaxDigits () const
 Returns whether truncation of high-order integer digits should result in an error.More...
 
void setFormatFailIfMoreThanMaxDigits (UBool value)
 Sets whether truncation of high-order integer digits should result in an error.More...
 
virtualUnicodeStringtoPattern (UnicodeString &result) const
 Synthesizes a pattern string that represents the current state of thisFormat object.More...
 
virtualUnicodeStringtoLocalizedPattern (UnicodeString &result) const
 Synthesizes a localized pattern string that represents the current state of thisFormat object.More...
 
virtual void applyPattern (constUnicodeString &pattern,UParseError &parseError,UErrorCode &status)
 Apply the given pattern to thisFormat object.More...
 
virtual void applyPattern (constUnicodeString &pattern,UErrorCode &status)
 Sets the pattern.More...
 
virtual void applyLocalizedPattern (constUnicodeString &pattern,UParseError &parseError,UErrorCode &status)
 Apply the given pattern to thisFormat object.More...
 
virtual void applyLocalizedPattern (constUnicodeString &pattern,UErrorCode &status)
 Apply the given pattern to thisFormat object.More...
 
void setMaximumIntegerDigits (int32_t newValue) override
 Sets the maximum number of digits allowed in the integer portion of a number.More...
 
void setMinimumIntegerDigits (int32_t newValue) override
 Sets the minimum number of digits allowed in the integer portion of a number.More...
 
void setMaximumFractionDigits (int32_t newValue) override
 Sets the maximum number of digits allowed in the fraction portion of a number.More...
 
void setMinimumFractionDigits (int32_t newValue) override
 Sets the minimum number of digits allowed in the fraction portion of a number.More...
 
int32_t getMinimumSignificantDigits () const
 Returns the minimum number of significant digits that will be displayed.More...
 
int32_t getMaximumSignificantDigits () const
 Returns the maximum number of significant digits that will be displayed.More...
 
void setMinimumSignificantDigits (int32_t min)
 Sets the minimum number of significant digits that will be displayed.More...
 
void setMaximumSignificantDigits (int32_t max)
 Sets the maximum number of significant digits that will be displayed.More...
 
UBool areSignificantDigitsUsed () const
 Returns true if significant digits are in use, or false if integer and fraction digit counts are in use.More...
 
void setSignificantDigitsUsed (UBool useSignificantDigits)
 Sets whether significant digits are in use, or integer and fraction digit counts are in use.More...
 
void setCurrency (const char16_t *theCurrency,UErrorCode &ec) override
 Sets the currency used to display currency amounts.More...
 
virtual void setCurrency (const char16_t *theCurrency)
 Sets the currency used to display currency amounts.More...
 
void setCurrencyUsage (UCurrencyUsage newUsage,UErrorCode *ec)
 Sets theCurrency Usage object used to display currency.More...
 
UCurrencyUsage getCurrencyUsage () const
 Returns theCurrency Usage object used to display currency.More...
 
void formatToDecimalQuantity (double number, number::impl::DecimalQuantity &output,UErrorCode &status) const
 Format a number and save it into the given DecimalQuantity.More...
 
void formatToDecimalQuantity (constFormattable &number, number::impl::DecimalQuantity &output,UErrorCode &status) const
 Get a DecimalQuantity corresponding to a formattable as it would be formatted by thisDecimalFormat.More...
 
constnumber::LocalizedNumberFormattertoNumberFormatter (UErrorCode &status) const
 Converts thisDecimalFormat to a (Localized)NumberFormatter.More...
 
UClassID getDynamicClassID () const override
 Returns a unique class ID POLYMORPHICALLY.More...
 
virtualUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format an object to produce a string.More...
 
virtualUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format an object to produce a string.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo) const
 Format a double number.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo) const
 Format a long number.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo) const
 Format an int64 number.More...
 
virtualUnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos) const=0
 Format a double number.More...
 
virtualUnicodeStringformat (double number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const
 Format a double number.More...
 
virtualUnicodeStringformat (double number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format a double number.More...
 
virtualUnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos) const=0
 Format a long number.More...
 
virtualUnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const
 Format a long number.More...
 
virtualUnicodeStringformat (int32_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format an int32 number.More...
 
virtualUnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos) const
 Format an int64 number.More...
 
virtualUnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const
 Format an int64 number.More...
 
virtualUnicodeStringformat (int64_t number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format an int64 number.More...
 
virtualUnicodeStringformat (StringPiece number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format a decimal number.More...
 
virtualUnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format a decimal number.More...
 
virtualUnicodeStringformat (const number::impl::DecimalQuantity &number,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const
 Format a decimal number.More...
 
virtual void parse (constUnicodeString &text,Formattable &result,ParsePosition &parsePosition) const=0
 Return a long if possible (e.g.More...
 
virtual void parse (constUnicodeString &text,Formattable &result,UErrorCode &status) const
 Parse a string as a numeric value, and return aFormattable numeric object.More...
 
- Public Member Functions inherited fromicu::NumberFormat
virtual ~NumberFormat ()
 Destructor.More...
 
virtualUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const override
 Format an object to produce a string.More...
 
virtualUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const override
 Format an object to produce a string.More...
 
virtual void parseObject (constUnicodeString &source,Formattable &result,ParsePosition &parse_pos) const override
 Parse a string to produce an object.More...
 
UnicodeStringformat (double number,UnicodeString &appendTo) const
 Format a double number.More...
 
UnicodeStringformat (int32_t number,UnicodeString &appendTo) const
 Format a long number.More...
 
UnicodeStringformat (int64_t number,UnicodeString &appendTo) const
 Format an int64 number.More...
 
UBool isParseIntegerOnly () const
 Return true if this format will parse numbers as integers only.More...
 
virtualUBool isLenient () const
 Returns whether lenient parsing is enabled (it is off by default).More...
 
UBool isGroupingUsed () const
 Returns true if grouping is used in this format.More...
 
int32_t getMaximumIntegerDigits () const
 Returns the maximum number of digits allowed in the integer portion of a number.More...
 
int32_t getMinimumIntegerDigits () const
 Returns the minimum number of digits allowed in the integer portion of a number.More...
 
int32_t getMaximumFractionDigits () const
 Returns the maximum number of digits allowed in the fraction portion of a number.More...
 
int32_t getMinimumFractionDigits () const
 Returns the minimum number of digits allowed in the fraction portion of a number.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...
 
virtualUDisplayContext getContext (UDisplayContextType type,UErrorCode &status) const
 Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.More...
 
U_I18N_APIUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,UErrorCode &status) const
 Formats an object to produce a string.More...
 
virtualU_I18N_APIUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPosition &pos,UErrorCode &status) const=0
 Format an object to produce a string.More...
 
virtualU_I18N_APIUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,FieldPositionIterator *posIter,UErrorCode &status) const
 Format an object to produce a string.More...
 
- Public Member Functions inherited fromicu::Format
virtualU_I18N_API ~Format ()
 Destructor.More...
 
U_I18N_API bool operator!= (constFormat &other) const
 Return true if the givenFormat objects are not semantically equal.More...
 
U_I18N_APIUnicodeStringformat (constFormattable &obj,UnicodeString &appendTo,UErrorCode &status) const
 Formats an object to produce a string.More...
 
U_I18N_API void parseObject (constUnicodeString &source,Formattable &result,UErrorCode &status) const
 Parses a string to produce an object.More...
 
U_I18N_APILocale getLocale (ULocDataLocaleType type,UErrorCode &status) const
 Get the locale for this format object.More...
 
U_I18N_API const char * getLocaleID (ULocDataLocaleType type,UErrorCode &status) const
 Get the locale for this format object.More...
 
- Public Member Functions inherited fromicu::UObject
virtual ~UObject ()
 Destructor.More...
 

Static Public Member Functions

staticCompactDecimalFormatcreateInstance (constLocale &inLocale,UNumberCompactStyle style,UErrorCode &status)
 Returns a compact decimal instance for specified locale.More...
 
staticUClassID getStaticClassID ()
 Return the class ID for this class.More...
 
- Static Public Member Functions inherited fromicu::DecimalFormat
staticUClassID getStaticClassID ()
 Return the class ID for this class.More...
 
- Static Public Member Functions inherited fromicu::NumberFormat
staticNumberFormatcreateInstance (UErrorCode &)
 Create a default styleNumberFormat for the current default locale.More...
 
staticNumberFormatcreateInstance (constLocale &inLocale,UErrorCode &)
 Create a default styleNumberFormat for the specified locale.More...
 
staticNumberFormatcreateInstance (constLocale &desiredLocale,UNumberFormatStyle style,UErrorCode &errorCode)
 Create a specific styleNumberFormat for the specified locale.More...
 
staticNumberFormatinternalCreateInstance (constLocale &desiredLocale,UNumberFormatStyle style,UErrorCode &errorCode)
 ICU use only.More...
 
static const SharedNumberFormat * createSharedInstance (constLocale &inLocale,UNumberFormatStyle style,UErrorCode &status)
 ICU use only.More...
 
staticNumberFormatcreateCurrencyInstance (UErrorCode &)
 Returns a currency format for the current default locale.More...
 
staticNumberFormatcreateCurrencyInstance (constLocale &inLocale,UErrorCode &)
 Returns a currency format for the specified locale.More...
 
staticNumberFormatcreatePercentInstance (UErrorCode &)
 Returns a percentage format for the current default locale.More...
 
staticNumberFormatcreatePercentInstance (constLocale &inLocale,UErrorCode &)
 Returns a percentage format for the specified locale.More...
 
staticNumberFormatcreateScientificInstance (UErrorCode &)
 Returns a scientific format for the current default locale.More...
 
staticNumberFormatcreateScientificInstance (constLocale &inLocale,UErrorCode &)
 Returns a scientific format for the specified locale.More...
 
static constLocalegetAvailableLocales (int32_t &count)
 Get the set of Locales for which NumberFormats are installed.More...
 
staticURegistryKey registerFactory (NumberFormatFactory *toAdopt,UErrorCode &status)
 Register a newNumberFormatFactory.More...
 
staticUBool unregister (URegistryKey key,UErrorCode &status)
 Unregister a previously-registeredNumberFormatFactory using the key returned from the register call.More...
 
staticStringEnumerationgetAvailableLocales ()
 Return aStringEnumeration over the locales available at the time of the call, including registered locales.More...
 
staticUClassID getStaticClassID ()
 Return the class ID for this class.More...
 

Additional Inherited Members

- Public Types inherited fromicu::DecimalFormat
enum  EPadPosition {kPadBeforePrefix,kPadAfterPrefix,kPadBeforeSuffix,kPadAfterSuffix }
 Pad position.More...
 
- Public Types inherited fromicu::NumberFormat
enum  ERoundingMode {
  kRoundCeiling,kRoundFloor,kRoundDown,kRoundUp,
  kRoundHalfEven,kRoundHalfDown,kRoundHalfUp,kRoundUnnecessary,
  kRoundHalfOdd,kRoundHalfCeiling,kRoundHalfFloor
}
 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 aFieldPosition object.More...
 
- Protected Member Functions inherited fromicu::NumberFormat
 NumberFormat ()
 Default constructor for subclass use only.More...
 
 NumberFormat (constNumberFormat &)
 Copy constructor.More...
 
NumberFormatoperator= (constNumberFormat &)
 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 fromicu::Format
U_I18N_API void setLocaleIDs (const char *valid, const char *actual)
 
U_I18N_API Format ()
 Default constructor for subclass use only.More...
 
U_I18N_API Format (constFormat &)
 
U_I18N_APIFormatoperator= (constFormat &)
 
- Static Protected Member Functions inherited fromicu::NumberFormat
staticNumberFormatmakeInstance (constLocale &desiredLocale,UNumberFormatStyle style,UBool mustBeDecimalFormat,UErrorCode &errorCode)
 Creates the specified number format style of the desired locale.More...
 
- Static Protected Member Functions inherited fromicu::Format
staticU_I18N_API void syntaxError (constUnicodeString &pattern, int32_t pos,UParseError &parseError)
 Simple function for initializing aUParseError from aUnicodeString.More...
 
- Static Protected Attributes inherited fromicu::NumberFormat
static const int32_t gDefaultMaxIntegerDigits
 
static const int32_t gDefaultMinIntegerDigits
 

Detailed Description

IMPORTANT: New users are strongly encouraged to see ifnumberformatter.h fits their use case.

Although not deprecated, this header is provided for backwards compatibility only.


TheCompactDecimalFormat produces abbreviated numbers, suitable for display in environments will limited real estate. For example, 'Hits: 1.2B' instead of 'Hits: 1,200,000,000'. The format will be appropriate for the given language, such as "1,2 Mrd." for German.

For numbers under 1000 trillion (under 10^15, such as 123,456,789,012,345), the result will be short for supported languages. However, the result may sometimes exceed 7 characters, such as when there are combining marks or thin characters. In such cases, the visual width in fonts should still be short.

By default, there are 3 significant digits. After creation, if more than three significant digits are set (with setMaximumSignificantDigits), or if a fixed number of digits are set (with setMaximumIntegerDigits or setMaximumFractionDigits), then result may be wider.

At this time, parsing is not supported, and will produce a U_UNSUPPORTED_ERROR. Resetting the pattern prefixes or suffixes is not supported; the method calls are ignored.

Stable:
ICU 51

Definition at line63 of filecompactdecimalformat.h.

Constructor & Destructor Documentation

◆ CompactDecimalFormat()

icu::CompactDecimalFormat::CompactDecimalFormat(constCompactDecimalFormatsource)

Copy constructor.

Parameters
sourcetheDecimalFormat object to be copied from.
Stable:
ICU 51

◆ ~CompactDecimalFormat()

icu::CompactDecimalFormat::~CompactDecimalFormat()
override

Destructor.

Stable:
ICU 51

Member Function Documentation

◆ clone()

CompactDecimalFormat* icu::CompactDecimalFormat::clone() const
overridevirtual

Clone thisFormat object polymorphically.

The caller owns the result and should delete it when done.

Returns
a polymorphic copy of thisCompactDecimalFormat.
Stable:
ICU 51

Implementsicu::NumberFormat.

◆ createInstance()

staticCompactDecimalFormat* icu::CompactDecimalFormat::createInstance(constLocaleinLocale,
UNumberCompactStyle style,
UErrorCodestatus 
)
static

Returns a compact decimal instance for specified locale.

NOTE: New users are strongly encouraged to usenumber::NumberFormatter instead ofNumberFormat.

Parameters
inLocalethe given locale.
stylewhether to use short or long style.
statuserror code returned here.
Stable:
ICU 51

◆ format()[1/12]

UnicodeString& icu::DecimalFormat::format
override

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that.

Parameters
numberThe number, a DecimalQuantity format Decimal Floating Point.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Internal:
Do not use. This API is for internal use only.

◆ format()[2/12]

UnicodeString& icu::DecimalFormat::format
override

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that.

Parameters
numberThe number, a DecimalQuantity format Decimal Floating Point.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Internal:
Do not use. This API is for internal use only.

◆ format()[3/12]

UnicodeString& icu::DecimalFormat::format
override

Format a double or long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

◆ format()[4/12]

UnicodeString& icu::DecimalFormat::format
override

Format a double or long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
status
Returns
Reference to 'appendTo' parameter.
Internal:
Do not use. This API is for internal use only.

◆ format()[5/12]

UnicodeString& icu::DecimalFormat::format
override

Format a double or long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

◆ format()[6/12]

UnicodeString& icu::DecimalFormat::format
override

Format a long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

◆ format()[7/12]

UnicodeString& icu::DecimalFormat::format
override

Format a long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Internal:
Do not use. This API is for internal use only.

◆ format()[8/12]

UnicodeString& icu::DecimalFormat::format
override

Format a long number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

◆ format()[9/12]

UnicodeString& icu::DecimalFormat::format
override

Format an int64 number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.8

◆ format()[10/12]

UnicodeString& icu::DecimalFormat::format
override

Format an int64 number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posOn input: an alignment field, if desired. On output: the offsets of the alignment field.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Internal:
Do not use. This API is for internal use only.

◆ format()[11/12]

UnicodeString& icu::DecimalFormat::format
override

Format an int64 number using base-10 representation.

Parameters
numberThe value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

◆ format()[12/12]

UnicodeString& icu::DecimalFormat::format
override

Format a decimal number.

The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available athttp://speleotrove.com/decimal

Parameters
numberThe unformatted number, as a string.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
statusOutput param filled with success/failure status.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

◆ getDynamicClassID()

UClassID icu::CompactDecimalFormat::getDynamicClassID() const
overridevirtual

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. Polymorphicoperator==() andclone() methods call this method.

Returns
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.
Stable:
ICU 51

Implementsicu::NumberFormat.

◆ getStaticClassID()

staticUClassID icu::CompactDecimalFormat::getStaticClassID()
static

Return the class ID for this class.

This is useful only for comparing to a return value fromgetDynamicClassID(). For example:

.      Base* polymorphic_pointer = createPolymorphicObject();.      if (polymorphic_pointer->getDynamicClassID() ==.          Derived::getStaticClassID()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 51

◆ operator=()

CompactDecimalFormat& icu::CompactDecimalFormat::operator=(constCompactDecimalFormatrhs)

Assignment operator.

Parameters
rhstheDecimalFormat object to be copied.
Stable:
ICU 51

◆ parse()[1/2]

void icu::CompactDecimalFormat::parse(constUnicodeStringtext,
Formattableresult,
ParsePositionparsePosition 
) const
overridevirtual

CompactDecimalFormat does not support parsing.

This implementation does nothing.

Parameters
textUnused.
resultDoes not change.
parsePositionDoes not change.
See also
Formattable
Stable:
ICU 51

Implementsicu::NumberFormat.

◆ parse()[2/2]

void icu::CompactDecimalFormat::parse(constUnicodeStringtext,
Formattableresult,
UErrorCodestatus 
) const
overridevirtual

CompactDecimalFormat does not support parsing.

This implementation sets status to U_UNSUPPORTED_ERROR

Parameters
textUnused.
resultDoes not change.
statusAlways set to U_UNSUPPORTED_ERROR.
Stable:
ICU 51

Reimplemented fromicu::NumberFormat.

◆ parseCurrency()

CurrencyAmount* icu::CompactDecimalFormat::parseCurrency(constUnicodeStringtext,
ParsePositionpos 
) const
overridevirtual

Parses text from the given string as a currency amount.

Unlike theparse() 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. This implementation always returns nullptr.

Parameters
textthe string to parse
posinput-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.
Returns
if parse succeeds, a pointer to a newly-createdCurrencyAmount object (owned by the caller) containing information about the parsed currency; if parse fails, this is nullptr.
Internal:
Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.


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

Generated by doxygen 1.9.1
[8]ページ先頭

©2009-2025 Movatter.jp