ICU 75.1 75.1
Loading...
Searching...
No Matches
formattedvalue.h
Go to the documentation of this file.
1// © 2018 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3
4#ifndef __FORMATTEDVALUE_H__
5#define __FORMATTEDVALUE_H__
6
7#include "unicode/utypes.h"
8
9#if U_SHOW_CPLUSPLUS_API
10
11#if !UCONFIG_NO_FORMATTING
12
13#include "unicode/appendable.h"
14#include "unicode/fpositer.h"
15#include "unicode/unistr.h"
17
18U_NAMESPACE_BEGIN
19
42 public:
43
52
55
64 void reset();
65
89
114
124 inline int32_t getCategory() const {
125 return fCategory;
126 }
127
137 inline int32_t getField() const {
138 return fField;
139 }
140
149 inline int32_t getStart() const {
150 return fStart;
151 }
152
161 inline int32_t getLimit() const {
162 return fLimit;
163 }
164
169
181 return fContext;
182 }
183
193
205
222 int32_t field,
223 int32_t start,
224 int32_t limit);
225
226 private:
227 int64_t fContext = 0LL;
228 int32_t fField = 0;
229 int32_t fStart = 0;
230 int32_t fLimit = 0;
232 int8_t fConstraint = 0;
233};
234
241class U_I18N_API FormattedValue /* not : public UObject because this is an interface/mixin class */ {
242 public:
245
257
273
286
310};
311
313
314#endif /* #if !UCONFIG_NO_FORMATTING */
315
316#endif /* U_SHOW_CPLUSPLUS_API */
317
318#endif // __FORMATTEDVALUE_H__
C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
Base class for objects to which Unicode characters and strings can be appended.
Definition appendable.h:54
Represents a span of a string containing a given field.
void reset()
Resets this ConstrainedFieldPosition to its initial state, as if it were newly created:
void constrainField(int32_t category, int32_t field)
Sets a constraint on the category and field.
void setState(int32_t category, int32_t field, int32_t start, int32_t limit)
Sets new values for the primary public getters.
int32_t getStart() const
Gets the INCLUSIVE start index for the current position.
void constrainCategory(int32_t category)
Sets a constraint on the field category.
int32_t getCategory() const
Gets the field category for the current position.
int32_t getLimit() const
Gets the EXCLUSIVE end index stored for the current position.
ConstrainedFieldPosition()
Initializes a ConstrainedFieldPosition.
void setInt64IterationContext(int64_t context)
Sets an int64 that FormattedValue implementations may use for storage.
int64_t getInt64IterationContext() const
Gets an int64 that FormattedValue implementations may use for storage.
int32_t getField() const
Gets the field for the current position.
UBool matchesField(int32_t category, int32_t field) const
Determines whether a given field should be included given the constraints.
An abstract formatted value: a string with associated field attributes.
virtual UBool nextPosition(ConstrainedFieldPosition &cfpos, UErrorCode &status) const =0
Iterates over field positions in the FormattedValue.
virtual Appendable & appendTo(Appendable &appendable, UErrorCode &status) const =0
Appends the formatted string to an Appendable.
virtual UnicodeString toString(UErrorCode &status) const =0
Returns the formatted string as a self-contained UnicodeString.
virtual UnicodeString toTempString(UErrorCode &status) const =0
Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
virtual ~FormattedValue()
"Smart pointer" base class; do not use directly: use LocalPointer etc.
UMemory is the common ICU base class.
Definition uobject.h:115
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
C++ API: FieldPosition Iterator.
C API: Abstract operations for localized strings.
@ UFIELD_CATEGORY_UNDEFINED
For an undefined field category.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
C++ API: Unicode String.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301