A class that defines a quantity by which a number should be multiplied when formatting.
More...
#include <numberformatter.h>
|
static Scale | none () |
| Do not change the value of numbers when formatting or parsing.
|
|
static Scale | powerOfTen (int32_t power) |
| Multiply numbers by a power of ten before formatting.
|
|
static Scale | byDecimal (StringPiece multiplicand) |
| Multiply numbers by an arbitrary value before formatting.
|
|
static Scale | byDouble (double multiplicand) |
| Multiply numbers by an arbitrary value before formatting.
|
|
static Scale | byDoubleAndPowerOfTen (double multiplicand, int32_t power) |
| Multiply a number by both a power of ten and by an arbitrary double value.
|
|
A class that defines a quantity by which a number should be multiplied when formatting.
To create a Scale, use one of the factory methods.
- Stable
- ICU 62
Definition at line 1086 of file numberformatter.h.
◆ Scale() [1/3]
icu::number::Scale::Scale |
( |
const Scale & | other | ) |
|
◆ Scale() [2/3]
icu::number::Scale::Scale |
( |
Scale && | src | ) |
|
|
noexcept |
◆ ~Scale()
icu::number::Scale::~Scale |
( |
| ) |
|
◆ Scale() [3/3]
icu::number::Scale::Scale |
( |
int32_t | magnitude, |
|
|
impl::DecNum * | arbitraryToAdopt ) |
- Internal
- Do not use. This API is for internal use only.
◆ byDecimal()
Multiply numbers by an arbitrary value before formatting.
Useful for unit conversions.
This method takes a string in a decimal number format with syntax as defined in the Decimal Arithmetic Specification, available at http://speleotrove.com/decimal
Also see the version of this method that takes a double.
- Returns
- A Scale for passing to the setter in NumberFormatter.
- Stable
- ICU 62
◆ byDouble()
static Scale icu::number::Scale::byDouble |
( |
double | multiplicand | ) |
|
|
static |
Multiply numbers by an arbitrary value before formatting.
Useful for unit conversions.
This method takes a double; also see the version of this method that takes an exact decimal.
- Returns
- A Scale for passing to the setter in NumberFormatter.
- Stable
- ICU 62
◆ byDoubleAndPowerOfTen()
static Scale icu::number::Scale::byDoubleAndPowerOfTen |
( |
double | multiplicand, |
|
|
int32_t | power ) |
|
static |
Multiply a number by both a power of ten and by an arbitrary double value.
- Returns
- A Scale for passing to the setter in NumberFormatter.
- Stable
- ICU 62
◆ none()
static Scale icu::number::Scale::none |
( |
| ) |
|
|
static |
Do not change the value of numbers when formatting or parsing.
- Returns
- A Scale to prevent any multiplication.
- Stable
- ICU 62
◆ operator=() [1/2]
Scale & icu::number::Scale::operator= |
( |
const Scale & | other | ) |
|
◆ operator=() [2/2]
Scale & icu::number::Scale::operator= |
( |
Scale && | src | ) |
|
|
noexcept |
◆ powerOfTen()
static Scale icu::number::Scale::powerOfTen |
( |
int32_t | power | ) |
|
|
static |
Multiply numbers by a power of ten before formatting.
Useful for combining with a percent unit:
NumberFormatter::with().unit(NoUnit::percent()).multiplier(Scale::powerOfTen(2))
- Returns
- A Scale for passing to the setter in NumberFormatter.
- Stable
- ICU 62
◆ ::icu::numparse::impl::MultiplierParseHandler
friend class ::icu::numparse::impl::MultiplierParseHandler |
|
friend |
◆ ::icu::numparse::impl::NumberParserImpl
friend class ::icu::numparse::impl::NumberParserImpl |
|
friend |
◆ impl::GeneratorHelpers
friend class impl::GeneratorHelpers |
|
friend |
◆ impl::MacroProps
◆ impl::MicroProps
friend struct impl::MicroProps |
|
friend |
◆ impl::MultiplierFormatHandler
friend class impl::MultiplierFormatHandler |
|
friend |
◆ impl::NumberFormatterImpl
friend class impl::NumberFormatterImpl |
|
friend |
The documentation for this class was generated from the following file: