|
ICU 76.1 76.1
|
An immutable class for formatting a list, using data from CLDR (or supplied separately). More...
#include <listformatter.h>
Public Member Functions | |
| ListFormatter (const ListFormatter &) | |
| Copy constructor. | |
| ListFormatter & | operator= (const ListFormatter &other) |
| Assignment operator. | |
| virtual | ~ListFormatter () |
| Destructor. | |
| UnicodeString & | format (const UnicodeString items[], int32_t n_items, UnicodeString &appendTo, UErrorCode &errorCode) const |
| Formats a list of strings. | |
| FormattedList | formatStringsToValue (const UnicodeString items[], int32_t n_items, UErrorCode &errorCode) const |
| Formats a list of strings to a FormattedList, which exposes field position information. | |
| UnicodeString & | format (const UnicodeString items[], int32_t n_items, UnicodeString &appendTo, int32_t index, int32_t &offset, UErrorCode &errorCode) const |
| ListFormatter (const ListFormatData &data, UErrorCode &errorCode) | |
| ListFormatter (const ListFormatInternal *listFormatterInternal) | |
Public Member Functions inherited from icu::UObject | |
| virtual | ~UObject () |
| Destructor. | |
| virtual UClassID | getDynamicClassID () const |
| ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. | |
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, UListFormatterType type, UListFormatterWidth width, UErrorCode &errorCode) |
| Creates a ListFormatter for the given locale, list type, and style. | |
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.
Definition at line 151 of file listformatter.h.
| icu::ListFormatter::ListFormatter | ( | const ListFormatter & | ) |
Copy constructor.
|
virtual |
Destructor.
| icu::ListFormatter::ListFormatter | ( | const ListFormatData & | data, |
| UErrorCode & | errorCode ) |
| icu::ListFormatter::ListFormatter | ( | const ListFormatInternal * | listFormatterInternal | ) |
|
static |
Creates a ListFormatter appropriate for a locale.
| locale | The locale. |
| errorCode | ICU error code, set if no data available for the given locale. |
|
static |
Creates a ListFormatter for the given locale, list type, and style.
| locale | The locale. |
| type | The type of list formatting to use. |
| width | The width of formatting to use. |
| errorCode | ICU error code, set if no data available for the given locale. |
|
static |
Creates a ListFormatter appropriate for the default locale.
| errorCode | ICU error code, set if no data available for default locale. |
| UnicodeString & icu::ListFormatter::format | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UnicodeString & | appendTo, | ||
| int32_t | index, | ||
| int32_t & | offset, | ||
| UErrorCode & | errorCode ) const |
| UnicodeString & icu::ListFormatter::format | ( | const UnicodeString | items[], |
| int32_t | n_items, | ||
| UnicodeString & | appendTo, | ||
| UErrorCode & | errorCode ) const |
Formats a list of strings.
| 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. |
| 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.
| items | An array of strings to be combined and formatted. |
| n_items | Length of the array items. |
| errorCode | ICU error code returned here. |
| ListFormatter & icu::ListFormatter::operator= | ( | const ListFormatter & | other | ) |
Assignment operator.