ICU 75.1 75.1
|
An immutable class containing the result of a list formatting operation. More...
#include <listformatter.h>
Public Member Functions | |
FormattedList () | |
Default constructor; makes an empty FormattedList. | |
FormattedList (FormattedList &&src) noexcept | |
Move constructor: Leaves the source FormattedList in an undefined state. | |
virtual | ~FormattedList () override |
Destruct an instance of FormattedList. | |
FormattedList (const FormattedList &)=delete | |
Copying not supported; use move constructor instead. | |
FormattedList & | operator= (const FormattedList &)=delete |
Copying not supported; use move assignment instead. | |
FormattedList & | operator= (FormattedList &&src) noexcept |
Move assignment: Leaves the source FormattedList in an undefined state. | |
UnicodeString | toString (UErrorCode &status) const override |
Returns the formatted string as a self-contained UnicodeString. | |
UnicodeString | toTempString (UErrorCode &status) const override |
Returns the formatted string as a read-only alias to memory owned by the FormattedValue. | |
Appendable & | appendTo (Appendable &appendable, UErrorCode &status) const override |
Appends the formatted string to an Appendable. | |
UBool | nextPosition (ConstrainedFieldPosition &cfpos, UErrorCode &status) const override |
Iterates over field positions in the FormattedValue. | |
Public Member Functions inherited from icu::FormattedValue | |
virtual | ~FormattedValue () |
Friends | |
class | ListFormatter |
An immutable class containing the result of a list formatting operation.
Instances of this class are immutable and thread-safe.
When calling nextPosition(): The fields are returned from start to end. The special field category UFIELD_CATEGORY_LIST_SPAN is used to indicate which argument was inserted at the given position. The span category will always occur before the corresponding instance of UFIELD_CATEGORY_LIST in the nextPosition() iterator.
Not intended for public subclassing.
Definition at line 86 of file listformatter.h.
|
inline |
Default constructor; makes an empty FormattedList.
Definition at line 92 of file listformatter.h.
|
noexcept |
Move constructor: Leaves the source FormattedList in an undefined state.
|
overridevirtual |
Destruct an instance of FormattedList.
|
overridevirtual |
Appends the formatted string to an Appendable.
appendable | The Appendable to which to append the string output. |
status | Set if an error occurs. |
Implements icu::FormattedValue.
|
overridevirtual |
Iterates over field positions in the FormattedValue.
This lets you determine the position of specific types of substrings, like a month or a decimal separator.
To loop over all field positions:
ConstrainedFieldPosition cfpos; while (fmtval.nextPosition(cfpos, status)) { // handle the field position; get information from cfpos }
cfpos | The object used for iteration state. This can provide constraints to iterate over only one specific category or field; see ConstrainedFieldPosition::constrainCategory and ConstrainedFieldPosition::constrainField. |
status | Set if an error occurs. |
Implements icu::FormattedValue.
|
noexcept |
Move assignment: Leaves the source FormattedList in an undefined state.
|
overridevirtual |
Returns the formatted string as a self-contained UnicodeString.
If you need the string within the current scope only, consider toTempString.
status | Set if an error occurs. |
Implements icu::FormattedValue.
|
overridevirtual |
Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
The return value is valid only as long as this FormattedValue is present and unchanged in memory. If you need the string outside the current scope, consider toString.
The buffer returned by calling UnicodeString::getBuffer() on the return value is guaranteed to be NUL-terminated.
status | Set if an error occurs. |
Implements icu::FormattedValue.
|
friend |
Definition at line 137 of file listformatter.h.