ICU-531.30.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / udisplaycontext.h

diff --git a/icuSources/i18n/unicode/udisplaycontext.h b/icuSources/i18n/unicode/udisplaycontext.h
index b3ff0af0c554d189f87f6d168a02cdc65daed085..1d0e8a13a051e949140701cdb3439353a2ff1328 100644 (file)
--- a/icuSources/i18n/unicode/udisplaycontext.h
+++ b/icuSources/i18n/unicode/udisplaycontext.h
@@ -1,6 +1,6 @@
 /*
 *****************************************************************************************
-* Copyright (C) 2013, International Business Machines
+* Copyright (C) 2014, International Business Machines
 * Corporation and others. All Rights Reserved.
 *****************************************************************************************
 */
@@ -12,42 +12,52 @@
 
 #if !UCONFIG_NO_FORMATTING
 
-/* Dont hide with #ifndef U_HIDE_DRAFT_API, needed by virtual methods */
+/**
+ * \file
+ * \brief C API: Display context types (enum values)
+ */
+
 /**
  * Display context types, for getting values of a particular setting.
  * Note, the specific numeric values are internal and may change.
- * @draft ICU 51
+ * @stable ICU 51
  */
 enum UDisplayContextType {
-#ifndef U_HIDE_DRAFT_API
     /**
      * Type to retrieve the dialect handling setting, e.g.
      * UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_TYPE_DIALECT_HANDLING = 0,
     /**
      * Type to retrieve the capitalization context setting, e.g.
      * UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE,
      * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc.
-     * @draft ICU 51
+     * @stable ICU 51
+     */
+    UDISPCTX_TYPE_CAPITALIZATION = 1,
+
+#ifndef U_HIDE_INTERNAL_API
+    /**
+     * Type to retrieve the capitalization context setting, e.g.
+     * UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE,
+     * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc.
+     * @internal ICU 54
      */
-    UDISPCTX_TYPE_CAPITALIZATION = 1
-#endif /* U_HIDE_DRAFT_API */
+    UADISPCTX_TYPE_LENGTH = 32,
+#endif /* U_HIDE_INTERNAL_API */
 };
 /**
-*  @draft ICU 51
+*  @stable ICU 51
 */
 typedef enum UDisplayContextType UDisplayContextType;
 
-/* Dont hide with #ifndef U_HIDE_DRAFT_API, needed by virtual methods */
 /**
  * Display context settings.
  * Note, the specific numeric values are internal and may change.
- * @draft ICU 51
+ * @stable ICU 51
  */
 enum UDisplayContext {
-#ifndef U_HIDE_DRAFT_API
     /**
      * ================================
      * DIALECT_HANDLING can be set to one of UDISPCTX_STANDARD_NAMES or
@@ -58,14 +68,14 @@ enum UDisplayContext {
      * A possible setting for DIALECT_HANDLING:
      * use standard names when generating a locale name,
      * e.g. en_GB displays as 'English (United Kingdom)'.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_STANDARD_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 0,
     /**
      * A possible setting for DIALECT_HANDLING:
      * use dialect names, when generating a locale name,
      * e.g. en_GB displays as 'British English'.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_DIALECT_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 1,
     /**
@@ -79,38 +89,60 @@ enum UDisplayContext {
      */
     /**
      * The capitalization context to be used is unknown (this is the default value).
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_CAPITALIZATION_NONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 0,
     /**
      * The capitalization context if a date, date symbol or display name is to be
      * formatted with capitalization appropriate for the middle of a sentence.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 1,
     /**
      * The capitalization context if a date, date symbol or display name is to be
      * formatted with capitalization appropriate for the beginning of a sentence.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 2,
     /**
      * The capitalization context if a date, date symbol or display name is to be
      * formatted with capitalization appropriate for a user-interface list or menu item.
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 3,
     /**
      * The capitalization context if a date, date symbol or display name is to be
      * formatted with capitalization appropriate for stand-alone usage such as an
      * isolated name on a calendar page.
-     * @draft ICU 51
+     * @stable ICU 51
+     */
+    UDISPCTX_CAPITALIZATION_FOR_STANDALONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 4,
+
+#ifndef U_HIDE_INTERNAL_API
+    /**
+     * ================================
+     * LENGTH can be set to one of UADISPCTX_LENGTH_STANDARD or
+     * UADISPCTX_LENGTH_SHORT. Use UDisplayContextType UADISPCTX_TYPE_LENGTH
+     * to get the value.
+     */
+    /**
+     * A possible setting for LENGTH:
+     * use standard length names when generating a locale name.
+     * @internal ICU 54
+     */
+    UADISPCTX_LENGTH_STANDARD = (UADISPCTX_TYPE_LENGTH<<8) + 0,
+    /**
+     * A possible setting for DIALECT_HANDLING:
+     * use short length names (if available) when generating a locale name
+     * (in most cases short names are not available and the standard
+     * name will be used).
+     * @internal ICU 54
      */
-    UDISPCTX_CAPITALIZATION_FOR_STANDALONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 4
-#endif /* U_HIDE_DRAFT_API */
+    UADISPCTX_LENGTH_SHORT = (UADISPCTX_TYPE_LENGTH<<8) + 1,
+#endif /* U_HIDE_INTERNAL_API */
 };
 /**
-*  @draft ICU 51
+*  @stable ICU 51
 */
 typedef enum UDisplayContext UDisplayContext;