<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: locdspnm.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">locdspnm.h</div> </div> </div><!--header--> <div class="contents"> <a href="locdspnm_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Copyright (C) 2010-2016, International Business Machines Corporation and</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* others. All Rights Reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">*/</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef LOCDSPNM_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define LOCDSPNM_H</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#if !UCONFIG_NO_FORMATTING</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="locid_8h.html">unicode/locid.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="uscript_8h.html">unicode/uscript.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="uldnames_8h.html">unicode/uldnames.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="udisplaycontext_8h.html">unicode/udisplaycontext.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classicu_1_1LocaleDisplayNames.html"> 35</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UObject.html">UObject</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">static</span> <a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a>* U_EXPORT2 createInstance(<span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& locale);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a>* U_EXPORT2 createInstance(<span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& locale,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14">UDialectHandling</a> dialectHandling);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a>* U_EXPORT2 createInstance(<span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& locale,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a> *contexts, int32_t length);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// getters for state</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& getLocale() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14">UDialectHandling</a> getDialectHandling() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <a class="code" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a> getContext(<a class="code" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a> type) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">// names for entire locales</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& localeDisplayName(<span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& locale,</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& localeDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* localeId,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">// names for components of a locale id</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& languageDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* lang,</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& scriptDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* script,</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& scriptDisplayName(<a class="code" href="uscript_8h.html#a5036ff9ca2a7f1d2bde07875bb235df0">UScriptCode</a> scriptCode,</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& regionDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* region,</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& variantDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* variant,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& keyDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* key,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& keyValueDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* value,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> };</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="classicu_1_1LocaleDisplayNames.html#ac2f530dab90946f8dfb542a7f9ad6875"> 198</a></span> <span class="keyword">inline</span> <a class="code" href="classicu_1_1LocaleDisplayNames.html">LocaleDisplayNames</a>* <a class="code" href="classicu_1_1LocaleDisplayNames.html#ac2f530dab90946f8dfb542a7f9ad6875">LocaleDisplayNames::createInstance</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1Locale.html">Locale</a>& locale) {</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordflow">return</span> <a class="code" href="classicu_1_1LocaleDisplayNames.html#ac2f530dab90946f8dfb542a7f9ad6875">LocaleDisplayNames::createInstance</a>(locale, <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14abb213ffc174039aeb301f90fbff91540">ULDN_STANDARD_NAMES</a>);</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> }</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classicu_1_1LocaleDisplayNames_html_ac2f530dab90946f8dfb542a7f9ad6875"><div class="ttname"><a href="classicu_1_1LocaleDisplayNames.html#ac2f530dab90946f8dfb542a7f9ad6875">icu::LocaleDisplayNames::createInstance</a></div><div class="ttdeci">static LocaleDisplayNames * createInstance(const Locale &locale)</div><div class="ttdoc">Convenience overload of createInstance(const Locale& locale, UDialectHandling dialectHandling) that s...</div><div class="ttdef"><b>Definition:</b> <a href="locdspnm_8h_source.html#l00198">locdspnm.h:198</a></div></div> <div class="ttc" id="udisplaycontext_8h_html_ac80aa1aceff6c7ad2e9f983a19d8d868"><div class="ttname"><a href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a></div><div class="ttdeci">UDisplayContext</div><div class="ttdoc">Display context settings. </div><div class="ttdef"><b>Definition:</b> <a href="udisplaycontext_8h_source.html#l00066">udisplaycontext.h:66</a></div></div> <div class="ttc" id="uscript_8h_html_a5036ff9ca2a7f1d2bde07875bb235df0"><div class="ttname"><a href="uscript_8h.html#a5036ff9ca2a7f1d2bde07875bb235df0">UScriptCode</a></div><div class="ttdeci">UScriptCode</div><div class="ttdoc">Constants for ISO 15924 script codes. </div><div class="ttdef"><b>Definition:</b> <a href="uscript_8h_source.html#l00054">uscript.h:54</a></div></div> <div class="ttc" id="udisplaycontext_8h_html"><div class="ttname"><a href="udisplaycontext_8h.html">udisplaycontext.h</a></div><div class="ttdoc">C API: Display context types (enum values) </div></div> <div class="ttc" id="uscript_8h_html"><div class="ttname"><a href="uscript_8h.html">uscript.h</a></div><div class="ttdoc">C API: Unicode Script Information. </div></div> <div class="ttc" id="uversion_8h_html_a7d9374e037299886d4192b763b4c5e8b"><div class="ttname"><a href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define U_NAMESPACE_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00131">uversion.h:131</a></div></div> <div class="ttc" id="uldnames_8h_html_a58e81da2dab7974bee76ced91d606d14abb213ffc174039aeb301f90fbff91540"><div class="ttname"><a href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14abb213ffc174039aeb301f90fbff91540">ULDN_STANDARD_NAMES</a></div><div class="ttdoc">Use standard names when generating a locale name, e.g. </div><div class="ttdef"><b>Definition:</b> <a href="uldnames_8h_source.html#l00033">uldnames.h:33</a></div></div> <div class="ttc" id="uldnames_8h_html_a58e81da2dab7974bee76ced91d606d14"><div class="ttname"><a href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14">UDialectHandling</a></div><div class="ttdeci">UDialectHandling</div><div class="ttdoc">Enum used in LocaleDisplayNames::createInstance. </div><div class="ttdef"><b>Definition:</b> <a href="uldnames_8h_source.html#l00027">uldnames.h:27</a></div></div> <div class="ttc" id="uversion_8h_html_a3da1f00f3b02976ac53c014a3e4c0933"><div class="ttname"><a href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="ttdeci">#define U_NAMESPACE_END</div><div class="ttdoc">This is used to end a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00132">uversion.h:132</a></div></div> <div class="ttc" id="udisplaycontext_8h_html_a7ce674e7cd26fb195f7344b861af5427"><div class="ttname"><a href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a></div><div class="ttdeci">UDisplayContextType</div><div class="ttdoc">Display context types, for getting values of a particular setting. </div><div class="ttdef"><b>Definition:</b> <a href="udisplaycontext_8h_source.html#l00027">udisplaycontext.h:27</a></div></div> <div class="ttc" id="locid_8h_html"><div class="ttname"><a href="locid_8h.html">locid.h</a></div><div class="ttdoc">C++ API: Locale ID object. </div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> <div class="ttc" id="utypes_8h_html_a559955ec3bc692657c5d8b1c6de8e334"><div class="ttname"><a href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a></div><div class="ttdeci">#define U_COMMON_API</div><div class="ttdoc">Set to export library symbols from inside the common library, and to import them from outside...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00359">utypes.h:359</a></div></div> <div class="ttc" id="classicu_1_1UnicodeString_html"><div class="ttname"><a href="classicu_1_1UnicodeString.html">icu::UnicodeString</a></div><div class="ttdoc">UnicodeString is a string class that stores Unicode characters directly and provides similar function...</div><div class="ttdef"><b>Definition:</b> <a href="unistr_8h_source.html#l00295">unistr.h:295</a></div></div> <div class="ttc" id="classicu_1_1LocaleDisplayNames_html"><div class="ttname"><a href="classicu_1_1LocaleDisplayNames.html">icu::LocaleDisplayNames</a></div><div class="ttdoc">Returns display names of Locales and components of Locales. </div><div class="ttdef"><b>Definition:</b> <a href="locdspnm_8h_source.html#l00035">locdspnm.h:35</a></div></div> <div class="ttc" id="classicu_1_1UObject_html"><div class="ttname"><a href="classicu_1_1UObject.html">icu::UObject</a></div><div class="ttdoc">UObject is the common ICU "boilerplate" class. </div><div class="ttdef"><b>Definition:</b> <a href="uobject_8h_source.html#l00223">uobject.h:223</a></div></div> <div class="ttc" id="uldnames_8h_html"><div class="ttname"><a href="uldnames_8h.html">uldnames.h</a></div><div class="ttdoc">C API: Provides display names of Locale ids and their components. </div></div> <div class="ttc" id="classicu_1_1Locale_html"><div class="ttname"><a href="classicu_1_1Locale.html">icu::Locale</a></div><div class="ttdoc">A Locale object represents a specific geographical, political, or cultural region. </div><div class="ttdef"><b>Definition:</b> <a href="locid_8h_source.html#l00187">locid.h:187</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>