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
U_I18N_API 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.
U_I18N_API UnlocalizedNumberRangeFormatter	withoutLocale () const &
	Disassociate the locale from this formatter.
U_I18N_API UnlocalizedNumberRangeFormatter	withoutLocale () &&
	Overload of withoutLocale() for use on an rvalue reference.
U_I18N_API	LocalizedNumberRangeFormatter ()=default
	Default constructor: puts the formatter into a valid but undefined state.
U_I18N_API	LocalizedNumberRangeFormatter (const LocalizedNumberRangeFormatter &other)
	Returns a copy of this LocalizedNumberRangeFormatter.
U_I18N_API	LocalizedNumberRangeFormatter (LocalizedNumberRangeFormatter &&src) noexcept
	Move constructor: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.
U_I18N_API LocalizedNumberRangeFormatter &	operator= (const LocalizedNumberRangeFormatter &other)
	Copy assignment operator.
U_I18N_API LocalizedNumberRangeFormatter &	operator= (LocalizedNumberRangeFormatter &&src) noexcept
	Move assignment operator: The source LocalizedNumberRangeFormatter will be left in a valid but undefined state.
U_I18N_API void	formatImpl (impl::UFormattedNumberRangeData &results, bool equalBeforeRounding, UErrorCode &status) const
U_I18N_API	~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	numberFormatterFirst (const UnlocalizedNumberFormatter &formatterFirst) const &
	Sets the NumberFormatter instance to use for the first number in the range.
LocalizedNumberRangeFormatter	numberFormatterSecond (const UnlocalizedNumberFormatter &formatterSecond) const &
	Sets the NumberFormatter instance to use for the second number in the range.
LocalizedNumberRangeFormatter	collapse (UNumberRangeCollapse collapse) const &
	Sets the aggressiveness of "collapsing" fields across the range separator.
LocalizedNumberRangeFormatter	identityFallback (UNumberRangeIdentityFallback identityFallback) const &
	Sets the behavior when the two sides of the range are the same.
LocalPointer< LocalizedNumberRangeFormatter >	clone () const &
	Returns the current (Un)LocalizedNumberRangeFormatter as a LocalPointer wrapping a heap-allocated copy of the current object.
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 471 of file numberrangeformatter.h.

Constructor & Destructor Documentation

◆ LocalizedNumberRangeFormatter() [1/3]

U_I18N_API icu::number::LocalizedNumberRangeFormatter::LocalizedNumberRangeFormatter ( )

default

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

Stable: ICU 63

References LocalizedNumberRangeFormatter(), and U_I18N_API.

Referenced by LocalizedNumberRangeFormatter(), LocalizedNumberRangeFormatter(), LocalizedNumberRangeFormatter(), operator=(), and operator=().

◆ LocalizedNumberRangeFormatter() [2/3]

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

Returns a copy of this LocalizedNumberRangeFormatter.

Stable: ICU 63

References LocalizedNumberRangeFormatter(), and U_I18N_API.

◆ LocalizedNumberRangeFormatter() [3/3]

U_I18N_API icu::number::LocalizedNumberRangeFormatter::LocalizedNumberRangeFormatter ( LocalizedNumberRangeFormatter && src )

noexcept

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

Stable: ICU 63

References LocalizedNumberRangeFormatter(), and U_I18N_API.

◆ ~LocalizedNumberRangeFormatter()

U_I18N_API icu::number::LocalizedNumberRangeFormatter::~LocalizedNumberRangeFormatter ( )

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

Stable: ICU 63

References U_I18N_API.

Member Function Documentation

◆ formatFormattableRange()

U_I18N_API 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

References U_I18N_API.

◆ formatImpl()

U_I18N_API 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.

References U_I18N_API.

◆ operator=() [1/2]

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

Copy assignment operator.

Stable: ICU 63

References LocalizedNumberRangeFormatter(), and U_I18N_API.

◆ operator=() [2/2]

U_I18N_API 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

References LocalizedNumberRangeFormatter(), and U_I18N_API.

◆ withoutLocale() [1/2]

U_I18N_API UnlocalizedNumberRangeFormatter icu::number::LocalizedNumberRangeFormatter::withoutLocale ( ) &&

Overload of withoutLocale() for use on an rvalue reference.

Returns: The fluent chain.

See also: withoutLocale

Stable: ICU 75

References U_I18N_API, and withoutLocale().

◆ withoutLocale() [2/2]

U_I18N_API UnlocalizedNumberRangeFormatter icu::number::LocalizedNumberRangeFormatter::withoutLocale ( ) const &

Disassociate the locale from this formatter.

Returns: The fluent chain.

Stable: ICU 75

References U_I18N_API.

Referenced by withoutLocale().

◆ NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >

friend class NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >

friend

Definition at line 576 of file numberrangeformatter.h.

◆ NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >

friend class NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >

friend

Definition at line 576 of file numberrangeformatter.h.

◆ UnlocalizedNumberRangeFormatter

friend class UnlocalizedNumberRangeFormatter

friend

Definition at line 583 of file numberrangeformatter.h.

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

i18n/unicode/numberrangeformatter.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LocalizedNumberRangeFormatter() [1/3]

◆ LocalizedNumberRangeFormatter() [2/3]

◆ LocalizedNumberRangeFormatter() [3/3]

◆ ~LocalizedNumberRangeFormatter()

Member Function Documentation

◆ formatFormattableRange()

◆ formatImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ withoutLocale() [1/2]

◆ withoutLocale() [2/2]

Friends And Related Symbol Documentation

◆ NumberRangeFormatterSettings< LocalizedNumberRangeFormatter >

◆ NumberRangeFormatterSettings< UnlocalizedNumberRangeFormatter >

◆ UnlocalizedNumberRangeFormatter