icuSources/common/unicode/udisplaycontext.h

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