ICU 74.2: icu::number::LocalizedNumberRangeFormatter Class Reference

ICU 74.2 74.2

Public Member Functions | Friends
icu::number::LocalizedNumberRangeFormatter Class Reference

A NumberRangeFormatter that has a locale associated with it; this means .formatRange() methods are available. More...

`#include <numberrangeformatter.h>`

Inheritance diagram for icu::number::LocalizedNumberRangeFormatter:

## Public Member Functions
FormattedNumberRange | formatFormattableRange (const Formattable &first, const Formattable &second, UErrorCode &status) const
| Format the given Formattables to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
| LocalizedNumberRangeFormatter ()=default
| Default constructor: puts the formatter into a valid but undefined state.
| LocalizedNumberRangeFormatter (const LocalizedNumberRangeFormatter &other)
| Returns a copy of this LocalizedNumberRangeFormatter.
| LocalizedNumberRangeFormatter (LocalizedNumberRangeFormatter &&src) noexcept
| Move constructor: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.
LocalizedNumberRangeFormatter & | operator= (const LocalizedNumberRangeFormatter &other)
| Copy assignment operator.
LocalizedNumberRangeFormatter & | operator= (LocalizedNumberRangeFormatter &&src) noexcept
| Move assignment operator: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.
void | formatImpl (impl::UFormattedNumberRangeData &results, bool equalBeforeRounding, UErrorCode &status) const
| ~LocalizedNumberRangeFormatter ()
| Destruct this LocalizedNumberRangeFormatter, cleaning up any memory it might own.
Public Member Functions inherited from icu::number::NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >
LocalizedNumberRangeFormatter | numberFormatterBoth (const UnlocalizedNumberFormatter &formatter) const &
| Sets the NumberFormatter instance to use for the numbers in the range.
LocalizedNumberRangeFormatter | numberFormatterBoth (const UnlocalizedNumberFormatter &formatter) &&
| Overload of numberFormatterBoth() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterBoth (UnlocalizedNumberFormatter &&formatter) const &
| Overload of numberFormatterBoth() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterBoth (UnlocalizedNumberFormatter &&formatter) &&
| Overload of numberFormatterBoth() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterFirst (const UnlocalizedNumberFormatter &formatterFirst) const &
| Sets the NumberFormatter instance to use for the first number in the range.
LocalizedNumberRangeFormatter | numberFormatterFirst (const UnlocalizedNumberFormatter &formatterFirst) &&
| Overload of numberFormatterFirst() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterFirst (UnlocalizedNumberFormatter &&formatterFirst) const &
| Overload of numberFormatterFirst() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterFirst (UnlocalizedNumberFormatter &&formatterFirst) &&
| Overload of numberFormatterFirst() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterSecond (const UnlocalizedNumberFormatter &formatterSecond) const &
| Sets the NumberFormatter instance to use for the second number in the range.
LocalizedNumberRangeFormatter | numberFormatterSecond (const UnlocalizedNumberFormatter &formatterSecond) &&
| Overload of numberFormatterSecond() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterSecond (UnlocalizedNumberFormatter &&formatterSecond) const &
| Overload of numberFormatterSecond() for use on an rvalue reference.
LocalizedNumberRangeFormatter | numberFormatterSecond (UnlocalizedNumberFormatter &&formatterSecond) &&
| Overload of numberFormatterSecond() for use on an rvalue reference.
LocalizedNumberRangeFormatter | collapse (UNumberRangeCollapse collapse) const &
| Sets the aggressiveness of "collapsing" fields across the range separator.
LocalizedNumberRangeFormatter | collapse (UNumberRangeCollapse collapse) &&
| Overload of collapse() for use on an rvalue reference.
LocalizedNumberRangeFormatter | identityFallback (UNumberRangeIdentityFallback identityFallback) const &
| Sets the behavior when the two sides of the range are the same.
LocalizedNumberRangeFormatter | identityFallback (UNumberRangeIdentityFallback identityFallback) &&
| Overload of identityFallback() for use on an rvalue reference.
LocalPointer< LocalizedNumberRangeFormatter > | clone () const &
| Returns the current (Un)LocalizedNumberRangeFormatter as a LocalPointer wrapping a heap-allocated copy of the current object.
LocalPointer< LocalizedNumberRangeFormatter > | clone () &&
| Overload of clone for use on an rvalue reference.
UBool | copyErrorTo (UErrorCode &outErrorCode) const
| Sets the UErrorCode if an error occurred in the fluent chain.

