<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!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"/> <title>ICU 4.4.1: locdspnm.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.6.2-20100208 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> <ul> <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"> <img id="MSearchSelect" src="search/search.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)"/> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </div> </li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <h1>locdspnm.h</h1><a href="locdspnm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment">******************************************************************************</span> <a name="l00003"></a>00003 <span class="comment">* Copyright (C) 2010, International Business Machines Corporation and *</span> <a name="l00004"></a>00004 <span class="comment">* others. All Rights Reserved. *</span> <a name="l00005"></a>00005 <span class="comment">******************************************************************************</span> <a name="l00006"></a>00006 <span class="comment">*/</span> <a name="l00007"></a>00007 <a name="l00008"></a>00008 <span class="preprocessor">#ifndef LOCDSPNM_H</span> <a name="l00009"></a>00009 <span class="preprocessor"></span><span class="preprocessor">#define LOCDSPNM_H</span> <a name="l00010"></a>00010 <span class="preprocessor"></span> <a name="l00011"></a>00011 <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> <a name="l00012"></a>00012 <a name="l00018"></a>00018 <span class="preprocessor">#if !UCONFIG_NO_FORMATTING</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="locid_8h.html" title="C++ API: Locale ID object.">unicode/locid.h</a>"</span> <a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="uscript_8h.html" title="C API: Unicode Script Information.">unicode/uscript.h</a>"</span> <a name="l00022"></a>00022 <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> <a name="l00023"></a>00023 <a name="l00024"></a>00024 <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> <a name="l00025"></a>00025 <a name="l00032"></a><a class="code" href="classLocaleDisplayNames.html">00032</a> <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...">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 &quot;boilerplate&quot; class.">UObject</a> { <a name="l00033"></a>00033 <span class="keyword">public</span>: <a name="l00038"></a>00038 <span class="keyword">virtual</span> ~<a class="code" href="classLocaleDisplayNames.html" title="Returns display names of Locales and components of Locales.">LocaleDisplayNames</a>(); <a name="l00039"></a>00039 <a name="l00048"></a>00048 <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); <a name="l00049"></a>00049 <a name="l00060"></a>00060 <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, <a name="l00061"></a>00061 <a class="code" href="uldnames_8h.html#a58e81da2dab7974bee76ced91d606d14" title="Enum used in LocaleDisplayNames::createInstance.">UDialectHandling</a> dialectHandling); <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="comment">// getters for state</span> <a name="l00070"></a>00070 <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; <a name="l00071"></a>00071 <a name="l00077"></a>00077 <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; <a name="l00078"></a>00078 <a name="l00079"></a>00079 <span class="comment">// names for entire locales</span> <a name="l00087"></a>00087 <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...">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, <a name="l00088"></a>00088 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00089"></a>00089 <a name="l00097"></a>00097 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& localeDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* localeId, <a name="l00098"></a>00098 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00099"></a>00099 <a name="l00100"></a>00100 <span class="comment">// names for components of a locale id</span> <a name="l00108"></a>00108 <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...">UnicodeString</a>& languageDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* lang, <a name="l00109"></a>00109 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00110"></a>00110 <a name="l00118"></a>00118 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& scriptDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* script, <a name="l00119"></a>00119 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00120"></a>00120 <a name="l00128"></a>00128 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& scriptDisplayName(<a class="code" href="uscript_8h.html#a5036ff9ca2a7f1d2bde07875bb235df0" title="Constants for ISO 15924 script codes.">UScriptCode</a> scriptCode, <a name="l00129"></a>00129 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00130"></a>00130 <a name="l00138"></a>00138 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& regionDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* region, <a name="l00139"></a>00139 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00140"></a>00140 <a name="l00148"></a>00148 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& variantDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* variant, <a name="l00149"></a>00149 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00150"></a>00150 <a name="l00158"></a>00158 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& keyDisplayName(<span class="keyword">const</span> <span class="keywordtype">char</span>* key, <a name="l00159"></a>00159 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00160"></a>00160 <a name="l00169"></a>00169 <span class="keyword">virtual</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">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, <a name="l00170"></a>00170 <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& result) <span class="keyword">const</span> = 0; <a name="l00171"></a>00171 <a name="l00177"></a>00177 <span class="keyword">static</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...">UClassID</a> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> getStaticClassID(); <a name="l00178"></a>00178 }; <a name="l00179"></a>00179 <a name="l00180"></a><a class="code" href="classLocaleDisplayNames.html#a907375bb3d2909ab26f9e418be5b4135">00180</a> <span class="keyword">inline</span> <a class="code" href="classLocaleDisplayNames.html#a907375bb3d2909ab26f9e418be5b4135" title="Destructor.">LocaleDisplayNames::~LocaleDisplayNames</a>() { <a name="l00181"></a>00181 } <a name="l00182"></a>00182 <a name="l00183"></a><a class="code" href="classLocaleDisplayNames.html#ae19434e3d5619c51ff6fdc8ce65e739c">00183</a> <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&amp; locale, UDialectHandling...">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) { <a name="l00184"></a>00184 <span class="keywordflow">return</span> <a class="code" href="classLocaleDisplayNames.html#ae19434e3d5619c51ff6fdc8ce65e739c" title="Convenience overload of createInstance(const Locale&amp; locale, UDialectHandling...">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>); <a name="l00185"></a>00185 } <a name="l00186"></a>00186 <a name="l00187"></a>00187 <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> <a name="l00188"></a>00188 <a name="l00189"></a>00189 <span class="preprocessor">#endif</span> <a name="l00190"></a>00190 <span class="preprocessor"></span> <a name="l00191"></a>00191 <span class="preprocessor">#endif</span> </pre></div></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>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>