OLD | NEW |
1 /* | 1 /* |
2 ********************************************************************************
********* | 2 ********************************************************************************
********* |
3 * Copyright (C) 2013, International Business Machines | 3 * Copyright (C) 2014, International Business Machines |
4 * Corporation and others. All Rights Reserved. | 4 * Corporation and others. All Rights Reserved. |
5 ********************************************************************************
********* | 5 ********************************************************************************
********* |
6 */ | 6 */ |
7 | 7 |
8 #ifndef UDISPLAYCONTEXT_H | 8 #ifndef UDISPLAYCONTEXT_H |
9 #define UDISPLAYCONTEXT_H | 9 #define UDISPLAYCONTEXT_H |
10 | 10 |
11 #include "unicode/utypes.h" | 11 #include "unicode/utypes.h" |
12 | 12 |
13 #if !UCONFIG_NO_FORMATTING | 13 #if !UCONFIG_NO_FORMATTING |
14 | 14 |
15 /* Dont hide with #ifndef U_HIDE_DRAFT_API, needed by virtual methods */ | |
16 /** | 15 /** |
17 * \file | 16 * \file |
18 * \brief C API: Display context types (enum values) | 17 * \brief C API: Display context types (enum values) |
19 */ | 18 */ |
20 | 19 |
21 /** | 20 /** |
22 * Display context types, for getting values of a particular setting. | 21 * Display context types, for getting values of a particular setting. |
23 * Note, the specific numeric values are internal and may change. | 22 * Note, the specific numeric values are internal and may change. |
24 * @draft ICU 51 | 23 * @stable ICU 51 |
25 */ | 24 */ |
26 enum UDisplayContextType { | 25 enum UDisplayContextType { |
27 #ifndef U_HIDE_DRAFT_API | |
28 /** | 26 /** |
29 * Type to retrieve the dialect handling setting, e.g. | 27 * Type to retrieve the dialect handling setting, e.g. |
30 * UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES. | 28 * UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES. |
31 * @draft ICU 51 | 29 * @stable ICU 51 |
32 */ | 30 */ |
33 UDISPCTX_TYPE_DIALECT_HANDLING = 0, | 31 UDISPCTX_TYPE_DIALECT_HANDLING = 0, |
34 /** | 32 /** |
35 * Type to retrieve the capitalization context setting, e.g. | 33 * Type to retrieve the capitalization context setting, e.g. |
36 * UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTE
NCE, | 34 * UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTE
NCE, |
37 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc. | 35 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc. |
38 * @draft ICU 51 | 36 * @stable ICU 51 |
39 */ | 37 */ |
40 UDISPCTX_TYPE_CAPITALIZATION = 1 | 38 UDISPCTX_TYPE_CAPITALIZATION = 1 |
41 #endif /* U_HIDE_DRAFT_API */ | 39 #ifndef U_HIDE_DRAFT_API |
| 40 , |
| 41 /** |
| 42 * Type to retrieve the display length setting, e.g. |
| 43 * UDISPCTX_LENGTH_FULL, UDISPCTX_LENGTH_SHORT. |
| 44 * @draft ICU 54 |
| 45 */ |
| 46 UDISPCTX_TYPE_DISPLAY_LENGTH = 2 |
| 47 #endif /* U_HIDE_DRAFT_API */ |
42 }; | 48 }; |
43 /** | 49 /** |
44 * @draft ICU 51 | 50 * @stable ICU 51 |
45 */ | 51 */ |
46 typedef enum UDisplayContextType UDisplayContextType; | 52 typedef enum UDisplayContextType UDisplayContextType; |
47 | 53 |
48 /* Dont hide with #ifndef U_HIDE_DRAFT_API, needed by virtual methods */ | |
49 /** | 54 /** |
50 * Display context settings. | 55 * Display context settings. |
51 * Note, the specific numeric values are internal and may change. | 56 * Note, the specific numeric values are internal and may change. |
52 * @draft ICU 51 | 57 * @stable ICU 51 |
53 */ | 58 */ |
54 enum UDisplayContext { | 59 enum UDisplayContext { |
55 #ifndef U_HIDE_DRAFT_API | |
56 /** | 60 /** |
57 * ================================ | 61 * ================================ |
58 * DIALECT_HANDLING can be set to one of UDISPCTX_STANDARD_NAMES or | 62 * DIALECT_HANDLING can be set to one of UDISPCTX_STANDARD_NAMES or |
59 * UDISPCTX_DIALECT_NAMES. Use UDisplayContextType UDISPCTX_TYPE_DIALECT_HAN
DLING | 63 * UDISPCTX_DIALECT_NAMES. Use UDisplayContextType UDISPCTX_TYPE_DIALECT_HAN
DLING |
60 * to get the value. | 64 * to get the value. |
61 */ | 65 */ |
62 /** | 66 /** |
63 * A possible setting for DIALECT_HANDLING: | 67 * A possible setting for DIALECT_HANDLING: |
64 * use standard names when generating a locale name, | 68 * use standard names when generating a locale name, |
65 * e.g. en_GB displays as 'English (United Kingdom)'. | 69 * e.g. en_GB displays as 'English (United Kingdom)'. |
66 * @draft ICU 51 | 70 * @stable ICU 51 |
67 */ | 71 */ |
68 UDISPCTX_STANDARD_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 0, | 72 UDISPCTX_STANDARD_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 0, |
69 /** | 73 /** |
70 * A possible setting for DIALECT_HANDLING: | 74 * A possible setting for DIALECT_HANDLING: |
71 * use dialect names, when generating a locale name, | 75 * use dialect names, when generating a locale name, |
72 * e.g. en_GB displays as 'British English'. | 76 * e.g. en_GB displays as 'British English'. |
73 * @draft ICU 51 | 77 * @stable ICU 51 |
74 */ | 78 */ |
75 UDISPCTX_DIALECT_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 1, | 79 UDISPCTX_DIALECT_NAMES = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 1, |
76 /** | 80 /** |
77 * ================================ | 81 * ================================ |
78 * CAPITALIZATION can be set to one of UDISPCTX_CAPITALIZATION_NONE, | 82 * CAPITALIZATION can be set to one of UDISPCTX_CAPITALIZATION_NONE, |
79 * UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE, | 83 * UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE, |
80 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, | 84 * UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, |
81 * UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU, or | 85 * UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU, or |
82 * UDISPCTX_CAPITALIZATION_FOR_STANDALONE. | 86 * UDISPCTX_CAPITALIZATION_FOR_STANDALONE. |
83 * Use UDisplayContextType UDISPCTX_TYPE_CAPITALIZATION to get the value. | 87 * Use UDisplayContextType UDISPCTX_TYPE_CAPITALIZATION to get the value. |
84 */ | 88 */ |
85 /** | 89 /** |
86 * The capitalization context to be used is unknown (this is the default val
ue). | 90 * The capitalization context to be used is unknown (this is the default val
ue). |
87 * @draft ICU 51 | 91 * @stable ICU 51 |
88 */ | 92 */ |
89 UDISPCTX_CAPITALIZATION_NONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 0, | 93 UDISPCTX_CAPITALIZATION_NONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 0, |
90 /** | 94 /** |
91 * The capitalization context if a date, date symbol or display name is to b
e | 95 * The capitalization context if a date, date symbol or display name is to b
e |
92 * formatted with capitalization appropriate for the middle of a sentence. | 96 * formatted with capitalization appropriate for the middle of a sentence. |
93 * @draft ICU 51 | 97 * @stable ICU 51 |
94 */ | 98 */ |
95 UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATI
ON<<8) + 1, | 99 UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZATI
ON<<8) + 1, |
96 /** | 100 /** |
97 * The capitalization context if a date, date symbol or display name is to b
e | 101 * The capitalization context if a date, date symbol or display name is to b
e |
98 * formatted with capitalization appropriate for the beginning of a sentence
. | 102 * formatted with capitalization appropriate for the beginning of a sentence
. |
99 * @draft ICU 51 | 103 * @stable ICU 51 |
100 */ | 104 */ |
101 UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZ
ATION<<8) + 2, | 105 UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE = (UDISPCTX_TYPE_CAPITALIZ
ATION<<8) + 2, |
102 /** | 106 /** |
103 * The capitalization context if a date, date symbol or display name is to b
e | 107 * The capitalization context if a date, date symbol or display name is to b
e |
104 * formatted with capitalization appropriate for a user-interface list or me
nu item. | 108 * formatted with capitalization appropriate for a user-interface list or me
nu item. |
105 * @draft ICU 51 | 109 * @stable ICU 51 |
106 */ | 110 */ |
107 UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU = (UDISPCTX_TYPE_CAPITALIZATION<
<8) + 3, | 111 UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU = (UDISPCTX_TYPE_CAPITALIZATION<
<8) + 3, |
108 /** | 112 /** |
109 * The capitalization context if a date, date symbol or display name is to b
e | 113 * The capitalization context if a date, date symbol or display name is to b
e |
110 * formatted with capitalization appropriate for stand-alone usage such as a
n | 114 * formatted with capitalization appropriate for stand-alone usage such as a
n |
111 * isolated name on a calendar page. | 115 * isolated name on a calendar page. |
112 * @draft ICU 51 | 116 * @stable ICU 51 |
113 */ | 117 */ |
114 UDISPCTX_CAPITALIZATION_FOR_STANDALONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) +
4 | 118 UDISPCTX_CAPITALIZATION_FOR_STANDALONE = (UDISPCTX_TYPE_CAPITALIZATION<<8) +
4 |
115 #endif /* U_HIDE_DRAFT_API */ | 119 #ifndef U_HIDE_DRAFT_API |
| 120 , |
| 121 /** |
| 122 * ================================ |
| 123 * DISPLAY_LENGTH can be set to one of UDISPCTX_LENGTH_FULL or |
| 124 * UDISPCTX_LENGTH_SHORT. Use UDisplayContextType UDISPCTX_TYPE_DISPLAY_LENG
TH |
| 125 * to get the value. |
| 126 */ |
| 127 /** |
| 128 * A possible setting for DISPLAY_LENGTH: |
| 129 * use full names when generating a locale name, |
| 130 * e.g. "United States" for US. |
| 131 * @draft ICU 54 |
| 132 */ |
| 133 UDISPCTX_LENGTH_FULL = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 0, |
| 134 /** |
| 135 * A possible setting for DISPLAY_LENGTH: |
| 136 * use short names when generating a locale name, |
| 137 * e.g. "U.S." for US. |
| 138 * @draft ICU 54 |
| 139 */ |
| 140 UDISPCTX_LENGTH_SHORT = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 1 |
| 141 #endif /* U_HIDE_DRAFT_API */ |
116 }; | 142 }; |
117 /** | 143 /** |
118 * @draft ICU 51 | 144 * @stable ICU 51 |
119 */ | 145 */ |
120 typedef enum UDisplayContext UDisplayContext; | 146 typedef enum UDisplayContext UDisplayContext; |
121 | 147 |
122 #endif /* #if !UCONFIG_NO_FORMATTING */ | 148 #endif /* #if !UCONFIG_NO_FORMATTING */ |
123 | 149 |
124 #endif | 150 #endif |
OLD | NEW |