<!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"/> <title>ICU 4.8.1.1: 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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">ICU 4.8.1.1  <span id="projectnumber">4.8.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.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">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (C) 2010-2011, International Business Machines Corporation and *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* others. All Rights Reserved. *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">******************************************************************************</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*/</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef LOCDSPNM_H</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span><span class="preprocessor">#define LOCDSPNM_H</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#if !UCONFIG_NO_FORMATTING</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="locid_8h.html" title="C++ API: Locale ID object.">unicode/locid.h</a>"</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="uscript_8h.html" title="C API: Unicode Script Information.">unicode/uscript.h</a>"</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="uldnames_8h.html" title="C++ API: Provides display names of Locale ids and their components.">unicode/uldnames.h</a>"</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="classLocaleDisplayNames.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a" title="Set to export library symbols from inside the i18n library, and to import them from outside...">U_I18N_API</a> <a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a> : <span class="keyword">public</span> <a class="code" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> {</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> ~<a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a>();</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">static</span> <a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a>* <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> createInstance(<span class="keyword">const</span> <a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>& locale);</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">static</span> <a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a>* <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> createInstance(<span class="keyword">const</span> <a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>& locale,</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14" title="Enum used in LocaleDisplayNames::createInstance.">UDialectHandling</a> dialectHandling);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// getters for state</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>& getLocale() <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14" title="Enum used in LocaleDisplayNames::createInstance.">UDialectHandling</a> getDialectHandling() <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// names for entire locales</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& localeDisplayName(<span class="keyword">const</span> <a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>& locale,</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& localeDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* localeId,</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// names for components of a locale id</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& languageDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* lang,</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& scriptDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* script,</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& scriptDisplayName(<a class="code" href="uscript_8h.html#a5036ff9ca2a7f1d2bde07875bb235df0" title="Constants for ISO 15924 script codes.">UScriptCode</a> scriptCode,</div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& regionDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* region,</div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& variantDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* variant,</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& keyDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* key,</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">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="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& result) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// No ICU "poor man's RTTI" for this class nor its subclasses.</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">virtual</span> <a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">UClassID</a> <a class="code" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262" title="ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.">getDynamicClassID</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> };</div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div> <div class="line"><a name="l00177"></a><span class="lineno"><a class="code" href="classLocaleDisplayNames.html#a907375bb3d2909ab26f9e418be5b4135"> 177</a></span> <span class="keyword">inline</span> <a class="code" href="classLocaleDisplayNames.html#a907375bb3d2909ab26f9e418be5b4135" title="Destructor.">LocaleDisplayNames::~LocaleDisplayNames</a>() {</div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> }</div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div> <div class="line"><a name="l00180"></a><span class="lineno"><a class="code" href="classLocaleDisplayNames.html#ae19434e3d5619c51ff6fdc8ce65e739c"> 180</a></span> <span class="keyword">inline</span> <a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a>* <a class="code" href="classLocaleDisplayNames.html#ae19434e3d5619c51ff6fdc8ce65e739c" title="Convenience overload of createInstance(const Locale& locale, UDialectHandling dialectHandling) that s...">LocaleDisplayNames::createInstance</a>(<span class="keyword">const</span> <a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>& locale) {</div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordflow">return</span> <a class="code" href="classLocaleDisplayNames.html#ae19434e3d5619c51ff6fdc8ce65e739c" title="Convenience overload of createInstance(const Locale& locale, UDialectHandling dialectHandling) that s...">LocaleDisplayNames::createInstance</a>(locale, <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14abb213ffc174039aeb301f90fbff91540" title="Use standard names when generating a locale name, e.g.">ULDN_STANDARD_NAMES</a>);</div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> }</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a></div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#endif</span></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.1.1 </small></address> </body> </html>