ICU 66.1 66.1
ulistformatter.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*****************************************************************************************
5* Copyright (C) 2015-2016, International Business Machines
6* Corporation and others. All Rights Reserved.
7*****************************************************************************************
8*/
9
10#ifndef ULISTFORMATTER_H
11#define ULISTFORMATTER_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_FORMATTING
16
19
34struct UListFormatter;
37#ifndef U_HIDE_DRAFT_API
38struct UFormattedList;
44#endif /* U_HIDE_DRAFT_API */
45
46#ifndef U_HIDE_DRAFT_API
52typedef enum UListFormatterField {
64#endif /* U_HIDE_DRAFT_API */
65
82U_CAPI UListFormatter* U_EXPORT2
83ulistfmt_open(const char* locale,
84 UErrorCode* status);
85
92U_CAPI void U_EXPORT2
94
95#ifndef U_HIDE_DRAFT_API
105U_CAPI UFormattedList* U_EXPORT2
107
129U_CAPI const UFormattedValue* U_EXPORT2
131
138U_CAPI void U_EXPORT2
140#endif /* U_HIDE_DRAFT_API */
141
142
143#if U_SHOW_CPLUSPLUS_API
144
145U_NAMESPACE_BEGIN
146
157
158#ifndef U_HIDE_DRAFT_API
169#endif /* U_HIDE_DRAFT_API */
170
171U_NAMESPACE_END
172
173#endif
174
209U_CAPI int32_t U_EXPORT2
211 const UChar* const strings[],
212 const int32_t * stringLengths,
213 int32_t stringCount,
214 UChar* result,
215 int32_t resultCapacity,
216 UErrorCode* status);
217
218#ifndef U_HIDE_DRAFT_API
245U_CAPI void U_EXPORT2
247 const UListFormatter* listfmt,
248 const UChar* const strings[],
249 const int32_t * stringLengths,
250 int32_t stringCount,
251 UFormattedList* uresult,
252 UErrorCode* status);
253#endif /* U_HIDE_DRAFT_API */
254
255#endif /* #if !UCONFIG_NO_FORMATTING */
256
257#endif
"Smart pointer" class, closes a UFormattedList via ulistfmt_closeResult().
"Smart pointer" class, closes a UListFormatter via ulistfmt_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:562
C API: Abstract operations for localized strings.
struct UFormattedValue UFormattedValue
An abstract formatted value: a string with associated field attributes.
U_CAPI const UFormattedValue * ulistfmt_resultAsValue(const UFormattedList *uresult, UErrorCode *ec)
Returns a representation of a UFormattedList as a UFormattedValue, which can be subsequently passed t...
U_CAPI void ulistfmt_closeResult(UFormattedList *uresult)
Releases the UFormattedList created by ulistfmt_openResult().
U_CAPI UListFormatter * ulistfmt_open(const char *locale, UErrorCode *status)
Open a new UListFormatter object using the rules for a given locale.
struct UListFormatter UListFormatter
C typedef for struct UListFormatter.
U_CAPI void ulistfmt_formatStringsToResult(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UFormattedList *uresult, UErrorCode *status)
Formats a list of strings to a UFormattedList, which exposes more information than the string exporte...
U_CAPI UFormattedList * ulistfmt_openResult(UErrorCode *ec)
Creates an object to hold the result of a UListFormatter operation.
struct UFormattedList UFormattedList
Opaque struct to contain the results of a UListFormatter operation.
UListFormatterField
FieldPosition and UFieldPosition selectors for format fields defined by ListFormatter.
@ ULISTFMT_ELEMENT_FIELD
The element text in the result which came from the input strings.
@ ULISTFMT_LITERAL_FIELD
The literal text in the result which came from the resources.
U_CAPI int32_t ulistfmt_format(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UChar *result, int32_t resultCapacity, UErrorCode *status)
Formats a list of strings using the conventions established for the UListFormatter object.
U_CAPI void ulistfmt_close(UListFormatter *listfmt)
Close a UListFormatter object.
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:109
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:378
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415