## Friends
class | NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >
class | NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >
class | UnlocalizedNumberRangeFormatter

## Detailed Description

A NumberRangeFormatter that has a locale associated with it; this means .formatRange() methods are available.

Instances of this class are immutable and thread-safe.

See also
  NumberFormatter

Stable:
  ICU 63

Definition at line 480 of file numberrangeformatter.h.

## Constructor & Destructor Documentation

## ◆ LocalizedNumberRangeFormatter() [1/3]

icu::number::LocalizedNumberRangeFormatter::LocalizedNumberRangeFormatter | ( |  | ) |
| default

Default constructor: puts the formatter into a valid but undefined state.

Stable:
  ICU 63

## ◆ LocalizedNumberRangeFormatter() [2/3]

icu::number::LocalizedNumberRangeFormatter::LocalizedNumberRangeFormatter | ( | const LocalizedNumberRangeFormatter & | other | ) |

Returns a copy of this LocalizedNumberRangeFormatter.

Stable:
  ICU 63

## ◆ LocalizedNumberRangeFormatter() [3/3]

icu::number::LocalizedNumberRangeFormatter::LocalizedNumberRangeFormatter | ( | LocalizedNumberRangeFormatter && | src | ) |
| noexcept

Move constructor: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.

Stable:
  ICU 63

## ◆ ~LocalizedNumberRangeFormatter()

icu::number::LocalizedNumberRangeFormatter::~LocalizedNumberRangeFormatter | ( |  | ) |

Destruct this LocalizedNumberRangeFormatter, cleaning up any memory it might own.

Stable:
  ICU 63

## Member Function Documentation

## ◆ formatFormattableRange()

FormattedNumberRange icu::number::LocalizedNumberRangeFormatter::formatFormattableRange | ( | const Formattable & | first,
|  | const Formattable & | second,
|  | UErrorCode & | status
| ) |  | const

Format the given Formattables to a string using the settings specified in the NumberRangeFormatter fluent setting chain.

Parameters

  first | The first number in the range, usually to the left in LTR locales.
  second | The second number in the range, usually to the right in LTR locales.
  status | Set if an error occurs while formatting.

Returns
  A FormattedNumberRange object; call .toString() to get the string.

Stable:
  ICU 63

## ◆ formatImpl()

void icu::number::LocalizedNumberRangeFormatter::formatImpl | ( | impl::UFormattedNumberRangeData & | results,
|  | bool | equalBeforeRounding,
|  | UErrorCode & | status
| ) |  | const

Parameters

  results | The results object. This method will mutate it to save the results.
  equalBeforeRounding | Whether the number was equal before copying it into a DecimalQuantity. Used for determining the identity fallback behavior.
  status | Set if an error occurs while formatting.

Internal:
  Do not use. This API is for internal use only.

## ◆ operator=() [1/2]

LocalizedNumberRangeFormatter & icu::number::LocalizedNumberRangeFormatter::operator= | ( | const LocalizedNumberRangeFormatter & | other | ) |

Copy assignment operator.

Stable:
  ICU 63

## ◆ operator=() [2/2]

LocalizedNumberRangeFormatter & icu::number::LocalizedNumberRangeFormatter::operator= | ( | LocalizedNumberRangeFormatter && | src | ) |
| noexcept

Move assignment operator: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.

Stable:
  ICU 63

## Friends And Related Symbol Documentation

## ◆ NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >

friend class NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >
| friend

Definition at line 568 of file numberrangeformatter.h.

## ◆ NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >

friend class NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >
| friend

Definition at line 568 of file numberrangeformatter.h.

## ◆ UnlocalizedNumberRangeFormatter

friend class UnlocalizedNumberRangeFormatter
| friend

Definition at line 575 of file numberrangeformatter.h.

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

- i18n/unicode/numberrangeformatter.h