An immutable class for formatting a list, using data from CLDR (or supplied separately). More...
#include <listformatter.h>
Inheritance diagram for icu::ListFormatter:
Public Member Functions inherited from Static Public Member Functions | |
| static ListFormatter * | createInstance (UErrorCode &errorCode) |
| Creates a ListFormatter appropriate for the default locale. | |
| static ListFormatter * | createInstance (const Locale &locale, UErrorCode &errorCode) |
| Creates a ListFormatter appropriate for a locale. | |
| static ListFormatter * | createInstance (const Locale &locale, const char *style, UErrorCode &errorCode) |
| Creates a ListFormatter appropriate for a locale and style. | |
Detailed Description
An immutable class for formatting a list, using data from CLDR (or supplied separately).
Example: Input data ["Alice", "Bob", "Charlie", "Delta"] will be formatted as "Alice, Bob, Charlie and Delta" in English.
The ListFormatter class is not intended for public subclassing.
- Stable:
- ICU 50
Definition at line 151 of file listformatter.h.
Constructor & Destructor Documentation
◆ ListFormatter() [1/3]
| icu::ListFormatter::ListFormatter | ( | const ListFormatter & | ) |
Copy constructor.
- Stable:
- ICU 52
◆ ~ListFormatter()
◆ ListFormatter() [2/3]
| icu::ListFormatter::ListFormatter | ( | const ListFormatData & | data, |
| UErrorCode & | errorCode | ||
| ) |
- Internal:
- Do not use. This API is for internal use only. constructor made public for testing.
◆ ListFormatter() [3/3]
| icu::ListFormatter::ListFormatter | ( | const ListFormatInternal * | listFormatterInternal | ) |
- Internal:
- Do not use. This API is for internal use only. constructor made public for testing.
Member Function Documentation
◆ createInstance() [1/3]
|
static |
Creates a ListFormatter appropriate for a locale and style.
- Parameters
-
locale The locale. style the style, either "standard", "or", "unit", "unit-narrow", or "unit-short" errorCode ICU error code, set if no data available for the given locale.
- Returns
- A ListFormatter object created from internal data derived from CLDR data.
- Internal:
- Do not use. This API is for internal use only.
◆ createInstance() [2/3]
|
static |
Creates a ListFormatter appropriate for a locale.
- Parameters
-
locale The locale. errorCode ICU error code, set if no data available for the given locale.
- Returns
- A ListFormatter object created from internal data derived from CLDR data.
- Stable:
- ICU 50
◆ createInstance() [3/3]
|
static |
Creates a ListFormatter appropriate for the default locale.
- Parameters
-
errorCode ICU error code, set if no data available for default locale.
- Returns
- Pointer to a ListFormatter object for the default locale, created from internal data derived from CLDR data.
- Stable:
- ICU 50
◆ format() [1/3]
| UnicodeString & icu::ListFormatter::format | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UnicodeString & | appendTo, | ||
| FieldPositionIterator * | posIter, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Format a list of strings.
- Parameters
-
items An array of strings to be combined and formatted. n_items Length of the array items. appendTo The string to which the formatted result will be appended. posIter On return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UListFormatterField. Can be NULL. errorCode ICU error code returned here.
- Returns
- Formatted string combining the elements of items, appended to appendTo.
- Draft:
- This API may be changed in the future versions and was introduced in ICU 63
◆ format() [2/3]
| UnicodeString & icu::ListFormatter::format | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UnicodeString & | appendTo, | ||
| int32_t | index, | ||
| int32_t & | offset, | ||
| UErrorCode & | errorCode | ||
| ) | const |
- Internal:
- Do not use. This API is for internal use only. for MeasureFormat
◆ format() [3/3]
| UnicodeString & icu::ListFormatter::format | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UnicodeString & | appendTo, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Formats a list of strings.
- Parameters
-
items An array of strings to be combined and formatted. n_items Length of the array items. appendTo The string to which the result should be appended to. errorCode ICU error code, set if there is an error.
- Returns
- Formatted string combining the elements of items, appended to appendTo.
- Stable:
- ICU 50
◆ formatStringsToValue()
| FormattedList icu::ListFormatter::formatStringsToValue | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Formats a list of strings to a FormattedList, which exposes field position information.
The FormattedList contains more information than a FieldPositionIterator.
- Parameters
-
items An array of strings to be combined and formatted. n_items Length of the array items. errorCode ICU error code returned here.
- Returns
- A FormattedList containing field information.
- Draft:
- This API may be changed in the future versions and was introduced in ICU 64
◆ operator=()
| ListFormatter & icu::ListFormatter::operator= | ( | const ListFormatter & | other | ) |
Assignment operator.
- Stable:
- ICU 52
The documentation for this class was generated from the following file:
