Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/udisplaycontext.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 // © 2016 and later: Unicode, Inc. and others.
jpayne@69 2 // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69 3 /*
jpayne@69 4 *****************************************************************************************
jpayne@69 5 * Copyright (C) 2014-2016, International Business Machines
jpayne@69 6 * Corporation and others. All Rights Reserved.
jpayne@69 7 *****************************************************************************************
jpayne@69 8 */
jpayne@69 9
jpayne@69 10 #ifndef UDISPLAYCONTEXT_H
jpayne@69 11 #define UDISPLAYCONTEXT_H
jpayne@69 12
jpayne@69 13 #include "unicode/utypes.h"
jpayne@69 14
jpayne@69 15 #if !UCONFIG_NO_FORMATTING
jpayne@69 16
jpayne@69 17 /**
jpayne@69 18 * \file
jpayne@69 19 * \brief C API: Display context types (enum values)
jpayne@69 20 */
jpayne@69 21
jpayne@69 22 /**
jpayne@69 23 * Display context types, for getting values of a particular setting.
jpayne@69 24 * Note, the specific numeric values are internal and may change.
jpayne@69 25 * @stable ICU 51
jpayne@69 26 */
jpayne@69 27 enum UDisplayContextType {
jpayne@69 28 /**
jpayne@69 29 * Type to retrieve the dialect handling setting, e.g.
jpayne@69 30 * UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES.
jpayne@69 31 * @stable ICU 51
jpayne@69 32 */
jpayne@69 33 UDISPCTX_TYPE_DIALECT_HANDLING = 0,
jpayne@69 34 /**
jpayne@69 35 * Type to retrieve the capitalization context setting, e.g.
jpayne@69 36 * UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE,
jpayne@69 37 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc.
jpayne@69 38 * @stable ICU 51
jpayne@69 39 */
jpayne@69 40 UDISPCTX_TYPE_CAPITALIZATION = 1,
jpayne@69 41 /**
jpayne@69 42 * Type to retrieve the display length setting, e.g.
jpayne@69 43 * UDISPCTX_LENGTH_FULL, UDISPCTX_LENGTH_SHORT.
jpayne@69 44 * @stable ICU 54
jpayne@69 45 */
jpayne@69 46 UDISPCTX_TYPE_DISPLAY_LENGTH = 2,
jpayne@69 47 /**
jpayne@69 48 * Type to retrieve the substitute handling setting, e.g.
jpayne@69 49 * UDISPCTX_SUBSTITUTE, UDISPCTX_NO_SUBSTITUTE.
jpayne@69 50 * @stable ICU 58
jpayne@69 51 */
jpayne@69 52 UDISPCTX_TYPE_SUBSTITUTE_HANDLING = 3
jpayne@69 53 };
jpayne@69 54 /**
jpayne@69 55 * @stable ICU 51
jpayne@69 56 */
jpayne@69 57 typedef enum UDisplayContextType UDisplayContextType;
jpayne@69 58
jpayne@69 59 /**
jpayne@69 60 * Display context settings.
jpayne@69 61 * Note, the specific numeric values are internal and may change.
jpayne@69 62 * @stable ICU 51
jpayne@69 63 */
jpayne@69 64 enum UDisplayContext {
jpayne@69 65 /**
jpayne@69 66 * ================================
jpayne@69 67 * DIALECT_HANDLING can be set to one of UDISPCTX_STANDARD_NAMES or
jpayne@69 68 * UDISPCTX_DIALECT_NAMES. Use UDisplayContextType UDISPCTX_TYPE_DIALECT_HANDLING
jpayne@69 69 * to get the value.
jpayne@69 70 */
jpayne@69 71 /**
jpayne@69 72 * A possible setting for DIALECT_HANDLING:
jpayne@69 73 * use standard names when generating a locale name,
jpayne@69 74 * e.g. en_GB displays as 'English (United Kingdom)'.
jpayne@69 75 * @stable ICU 51
jpayne@69 76 */
jpayne@69 77 UDISPCTX_STANDARD_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 0,
jpayne@69 78 /**
jpayne@69 79 * A possible setting for DIALECT_HANDLING:
jpayne@69 80 * use dialect names, when generating a locale name,
jpayne@69 81 * e.g. en_GB displays as 'British English'.
jpayne@69 82 * @stable ICU 51
jpayne@69 83 */
jpayne@69 84 UDISPCTX_DIALECT_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 1,
jpayne@69 85 /**
jpayne@69 86 * ================================
jpayne@69 87 * CAPITALIZATION can be set to one of UDISPCTX_CAPITALIZATION_NONE,
jpayne@69 88 * UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE,
jpayne@69 89 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE,
jpayne@69 90 * UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU, or
jpayne@69 91 * UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
jpayne@69 92 * Use UDisplayContextType UDISPCTX_TYPE_CAPITALIZATION to get the value.
jpayne@69 93 */
jpayne@69 94 /**
jpayne@69 95 * The capitalization context to be used is unknown (this is the default value).
jpayne@69 96 * @stable ICU 51
jpayne@69 97 */
jpayne@69 98 UDISPCTX_CAPITALIZATION_NONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 0,
jpayne@69 99 /**
jpayne@69 100 * The capitalization context if a date, date symbol or display name is to be
jpayne@69 101 * formatted with capitalization appropriate for the middle of a sentence.
jpayne@69 102 * @stable ICU 51
jpayne@69 103 */
jpayne@69 104 UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 1,
jpayne@69 105 /**
jpayne@69 106 * The capitalization context if a date, date symbol or display name is to be
jpayne@69 107 * formatted with capitalization appropriate for the beginning of a sentence.
jpayne@69 108 * @stable ICU 51
jpayne@69 109 */
jpayne@69 110 UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 2,
jpayne@69 111 /**
jpayne@69 112 * The capitalization context if a date, date symbol or display name is to be
jpayne@69 113 * formatted with capitalization appropriate for a user-interface list or menu item.
jpayne@69 114 * @stable ICU 51
jpayne@69 115 */
jpayne@69 116 UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 3,
jpayne@69 117 /**
jpayne@69 118 * The capitalization context if a date, date symbol or display name is to be
jpayne@69 119 * formatted with capitalization appropriate for stand-alone usage such as an
jpayne@69 120 * isolated name on a calendar page.
jpayne@69 121 * @stable ICU 51
jpayne@69 122 */
jpayne@69 123 UDISPCTX_CAPITALIZATION_FOR_STANDALONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 4,
jpayne@69 124 /**
jpayne@69 125 * ================================
jpayne@69 126 * DISPLAY_LENGTH can be set to one of UDISPCTX_LENGTH_FULL or
jpayne@69 127 * UDISPCTX_LENGTH_SHORT. Use UDisplayContextType UDISPCTX_TYPE_DISPLAY_LENGTH
jpayne@69 128 * to get the value.
jpayne@69 129 */
jpayne@69 130 /**
jpayne@69 131 * A possible setting for DISPLAY_LENGTH:
jpayne@69 132 * use full names when generating a locale name,
jpayne@69 133 * e.g. "United States" for US.
jpayne@69 134 * @stable ICU 54
jpayne@69 135 */
jpayne@69 136 UDISPCTX_LENGTH_FULL = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 0,
jpayne@69 137 /**
jpayne@69 138 * A possible setting for DISPLAY_LENGTH:
jpayne@69 139 * use short names when generating a locale name,
jpayne@69 140 * e.g. "U.S." for US.
jpayne@69 141 * @stable ICU 54
jpayne@69 142 */
jpayne@69 143 UDISPCTX_LENGTH_SHORT = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 1,
jpayne@69 144 /**
jpayne@69 145 * ================================
jpayne@69 146 * SUBSTITUTE_HANDLING can be set to one of UDISPCTX_SUBSTITUTE or
jpayne@69 147 * UDISPCTX_NO_SUBSTITUTE. Use UDisplayContextType UDISPCTX_TYPE_SUBSTITUTE_HANDLING
jpayne@69 148 * to get the value.
jpayne@69 149 */
jpayne@69 150 /**
jpayne@69 151 * A possible setting for SUBSTITUTE_HANDLING:
jpayne@69 152 * Returns a fallback value (e.g., the input code) when no data is available.
jpayne@69 153 * This is the default value.
jpayne@69 154 * @stable ICU 58
jpayne@69 155 */
jpayne@69 156 UDISPCTX_SUBSTITUTE = (UDISPCTX_TYPE_SUBSTITUTE_HANDLING<<8) + 0,
jpayne@69 157 /**
jpayne@69 158 * A possible setting for SUBSTITUTE_HANDLING:
jpayne@69 159 * Returns a null value when no data is available.
jpayne@69 160 * @stable ICU 58
jpayne@69 161 */
jpayne@69 162 UDISPCTX_NO_SUBSTITUTE = (UDISPCTX_TYPE_SUBSTITUTE_HANDLING<<8) + 1
jpayne@69 163
jpayne@69 164 };
jpayne@69 165 /**
jpayne@69 166 * @stable ICU 51
jpayne@69 167 */
jpayne@69 168 typedef enum UDisplayContext UDisplayContext;
jpayne@69 169
jpayne@69 170 #endif /* #if !UCONFIG_NO_FORMATTING */
jpayne@69 171
jpayne@69 172 #endif