ICU 60.1  60.1
Public Member Functions | Static Public Member Functions | Friends
icu::number::IntegerWidth Class Reference

A class that defines the strategy for padding and truncating integers before the decimal separator. More...

#include <numberformatter.h>

Inheritance diagram for icu::number::IntegerWidth:
icu::UMemory

Public Member Functions

IntegerWidth truncateAt (int32_t maxInt)
 Truncate numbers exceeding a certain number of numerals before the decimal separator. More...
 

Static Public Member Functions

static IntegerWidth zeroFillTo (int32_t minInt)
 Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator. More...
 

Friends

struct impl::MacroProps
 
struct impl::MicroProps
 
class impl::NumberFormatterImpl
 

Detailed Description

A class that defines the strategy for padding and truncating integers before the decimal separator.

To create an IntegerWidth, use one of the factory methods.

Draft:
This API may be changed in the future versions and was introduced in ICU 60
See also
NumberFormatter

Definition at line 1061 of file numberformatter.h.

Member Function Documentation

◆ truncateAt()

IntegerWidth icu::number::IntegerWidth::truncateAt ( int32_t  maxInt)

Truncate numbers exceeding a certain number of numerals before the decimal separator.

For example, with maxInt=3, the number 1234 will get printed as "234".

Parameters
maxIntThe maximum number of places before the decimal separator.
Returns
An IntegerWidth for passing to the NumberFormatter integerWidth() setter.
Draft:
This API may be changed in the future versions and was introduced in ICU 60
See also
NumberFormatter

◆ zeroFillTo()

static IntegerWidth icu::number::IntegerWidth::zeroFillTo ( int32_t  minInt)
static

Pad numbers at the beginning with zeros to guarantee a certain number of numerals before the decimal separator.

For example, with minInt=3, the number 55 will get printed as "055".

Parameters
minIntThe minimum number of places before the decimal separator.
Returns
An IntegerWidth for chaining or passing to the NumberFormatter integerWidth() setter.
Draft:
This API may be changed in the future versions and was introduced in ICU 60
See also
NumberFormatter

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