ICU 75.1 75.1

udisplayoptions.h
Go to the documentation of this file.
1 // © 2022 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3
4 #ifndef __UDISPLAYOPTIONS_H__
5 #define __UDISPLAYOPTIONS_H__
6
7 #include "unicode/utypes.h"
8
9 #if !UCONFIG_NO_FORMATTING
10
19 #include "unicode/uversion.h"
20
26 typedef enum UDisplayOptionsGrammaticalCase {
32 UDISPOPT_GRAMMATICAL_CASE_UNDEFINED = 0,
34 UDISPOPT_GRAMMATICAL_CASE_ABLATIVE = 1,
36 UDISPOPT_GRAMMATICAL_CASE_ACCUSATIVE = 2,
38 UDISPOPT_GRAMMATICAL_CASE_COMITATIVE = 3,
40 UDISPOPT_GRAMMATICAL_CASE_DATIVE = 4,
42 UDISPOPT_GRAMMATICAL_CASE_ERGATIVE = 5,
44 UDISPOPT_GRAMMATICAL_CASE_GENITIVE = 6,
46 UDISPOPT_GRAMMATICAL_CASE_INSTRUMENTAL = 7,
48 UDISPOPT_GRAMMATICAL_CASE_LOCATIVE = 8,
50 UDISPOPT_GRAMMATICAL_CASE_LOCATIVE_COPULATIVE = 9,
52 UDISPOPT_GRAMMATICAL_CASE_NOMINATIVE = 10,
54 UDISPOPT_GRAMMATICAL_CASE_OBLIQUE = 11,
56 UDISPOPT_GRAMMATICAL_CASE_PREPOSITIONAL = 12,
58 UDISPOPT_GRAMMATICAL_CASE_SOCIATIVE = 13,
60 UDISPOPT_GRAMMATICAL_CASE_VOCATIVE = 14,
61 } UDisplayOptionsGrammaticalCase;
62
69 U_CAPI const char * U_EXPORT2
70 udispopt_getGrammaticalCaseIdentifier(UDisplayOptionsGrammaticalCase grammaticalCase);
71
78 U_CAPI UDisplayOptionsGrammaticalCase U_EXPORT2
79 udispopt_fromGrammaticalCaseIdentifier(const char *identifier);
80
87 typedef enum UDisplayOptionsPluralCategory {
88
95 UDISPOPT_PLURAL_CATEGORY_UNDEFINED = 0,
97 UDISPOPT_PLURAL_CATEGORY_ZERO = 1,
99 UDISPOPT_PLURAL_CATEGORY_ONE = 2,
101 UDISPOPT_PLURAL_CATEGORY_TWO = 3,
103 UDISPOPT_PLURAL_CATEGORY_FEW = 4,
105 UDISPOPT_PLURAL_CATEGORY_MANY = 5,
107 UDISPOPT_PLURAL_CATEGORY_OTHER = 6,
108 } UDisplayOptionsPluralCategory;
109
116 U_CAPI const char * U_EXPORT2
117 udispopt_getPluralCategoryIdentifier(UDisplayOptionsPluralCategory pluralCategory);
118
126 U_CAPI UDisplayOptionsPluralCategory U_EXPORT2
127 udispopt_fromPluralCategoryIdentifier(const char *identifier);
128
134 typedef enum UDisplayOptionsNounClass {
141 UDISPOPT_NOUN_CLASS_UNDEFINED = 0,
143 UDISPOPT_NOUN_CLASS_OTHER = 1,
145 UDISPOPT_NOUN_CLASS_NEUTER = 2,
147 UDISPOPT_NOUN_CLASS_FEMININE = 3,
149 UDISPOPT_NOUN_CLASS_MASCULINE = 4,
151 UDISPOPT_NOUN_CLASS_ANIMATE = 5,
153 UDISPOPT_NOUN_CLASS_INANIMATE = 6,
155 UDISPOPT_NOUN_CLASS_PERSONAL = 7,
157 UDISPOPT_NOUN_CLASS_COMMON = 8,
158 } UDisplayOptionsNounClass;
159
166 U_CAPI const char * U_EXPORT2
167 udispopt_getNounClassIdentifier(UDisplayOptionsNounClass nounClass);
168
175 U_CAPI UDisplayOptionsNounClass U_EXPORT2
176 udispopt_fromNounClassIdentifier(const char *identifier);
177
183 typedef enum UDisplayOptionsCapitalization {
190 UDISPOPT_CAPITALIZATION_UNDEFINED = 0,
191
198 UDISPOPT_CAPITALIZATION_BEGINNING_OF_SENTENCE = 1,
199
206 UDISPOPT_CAPITALIZATION_MIDDLE_OF_SENTENCE = 2,
207
215 UDISPOPT_CAPITALIZATION_STANDALONE = 3,
216
223 UDISPOPT_CAPITALIZATION_UI_LIST_OR_MENU = 4,
224 } UDisplayOptionsCapitalization;
225
231 typedef enum UDisplayOptionsNameStyle {
238 UDISPOPT_NAME_STYLE_UNDEFINED = 0,
239
246 UDISPOPT_NAME_STYLE_STANDARD_NAMES = 1,
247
254 UDISPOPT_NAME_STYLE_DIALECT_NAMES = 2,
255 } UDisplayOptionsNameStyle;
256
262 typedef enum UDisplayOptionsDisplayLength {
269 UDISPOPT_DISPLAY_LENGTH_UNDEFINED = 0,
270
277 UDISPOPT_DISPLAY_LENGTH_FULL = 1,
278
285 UDISPOPT_DISPLAY_LENGTH_SHORT = 2,
286 } UDisplayOptionsDisplayLength;
287
293 typedef enum UDisplayOptionsSubstituteHandling {
294
301 UDISPOPT_SUBSTITUTE_HANDLING_UNDEFINED = 0,
302
309 UDISPOPT_SUBSTITUTE_HANDLING_SUBSTITUTE = 1,
310
316 UDISPOPT_SUBSTITUTE_HANDLING_NO_SUBSTITUTE = 2,
317 } UDisplayOptionsSubstituteHandling;
318
319 #endif /* #if !UCONFIG_NO_FORMATTING */
320
321 #endif // __UDISPLAYOPTIONS_H__
udispopt_getGrammaticalCaseIdentifier
U_CAPI const char * udispopt_getGrammaticalCaseIdentifier(UDisplayOptionsGrammaticalCase grammaticalCase)
udispopt_fromNounClassIdentifier
U_CAPI UDisplayOptionsNounClass udispopt_fromNounClassIdentifier(const char *identifier)
UDisplayOptionsCapitalization
UDisplayOptionsCapitalization
Represents all the capitalization options.
Definition: udisplayoptions.h:183
UDISPOPT_CAPITALIZATION_UI_LIST_OR_MENU
@ UDISPOPT_CAPITALIZATION_UI_LIST_OR_MENU
The capitalization context if a date, date symbol or display name is to be formatted with capitalizat...
Definition: udisplayoptions.h:223
UDISPOPT_CAPITALIZATION_UNDEFINED
@ UDISPOPT_CAPITALIZATION_UNDEFINED
A possible setting for Capitalization.
Definition: udisplayoptions.h:190
UDISPOPT_CAPITALIZATION_STANDALONE
@ UDISPOPT_CAPITALIZATION_STANDALONE
The capitalization context if a date, date symbol or display name is to be formatted with capitalizat...
Definition: udisplayoptions.h:215
UDISPOPT_CAPITALIZATION_BEGINNING_OF_SENTENCE
@ UDISPOPT_CAPITALIZATION_BEGINNING_OF_SENTENCE
The capitalization context if a date, date symbol or display name is to be formatted with capitalizat...
Definition: udisplayoptions.h:198
UDISPOPT_CAPITALIZATION_MIDDLE_OF_SENTENCE
@ UDISPOPT_CAPITALIZATION_MIDDLE_OF_SENTENCE
The capitalization context if a date, date symbol or display name is to be formatted with capitalizat...
Definition: udisplayoptions.h:206
udispopt_fromGrammaticalCaseIdentifier
U_CAPI UDisplayOptionsGrammaticalCase udispopt_fromGrammaticalCaseIdentifier(const char *identifier)
UDisplayOptionsSubstituteHandling
UDisplayOptionsSubstituteHandling
Represents all the substitute handling.
Definition: udisplayoptions.h:293
UDISPOPT_SUBSTITUTE_HANDLING_NO_SUBSTITUTE
@ UDISPOPT_SUBSTITUTE_HANDLING_NO_SUBSTITUTE
Returns a null value when no data is available.
Definition: udisplayoptions.h:316
UDISPOPT_SUBSTITUTE_HANDLING_SUBSTITUTE
@ UDISPOPT_SUBSTITUTE_HANDLING_SUBSTITUTE
Returns a fallback value (e.g., the input code) when no data is available.
Definition: udisplayoptions.h:309
UDISPOPT_SUBSTITUTE_HANDLING_UNDEFINED
@ UDISPOPT_SUBSTITUTE_HANDLING_UNDEFINED
A possible setting for SubstituteHandling.
Definition: udisplayoptions.h:301
UDisplayOptionsPluralCategory
UDisplayOptionsPluralCategory
Standard CLDR plural form/category constants.
Definition: udisplayoptions.h:87
UDISPOPT_PLURAL_CATEGORY_FEW
@ UDISPOPT_PLURAL_CATEGORY_FEW
Definition: udisplayoptions.h:103
UDISPOPT_PLURAL_CATEGORY_ZERO
@ UDISPOPT_PLURAL_CATEGORY_ZERO
Definition: udisplayoptions.h:97
UDISPOPT_PLURAL_CATEGORY_ONE
@ UDISPOPT_PLURAL_CATEGORY_ONE
Definition: udisplayoptions.h:99
UDISPOPT_PLURAL_CATEGORY_MANY
@ UDISPOPT_PLURAL_CATEGORY_MANY
Definition: udisplayoptions.h:105
UDISPOPT_PLURAL_CATEGORY_OTHER
@ UDISPOPT_PLURAL_CATEGORY_OTHER
Definition: udisplayoptions.h:107
UDISPOPT_PLURAL_CATEGORY_UNDEFINED
@ UDISPOPT_PLURAL_CATEGORY_UNDEFINED
A possible setting for PluralCategory.
Definition: udisplayoptions.h:95
UDISPOPT_PLURAL_CATEGORY_TWO
@ UDISPOPT_PLURAL_CATEGORY_TWO
Definition: udisplayoptions.h:101
udispopt_getPluralCategoryIdentifier
U_CAPI const char * udispopt_getPluralCategoryIdentifier(UDisplayOptionsPluralCategory pluralCategory)
udispopt_fromPluralCategoryIdentifier
U_CAPI UDisplayOptionsPluralCategory udispopt_fromPluralCategoryIdentifier(const char *identifier)
UDisplayOptionsGrammaticalCase
UDisplayOptionsGrammaticalCase
Represents all the grammatical cases that are supported by CLDR.
Definition: udisplayoptions.h:26
UDISPOPT_GRAMMATICAL_CASE_ACCUSATIVE
@ UDISPOPT_GRAMMATICAL_CASE_ACCUSATIVE
Definition: udisplayoptions.h:36
UDISPOPT_GRAMMATICAL_CASE_LOCATIVE_COPULATIVE
@ UDISPOPT_GRAMMATICAL_CASE_LOCATIVE_COPULATIVE
Definition: udisplayoptions.h:50
UDISPOPT_GRAMMATICAL_CASE_PREPOSITIONAL
@ UDISPOPT_GRAMMATICAL_CASE_PREPOSITIONAL
Definition: udisplayoptions.h:56
UDISPOPT_GRAMMATICAL_CASE_OBLIQUE
@ UDISPOPT_GRAMMATICAL_CASE_OBLIQUE
Definition: udisplayoptions.h:54
UDISPOPT_GRAMMATICAL_CASE_ERGATIVE
@ UDISPOPT_GRAMMATICAL_CASE_ERGATIVE
Definition: udisplayoptions.h:42
UDISPOPT_GRAMMATICAL_CASE_COMITATIVE
@ UDISPOPT_GRAMMATICAL_CASE_COMITATIVE
Definition: udisplayoptions.h:38
UDISPOPT_GRAMMATICAL_CASE_NOMINATIVE
@ UDISPOPT_GRAMMATICAL_CASE_NOMINATIVE
Definition: udisplayoptions.h:52
UDISPOPT_GRAMMATICAL_CASE_GENITIVE
@ UDISPOPT_GRAMMATICAL_CASE_GENITIVE
Definition: udisplayoptions.h:44
UDISPOPT_GRAMMATICAL_CASE_UNDEFINED
@ UDISPOPT_GRAMMATICAL_CASE_UNDEFINED
A possible setting for GrammaticalCase.
Definition: udisplayoptions.h:32
UDISPOPT_GRAMMATICAL_CASE_SOCIATIVE
@ UDISPOPT_GRAMMATICAL_CASE_SOCIATIVE
Definition: udisplayoptions.h:58
UDISPOPT_GRAMMATICAL_CASE_INSTRUMENTAL
@ UDISPOPT_GRAMMATICAL_CASE_INSTRUMENTAL
Definition: udisplayoptions.h:46
UDISPOPT_GRAMMATICAL_CASE_LOCATIVE
@ UDISPOPT_GRAMMATICAL_CASE_LOCATIVE
Definition: udisplayoptions.h:48
UDISPOPT_GRAMMATICAL_CASE_DATIVE
@ UDISPOPT_GRAMMATICAL_CASE_DATIVE
Definition: udisplayoptions.h:40
UDISPOPT_GRAMMATICAL_CASE_ABLATIVE
@ UDISPOPT_GRAMMATICAL_CASE_ABLATIVE
Definition: udisplayoptions.h:34
UDISPOPT_GRAMMATICAL_CASE_VOCATIVE
@ UDISPOPT_GRAMMATICAL_CASE_VOCATIVE
Definition: udisplayoptions.h:60
UDisplayOptionsNameStyle
UDisplayOptionsNameStyle
Represents all the dialect handlings.
Definition: udisplayoptions.h:231
UDISPOPT_NAME_STYLE_STANDARD_NAMES
@ UDISPOPT_NAME_STYLE_STANDARD_NAMES
Use standard names when generating a locale name, e.g.
Definition: udisplayoptions.h:246
UDISPOPT_NAME_STYLE_UNDEFINED
@ UDISPOPT_NAME_STYLE_UNDEFINED
A possible setting for NameStyle.
Definition: udisplayoptions.h:238
UDISPOPT_NAME_STYLE_DIALECT_NAMES
@ UDISPOPT_NAME_STYLE_DIALECT_NAMES
Use dialect names, when generating a locale name, e.g.
Definition: udisplayoptions.h:254
UDisplayOptionsNounClass
UDisplayOptionsNounClass
Represents all the grammatical noun classes that are supported by CLDR.
Definition: udisplayoptions.h:134
UDISPOPT_NOUN_CLASS_COMMON
@ UDISPOPT_NOUN_CLASS_COMMON
Definition: udisplayoptions.h:157
UDISPOPT_NOUN_CLASS_MASCULINE
@ UDISPOPT_NOUN_CLASS_MASCULINE
Definition: udisplayoptions.h:149
UDISPOPT_NOUN_CLASS_NEUTER
@ UDISPOPT_NOUN_CLASS_NEUTER
Definition: udisplayoptions.h:145
UDISPOPT_NOUN_CLASS_UNDEFINED
@ UDISPOPT_NOUN_CLASS_UNDEFINED
A possible setting for NounClass.
Definition: udisplayoptions.h:141
UDISPOPT_NOUN_CLASS_FEMININE
@ UDISPOPT_NOUN_CLASS_FEMININE
Definition: udisplayoptions.h:147
UDISPOPT_NOUN_CLASS_OTHER
@ UDISPOPT_NOUN_CLASS_OTHER
Definition: udisplayoptions.h:143
UDISPOPT_NOUN_CLASS_INANIMATE
@ UDISPOPT_NOUN_CLASS_INANIMATE
Definition: udisplayoptions.h:153
UDISPOPT_NOUN_CLASS_PERSONAL
@ UDISPOPT_NOUN_CLASS_PERSONAL
Definition: udisplayoptions.h:155
UDISPOPT_NOUN_CLASS_ANIMATE
@ UDISPOPT_NOUN_CLASS_ANIMATE
Definition: udisplayoptions.h:151
UDisplayOptionsDisplayLength
UDisplayOptionsDisplayLength
Represents all the display lengths.
Definition: udisplayoptions.h:262
UDISPOPT_DISPLAY_LENGTH_SHORT
@ UDISPOPT_DISPLAY_LENGTH_SHORT
Use short names when generating a locale name, e.g.
Definition: udisplayoptions.h:285
UDISPOPT_DISPLAY_LENGTH_UNDEFINED
@ UDISPOPT_DISPLAY_LENGTH_UNDEFINED
A possible setting for DisplayLength.
Definition: udisplayoptions.h:269
UDISPOPT_DISPLAY_LENGTH_FULL
@ UDISPOPT_DISPLAY_LENGTH_FULL
Uses full names when generating a locale name, e.g.
Definition: udisplayoptions.h:277
udispopt_getNounClassIdentifier
U_CAPI const char * udispopt_getNounClassIdentifier(UDisplayOptionsNounClass nounClass)
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
uversion.h
C API: API for accessing ICU version numbers.