<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: Locale Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<h1>Locale Class Reference</h1><!-- doxytag: class="Locale" --><!-- doxytag: inherits="UObject" -->A <code><a class="el" href="classLocale.html">Locale</a></code> object represents a specific geographical, political, or cultural region.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="locid_8h-source.html">locid.h</a>></code>
<p>
<p>Inheritance diagram for Locale:
<p><center><img src="classLocale.png" usemap="#Locale_map" border="0" alt=""></center>
<map name="Locale_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,66,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,66,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#599d7bb7a08b138cb069e39987846b3f">Locale</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a default locale object, a <a class="el" href="classLocale.html">Locale</a> for the default locale ID. <a href="#599d7bb7a08b138cb069e39987846b3f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2e847ff3c5df01b077293a30347bac11">Locale</a> (const char *language, const char *country=0, const char *variant=0, const char *keywordsAndValues=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a locale from language, country, variant. <a href="#2e847ff3c5df01b077293a30347bac11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#b7a2e36b993dfec56609f03348309172">Locale</a> (const <a class="el" href="classLocale.html">Locale</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes a <a class="el" href="classLocale.html">Locale</a> object from another <a class="el" href="classLocale.html">Locale</a> object. <a href="#b7a2e36b993dfec56609f03348309172"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#69855afaa3627ce0003ca5e5946af10e">~Locale</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#69855afaa3627ce0003ca5e5946af10e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1ba398b2e0c47460cbe953ce82510139">operator=</a> (const <a class="el" href="classLocale.html">Locale</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces the entire contents of *this with the specified value. <a href="#1ba398b2e0c47460cbe953ce82510139"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#bba7de6311743eb2e42757dca2f89a27">operator==</a> (const <a class="el" href="classLocale.html">Locale</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if two locale keys are the same. <a href="#bba7de6311743eb2e42757dca2f89a27"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#15114dcd2b70f2c98cc066e5ac83e62c">operator!=</a> (const <a class="el" href="classLocale.html">Locale</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if two locale keys are not the same. <a href="#15114dcd2b70f2c98cc066e5ac83e62c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLocale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#ad1470cf8d756ff9d5c6568e5177dd02">clone</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this object. <a href="#ad1470cf8d756ff9d5c6568e5177dd02"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#868a4c5256cc7fd3842e858ba301bce2">getLanguage</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale's ISO-639 language code. <a href="#868a4c5256cc7fd3842e858ba301bce2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#00dbacc57dfc06f9b4239065052f6f14">getScript</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale's ISO-15924 abbreviation script code. <a href="#00dbacc57dfc06f9b4239065052f6f14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#45b9210463e93b810216e2677d9c155f">getCountry</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale's ISO-3166 country code. <a href="#45b9210463e93b810216e2677d9c155f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#6c668e76f2a39c2fe8f17f1654a7df8f">getVariant</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale's variant code. <a href="#6c668e76f2a39c2fe8f17f1654a7df8f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#f8b5b6d6367062eda70c4a2cade02a67">getName</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars. <a href="#f8b5b6d6367062eda70c4a2cade02a67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#a9df185d761d40c75b5577a5415229cd">getBaseName</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the programmatic name of the entire locale as getName would return, but without keywords. <a href="#a9df185d761d40c75b5577a5415229cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#dba19931d9cbda3d0b6a7817617f13f5">createKeywords</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of keywords for the specified locale. <a href="#dba19931d9cbda3d0b6a7817617f13f5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#fd5dc6a5db78d87dad58e5423bbff0d9">getKeywordValue</a> (const char *keywordName, char *buffer, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> bufferCapacity, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value for a keyword. <a href="#fd5dc6a5db78d87dad58e5423bbff0d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c38eb45e0834b86b2ecd0516470a9c05">getISO3Language</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the locale's three-letter language code, as specified in ISO draft standard ISO-639-2. <a href="#c38eb45e0834b86b2ecd0516470a9c05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2c37bacceb782f9b0e39891974d0b7b5">getISO3Country</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "name" with the locale's three-letter ISO-3166 country code. <a href="#2c37bacceb782f9b0e39891974d0b7b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#8f91b5cc02e8ed0f4cf0fc68bc492ae1">getLCID</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the Windows LCID value corresponding to this locale. <a href="#8f91b5cc02e8ed0f4cf0fc68bc492ae1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#4f4fb7e6d07f39da0898421980a4003c">getDisplayLanguage</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &dispLang) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the default locale. <a href="#4f4fb7e6d07f39da0898421980a4003c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#6cc4a17115b6a553f6ddd94464a99c2b">getDisplayLanguage</a> (const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &dispLang) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the locale specified by "displayLocale". <a href="#6cc4a17115b6a553f6ddd94464a99c2b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c36cf3275f9677e1bd00831d6e6a5ca3">getDisplayScript</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &dispScript) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispScript" with the name of this locale's script in a format suitable for user display in the default locale. <a href="#c36cf3275f9677e1bd00831d6e6a5ca3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2b7db83a1c33606bda56a3f1202f363d">getDisplayScript</a> (const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &dispScript) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispScript" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale". <a href="#2b7db83a1c33606bda56a3f1202f363d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2b24f12c2e527b8f0e75a1314f6ae5de">getDisplayCountry</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &dispCountry) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the default locale. <a href="#2b24f12c2e527b8f0e75a1314f6ae5de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#ea34011e8cc92c985ab1f54342eed4c3">getDisplayCountry</a> (const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &dispCountry) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale". <a href="#ea34011e8cc92c985ab1f54342eed4c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#32f560c91588f6823be49ec8bbbfe302">getDisplayVariant</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &dispVar) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the default locale. <a href="#32f560c91588f6823be49ec8bbbfe302"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#e4923d12044b090bca3ead5e0044d2ff">getDisplayVariant</a> (const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &dispVar) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the locale specified by "displayLocale". <a href="#e4923d12044b090bca3ead5e0044d2ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#3c23fa119d789f1a2a4d3cab0f7caa49">getDisplayName</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &name) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "name" with the name of this locale in a format suitable for user display in the default locale. <a href="#3c23fa119d789f1a2a4d3cab0f7caa49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1935ea040dab51999196c0bf89e87d99">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills in "name" with the name of this locale in a format suitable for user display in the locale specfied by "displayLocale". <a href="#1935ea040dab51999196c0bf89e87d99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#664433180261f7b97a7a1a83ca3dfe78">hashCode</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates a hash code for the locale. <a href="#664433180261f7b97a7a1a83ca3dfe78"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#4cb8b5e11ac02fedc83e9b23bfc5da70">setToBogus</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the locale to bogus A bogus locale represents a non-existing locale associated with services that can be instantiated from non-locale data in addition to locale (for example, collation can be instantiated from a locale and from a rule set). <a href="#4cb8b5e11ac02fedc83e9b23bfc5da70"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c671e591506f640ac36b5943230aeb18">isBogus</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the bogus state. <a href="#c671e591506f640ac36b5943230aeb18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#09cf70b7f4397a78df56a8c1ba9a2ccf">getDynamicClassID</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#09cf70b7f4397a78df56a8c1ba9a2ccf"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#669ca7c4ef168a75879bc2e847f151dd">getEnglish</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#669ca7c4ef168a75879bc2e847f151dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c4577a88016e7111bd37906c136951c7">getFrench</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#c4577a88016e7111bd37906c136951c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#018ee898b7223c3b4cb3385d0f10464d">getGerman</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#018ee898b7223c3b4cb3385d0f10464d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1154bcf5b170d721ac8e27f8fb046b8a">getItalian</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#1154bcf5b170d721ac8e27f8fb046b8a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2131962c82b059c01da36c83de5a18aa">getJapanese</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#2131962c82b059c01da36c83de5a18aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#d3dc36f22bc5ef5b0fdaff1f49778b50">getKorean</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#d3dc36f22bc5ef5b0fdaff1f49778b50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#eebb4e210cc2b9ea2c25a6607638ed82">getChinese</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#eebb4e210cc2b9ea2c25a6607638ed82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1467301723a35cf6f42b0b8b47ed2dc5">getSimplifiedChinese</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#1467301723a35cf6f42b0b8b47ed2dc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#fdeffb5b588d1d904e0c334b60251526">getTraditionalChinese</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this language. <a href="#fdeffb5b588d1d904e0c334b60251526"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#a19e5f0ac81c6c7fd9c13d7515608ebd">getFrance</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#a19e5f0ac81c6c7fd9c13d7515608ebd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1941bac04cee2957c063faabf6229218">getGermany</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#1941bac04cee2957c063faabf6229218"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#83bc889adad165fb39305cf8364bb8e5">getItaly</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#83bc889adad165fb39305cf8364bb8e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#e8adc716e1c2a97d7dae249f1c37d8ff">getJapan</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#e8adc716e1c2a97d7dae249f1c37d8ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#d8ae6bb28603e762ed92055c1eaf220c">getKorea</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#d8ae6bb28603e762ed92055c1eaf220c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#090facf0b2391acb387bfc2688d11686">getChina</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#090facf0b2391acb387bfc2688d11686"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#0bdc02e24d87f235050844cd60b5eeb7">getPRC</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#0bdc02e24d87f235050844cd60b5eeb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#63fbbe90140d5629c499eae70e4ee895">getTaiwan</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#63fbbe90140d5629c499eae70e4ee895"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c0738001843d2866f11031b4585c7a9c">getUK</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#c0738001843d2866f11031b4585c7a9c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#ee507186038b3331bc060fbd85f52af3">getUS</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#ee507186038b3331bc060fbd85f52af3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#2b10656562a9c819246eb3d6fc1be8b2">getCanada</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#2b10656562a9c819246eb3d6fc1be8b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#1625cc4f478e9e764d3e3f232029e18b">getCanadaFrench</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Useful constant for this country/region. <a href="#1625cc4f478e9e764d3e3f232029e18b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#c12d6326f2d283f5643f6b6caacfe88c">getDefault</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Common methods of getting the current default <a class="el" href="classLocale.html">Locale</a>. <a href="#c12d6326f2d283f5643f6b6caacfe88c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#8577dcfe0faaf6eecff618c28146456c">setDefault</a> (const <a class="el" href="classLocale.html">Locale</a> &newLocale, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &success)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the default. <a href="#8577dcfe0faaf6eecff618c28146456c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#8cea92e79f965ef653cd85059581f9ac">createFromName</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a locale which has had minimal canonicalization as per <a class="el" href="uloc_8h.html#1b817e9efa7ca5711d3b5abd19227296">uloc_getName()</a>. <a href="#8cea92e79f965ef653cd85059581f9ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#7b6db0c7bc1a07607ded0e8fd3adf8f6">createCanonical</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a locale from the given string after canonicalizing the string by calling <a class="el" href="uloc_8h.html#fe5adae51e287be339c57142947eb290">uloc_canonicalize()</a>. <a href="#7b6db0c7bc1a07607ded0e8fd3adf8f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#bfddb5ad335e43c8a3c24a37014b1429">getAvailableLocales</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> &count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all installed locales. <a href="#bfddb5ad335e43c8a3c24a37014b1429"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char *const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#345746448f2df515629586db8fb7dd46">getISOCountries</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a list of all available 2-letter country codes defined in ISO 639. <a href="#345746448f2df515629586db8fb7dd46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char *const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#56822f6e1ba6371254ec55554d2f6546">getISOLanguages</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a list of all available language codes defined in ISO 639. <a href="#56822f6e1ba6371254ec55554d2f6546"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#d2ab98c38e3f6795a627631fec207061">getStaticClassID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#d2ab98c38e3f6795a627631fec207061"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#132087eb22e087955c977a6c39bd79bb">setFromPOSIXID</a> (const char *posixID)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set this from a single POSIX style locale string. <a href="#132087eb22e087955c977a6c39bd79bb"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocale.html#0982d59a0bbc49100ca15e64674e3d44">locale_set_default_internal</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A friend to allow the default locale to be set by either the C or C++ API. <a href="#0982d59a0bbc49100ca15e64674e3d44"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A <code><a class="el" href="classLocale.html">Locale</a></code> object represents a specific geographical, political, or cultural region.
<p>
An operation that requires a <code><a class="el" href="classLocale.html">Locale</a></code> to perform its task is called <em>locale-sensitive</em> and uses the <code><a class="el" href="classLocale.html">Locale</a></code> to tailor information for the user. For example, displaying a number is a locale-sensitive operation--the number should be formatted according to the customs/conventions of the user's native country, region, or culture.<p>
The <a class="el" href="classLocale.html">Locale</a> class is not suitable for subclassing.<p>
You can create a <code><a class="el" href="classLocale.html">Locale</a></code> object using the constructor in this class: <blockquote> <pre>
<a class="el" href="classLocale.html">Locale</a>( const char* language,
const char* country,
const char* variant);
</pre> </blockquote> The first argument to the constructors is a valid <b>ISO Language Code.</b> These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at: <br>
<a href="http://www.loc.gov/standards/iso639-2/">http://www.loc.gov/standards/iso639-2/</a><p>
The second argument to the constructors is a valid <b>ISO Country Code.</b> These codes are the upper-case two-letter codes as defined by ISO-3166. You can find a full list of these codes at a number of sites, such as: <br>
<a href="http://www.iso.org/iso/en/prods-services/iso3166ma/index.html">http://www.iso.org/iso/en/prods-services/iso3166ma/index.html</a><p>
The third constructor requires a third argument--the <b>Variant.</b> The Variant codes are vendor and browser-specific. For example, use REVISED for a langauge's revised script orthography, and POSIX for POSIX. Where there are two variants, separate them with an underscore, and put the most important one first. For example, a Traditional Spanish collation might be referenced, with "ES", "ES", "Traditional_POSIX".<p>
Because a <code><a class="el" href="classLocale.html">Locale</a></code> object is just an identifier for a region, no validity check is performed when you construct a <code><a class="el" href="classLocale.html">Locale</a></code>. If you want to see whether particular resources are available for the <code><a class="el" href="classLocale.html">Locale</a></code> you construct, you must query those resources. For example, ask the <code><a class="el" href="classNumberFormat.html">NumberFormat</a></code> for the locales it supports using its <code>getAvailableLocales</code> method. <br>
<b>Note:</b> When you ask for a resource for a particular locale, you get back the best available match, not necessarily precisely what you asked for. For more information, look at <code><a class="el" href="classResourceBundle.html">ResourceBundle</a></code>.<p>
The <code><a class="el" href="classLocale.html">Locale</a></code> class provides a number of convenient constants that you can use to create <code><a class="el" href="classLocale.html">Locale</a></code> objects for commonly used locales. For example, the following refers to a <code><a class="el" href="classLocale.html">Locale</a></code> object for the United States: <blockquote> <pre>
<a class="el" href="classLocale.html#ee507186038b3331bc060fbd85f52af3">Locale::getUS()</a>
</pre> </blockquote><p>
Once you've created a <code><a class="el" href="classLocale.html">Locale</a></code> you can query it for information about itself. Use <code>getCountry</code> to get the ISO Country Code and <code>getLanguage</code> to get the ISO Language Code. You can use <code>getDisplayCountry</code> to get the name of the country suitable for displaying to the user. Similarly, you can use <code>getDisplayLanguage</code> to get the name of the language suitable for displaying to the user. Interestingly, the <code>getDisplayXXX</code> methods are themselves locale-sensitive and have two versions: one that uses the default locale and one that takes a locale as an argument and displays the name or country in a language appropriate to that locale.<p>
ICU provides a number of classes that perform locale-sensitive operations. For example, the <code><a class="el" href="classNumberFormat.html">NumberFormat</a></code> class formats numbers, currency, or percentages in a locale-sensitive manner. Classes such as <code><a class="el" href="classNumberFormat.html">NumberFormat</a></code> have a number of convenience methods for creating a default object of that type. For example, the <code><a class="el" href="classNumberFormat.html">NumberFormat</a></code> class provides these three convenience methods for creating a default <code><a class="el" href="classNumberFormat.html">NumberFormat</a></code> object: <blockquote> <pre>
UErrorCode success = U_ZERO_ERROR;
<a class="el" href="classLocale.html">Locale</a> myLocale;
<a class="el" href="classNumberFormat.html">NumberFormat</a> *nf;</pre><p>
<pre> nf = NumberFormat::createInstance( success ); delete nf;
nf = NumberFormat::createCurrencyInstance( success ); delete nf;
nf = NumberFormat::createPercentInstance( success ); delete nf;
</pre> </blockquote> Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale. <blockquote> <pre>
nf = NumberFormat::createInstance( myLocale, success ); delete nf;
nf = NumberFormat::createCurrencyInstance( myLocale, success ); delete nf;
nf = NumberFormat::createPercentInstance( myLocale, success ); delete nf;
</pre> </blockquote> A <code><a class="el" href="classLocale.html">Locale</a></code> is the mechanism for identifying the kind of object (<code><a class="el" href="classNumberFormat.html">NumberFormat</a></code>) that you would like to get. The locale is <b>just</b> a mechanism for identifying objects, <b>not</b> a container for the objects themselves.<p>
Each class that performs locale-sensitive operations allows you to get all the available objects of that type. You can sift through these objects by language, country, or variant, and use the display names to present a menu to the user. For example, you can create a menu of all the collation objects suitable for a given language. Such classes implement these three class methods: <blockquote> <pre>
static Locale* <a class="el" href="classLocale.html#bfddb5ad335e43c8a3c24a37014b1429">getAvailableLocales(int32_t& numLocales)</a>
static <a class="el" href="classUnicodeString.html">UnicodeString</a>& getDisplayName(const <a class="el" href="classLocale.html">Locale</a>& objectLocale,
const <a class="el" href="classLocale.html">Locale</a>& displayLocale,
<a class="el" href="classUnicodeString.html">UnicodeString</a>& displayName)
static <a class="el" href="classUnicodeString.html">UnicodeString</a>& getDisplayName(const <a class="el" href="classLocale.html">Locale</a>& objectLocale,
<a class="el" href="classUnicodeString.html">UnicodeString</a>& displayName)
</pre> </blockquote><p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000095">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classResourceBundle.html">ResourceBundle</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00181">181</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="599d7bb7a08b138cb069e39987846b3f"></a><!-- doxytag: member="Locale::Locale" ref="599d7bb7a08b138cb069e39987846b3f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Locale::Locale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a default locale object, a <a class="el" href="classLocale.html">Locale</a> for the default locale ID.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html#c12d6326f2d283f5643f6b6caacfe88c">getDefault</a> <p>
<a class="el" href="uloc_8h.html#dbc1e91581ae0e0ec421dafcc35c06c1">uloc_getDefault</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000117">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2e847ff3c5df01b077293a30347bac11"></a><!-- doxytag: member="Locale::Locale" ref="2e847ff3c5df01b077293a30347bac11" args="(const char *language, const char *country=0, const char *variant=0, const char *keywordsAndValues=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Locale::Locale </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>country</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>variant</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keywordsAndValues</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a locale from language, country, variant.
<p>
If an error occurs, then the constructed object will be "bogus" (<a class="el" href="classLocale.html#c671e591506f640ac36b5943230aeb18">isBogus()</a> will return TRUE).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>Lowercase two-letter or three-letter ISO-639 code. This parameter can instead be an ICU style C locale (e.g. "en_US"), but the other parameters must not be used. This parameter can be NULL; if so, the locale is initialized to match the current default locale. (This is the same as using the default constructor.) Please note: The Java <a class="el" href="classLocale.html">Locale</a> class does NOT accept the form 'new <a class="el" href="classLocale.html">Locale</a>("en_US")' but only 'new <a class="el" href="classLocale.html">Locale</a>("en","US")'</td></tr>
<tr><td valign="top"></td><td valign="top"><em>country</em> </td><td>Uppercase two-letter ISO-3166 code. (optional) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>variant</em> </td><td>Uppercase vendor and browser specific code. See class description. (optional) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keywordsAndValues</em> </td><td>A string consisting of keyword/values pairs, such as "collation=phonebook;currency=euro"</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html#c12d6326f2d283f5643f6b6caacfe88c">getDefault</a> <p>
<a class="el" href="uloc_8h.html#dbc1e91581ae0e0ec421dafcc35c06c1">uloc_getDefault</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000118">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b7a2e36b993dfec56609f03348309172"></a><!-- doxytag: member="Locale::Locale" ref="b7a2e36b993dfec56609f03348309172" args="(const Locale &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Locale::Locale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializes a <a class="el" href="classLocale.html">Locale</a> object from another <a class="el" href="classLocale.html">Locale</a> object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>The <a class="el" href="classLocale.html">Locale</a> object being copied in. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000119">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="69855afaa3627ce0003ca5e5946af10e"></a><!-- doxytag: member="Locale::~Locale" ref="69855afaa3627ce0003ca5e5946af10e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Locale::~Locale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000120">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="669ca7c4ef168a75879bc2e847f151dd"></a><!-- doxytag: member="Locale::getEnglish" ref="669ca7c4ef168a75879bc2e847f151dd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getEnglish </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000096">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c4577a88016e7111bd37906c136951c7"></a><!-- doxytag: member="Locale::getFrench" ref="c4577a88016e7111bd37906c136951c7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getFrench </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000097">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="018ee898b7223c3b4cb3385d0f10464d"></a><!-- doxytag: member="Locale::getGerman" ref="018ee898b7223c3b4cb3385d0f10464d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getGerman </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000098">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1154bcf5b170d721ac8e27f8fb046b8a"></a><!-- doxytag: member="Locale::getItalian" ref="1154bcf5b170d721ac8e27f8fb046b8a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getItalian </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000099">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2131962c82b059c01da36c83de5a18aa"></a><!-- doxytag: member="Locale::getJapanese" ref="2131962c82b059c01da36c83de5a18aa" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getJapanese </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000100">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d3dc36f22bc5ef5b0fdaff1f49778b50"></a><!-- doxytag: member="Locale::getKorean" ref="d3dc36f22bc5ef5b0fdaff1f49778b50" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getKorean </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000101">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="eebb4e210cc2b9ea2c25a6607638ed82"></a><!-- doxytag: member="Locale::getChinese" ref="eebb4e210cc2b9ea2c25a6607638ed82" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getChinese </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000102">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1467301723a35cf6f42b0b8b47ed2dc5"></a><!-- doxytag: member="Locale::getSimplifiedChinese" ref="1467301723a35cf6f42b0b8b47ed2dc5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getSimplifiedChinese </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000103">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdeffb5b588d1d904e0c334b60251526"></a><!-- doxytag: member="Locale::getTraditionalChinese" ref="fdeffb5b588d1d904e0c334b60251526" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getTraditionalChinese </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this language.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000104">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a19e5f0ac81c6c7fd9c13d7515608ebd"></a><!-- doxytag: member="Locale::getFrance" ref="a19e5f0ac81c6c7fd9c13d7515608ebd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getFrance </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000105">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1941bac04cee2957c063faabf6229218"></a><!-- doxytag: member="Locale::getGermany" ref="1941bac04cee2957c063faabf6229218" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getGermany </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000106">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="83bc889adad165fb39305cf8364bb8e5"></a><!-- doxytag: member="Locale::getItaly" ref="83bc889adad165fb39305cf8364bb8e5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getItaly </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000107">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e8adc716e1c2a97d7dae249f1c37d8ff"></a><!-- doxytag: member="Locale::getJapan" ref="e8adc716e1c2a97d7dae249f1c37d8ff" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getJapan </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000108">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d8ae6bb28603e762ed92055c1eaf220c"></a><!-- doxytag: member="Locale::getKorea" ref="d8ae6bb28603e762ed92055c1eaf220c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getKorea </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000109">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="090facf0b2391acb387bfc2688d11686"></a><!-- doxytag: member="Locale::getChina" ref="090facf0b2391acb387bfc2688d11686" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getChina </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000110">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0bdc02e24d87f235050844cd60b5eeb7"></a><!-- doxytag: member="Locale::getPRC" ref="0bdc02e24d87f235050844cd60b5eeb7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getPRC </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000111">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="63fbbe90140d5629c499eae70e4ee895"></a><!-- doxytag: member="Locale::getTaiwan" ref="63fbbe90140d5629c499eae70e4ee895" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getTaiwan </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000112">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c0738001843d2866f11031b4585c7a9c"></a><!-- doxytag: member="Locale::getUK" ref="c0738001843d2866f11031b4585c7a9c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getUK </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000113">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ee507186038b3331bc060fbd85f52af3"></a><!-- doxytag: member="Locale::getUS" ref="ee507186038b3331bc060fbd85f52af3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getUS </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000114">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b10656562a9c819246eb3d6fc1be8b2"></a><!-- doxytag: member="Locale::getCanada" ref="2b10656562a9c819246eb3d6fc1be8b2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getCanada </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000115">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1625cc4f478e9e764d3e3f232029e18b"></a><!-- doxytag: member="Locale::getCanadaFrench" ref="1625cc4f478e9e764d3e3f232029e18b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getCanadaFrench </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Useful constant for this country/region.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000116">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1ba398b2e0c47460cbe953ce82510139"></a><!-- doxytag: member="Locale::operator=" ref="1ba398b2e0c47460cbe953ce82510139" args="(const Locale &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classLocale.html">Locale</a>& Locale::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Replaces the entire contents of *this with the specified value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>The <a class="el" href="classLocale.html">Locale</a> object being copied in. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>*this </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000121">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="bba7de6311743eb2e42757dca2f89a27"></a><!-- doxytag: member="Locale::operator==" ref="bba7de6311743eb2e42757dca2f89a27" args="(const Locale &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Locale::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if two locale keys are the same.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>The locale key object to be compared with this. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the two locale keys are the same, false otherwise. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000122">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Referenced by <a class="el" href="locid_8h-source.html#l00722">operator!=()</a>.
</div>
</div><p>
<a class="anchor" name="15114dcd2b70f2c98cc066e5ac83e62c"></a><!-- doxytag: member="Locale::operator!=" ref="15114dcd2b70f2c98cc066e5ac83e62c" args="(const Locale &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Locale::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if two locale keys are not the same.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>The locale key object to be compared with this. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the two locale keys are not the same, false otherwise. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000123">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00722">722</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
<p>
References <a class="el" href="classLocale.html#bba7de6311743eb2e42757dca2f89a27">operator==()</a>.
</div>
</div><p>
<a class="anchor" name="ad1470cf8d756ff9d5c6568e5177dd02"></a><!-- doxytag: member="Locale::clone" ref="ad1470cf8d756ff9d5c6568e5177dd02" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classLocale.html">Locale</a>* Locale::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clone this object.
<p>
Clones can be used concurrently in multiple threads. If an error occurs, then NULL is returned. The caller must delete the clone.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a clone of this object</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html#09cf70b7f4397a78df56a8c1ba9a2ccf">getDynamicClassID</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000124">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c12d6326f2d283f5643f6b6caacfe88c"></a><!-- doxytag: member="Locale::getDefault" ref="c12d6326f2d283f5643f6b6caacfe88c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>& Locale::getDefault </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Common methods of getting the current default <a class="el" href="classLocale.html">Locale</a>.
<p>
Used for the presentation: menus, dialogs, etc. Generally set once when your applet or application is initialized, then never reset. (If you do reset the default locale, you probably want to reload your GUI, so that the change is reflected in your interface.)<p>
More advanced programs will allow users to use different locales for different fields, e.g. in a spreadsheet.<p>
Note that the initial setting will match the host system. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a reference to the <a class="el" href="classLocale.html">Locale</a> object for the default locale ID </dd></dl>
<dl compact><dt><b><a class="el" href="system.html#_system000001">System:</a></b></dt><dd>Do not use unless you know what you are doing. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000125">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Referenced by <a class="el" href="calendar_8h-source.html#l02115">Calendar::createInstance()</a>.
</div>
</div><p>
<a class="anchor" name="8577dcfe0faaf6eecff618c28146456c"></a><!-- doxytag: member="Locale::setDefault" ref="8577dcfe0faaf6eecff618c28146456c" args="(const Locale &newLocale, UErrorCode &success)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Locale::setDefault </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>newLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>success</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the default.
<p>
Normally set once at the beginning of a process, then never reset. <a class="el" href="classLocale.html#8577dcfe0faaf6eecff618c28146456c">setDefault()</a> only changes ICU's default locale ID, <b>not</b> the default locale ID of the runtime environment.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newLocale</em> </td><td><a class="el" href="classLocale.html">Locale</a> to set to. If NULL, set to the value obtained from the runtime environement. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>success</em> </td><td>The error code. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="system.html#_system000002">System:</a></b></dt><dd>Do not use unless you know what you are doing. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000126">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8cea92e79f965ef653cd85059581f9ac"></a><!-- doxytag: member="Locale::createFromName" ref="8cea92e79f965ef653cd85059581f9ac" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classLocale.html">Locale</a> Locale::createFromName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a locale which has had minimal canonicalization as per <a class="el" href="uloc_8h.html#1b817e9efa7ca5711d3b5abd19227296">uloc_getName()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name to create from. If name is null, the default <a class="el" href="classLocale.html">Locale</a> is used. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>new locale object </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000127">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uloc_8h.html#1b817e9efa7ca5711d3b5abd19227296">uloc_getName</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="7b6db0c7bc1a07607ded0e8fd3adf8f6"></a><!-- doxytag: member="Locale::createCanonical" ref="7b6db0c7bc1a07607ded0e8fd3adf8f6" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classLocale.html">Locale</a> Locale::createCanonical </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a locale from the given string after canonicalizing the string by calling <a class="el" href="uloc_8h.html#fe5adae51e287be339c57142947eb290">uloc_canonicalize()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the locale ID to create from. Must not be NULL. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new locale object corresponding to the given name </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000128">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uloc_8h.html#fe5adae51e287be339c57142947eb290">uloc_canonicalize</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="868a4c5256cc7fd3842e858ba301bce2"></a><!-- doxytag: member="Locale::getLanguage" ref="868a4c5256cc7fd3842e858ba301bce2" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Locale::getLanguage </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the locale's ISO-639 language code.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000129">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00734">734</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="00dbacc57dfc06f9b4239065052f6f14"></a><!-- doxytag: member="Locale::getScript" ref="00dbacc57dfc06f9b4239065052f6f14" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Locale::getScript </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the locale's ISO-15924 abbreviation script code.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uscript_8h.html#34236e1bcb71635837fc9f0e045499fa">uscript_getShortName</a> <p>
<a class="el" href="uscript_8h.html#d7c87340add879032324be150438f671">uscript_getCode</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000130">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00740">740</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="45b9210463e93b810216e2677d9c155f"></a><!-- doxytag: member="Locale::getCountry" ref="45b9210463e93b810216e2677d9c155f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Locale::getCountry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the locale's ISO-3166 country code.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000131">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00728">728</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="6c668e76f2a39c2fe8f17f1654a7df8f"></a><!-- doxytag: member="Locale::getVariant" ref="6c668e76f2a39c2fe8f17f1654a7df8f" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Locale::getVariant </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the locale's variant code.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000132">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00746">746</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="f8b5b6d6367062eda70c4a2cade02a67"></a><!-- doxytag: member="Locale::getName" ref="f8b5b6d6367062eda70c4a2cade02a67" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Locale::getName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars.
<p>
If a field is missing, up to two leading underbars will occur. Example: "en", "de_DE", "en_US_WIN", "de__POSIX", "fr__MAC", "__MAC", "_MT", "_FR_EURO" <dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to "name". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000133">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00752">752</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="a9df185d761d40c75b5577a5415229cd"></a><!-- doxytag: member="Locale::getBaseName" ref="a9df185d761d40c75b5577a5415229cd" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Locale::getBaseName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the programmatic name of the entire locale as getName would return, but without keywords.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to "name". </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html#f8b5b6d6367062eda70c4a2cade02a67">getName</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000134">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="dba19931d9cbda3d0b6a7817617f13f5"></a><!-- doxytag: member="Locale::createKeywords" ref="dba19931d9cbda3d0b6a7817617f13f5" args="(UErrorCode &status) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringEnumeration.html">StringEnumeration</a>* Locale::createKeywords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the list of keywords for the specified locale.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to <a class="el" href="classStringEnumeration.html">StringEnumeration</a> class. Client must dispose of it by calling delete. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Returns any error information while performing this operation. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000135">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd5dc6a5db78d87dad58e5423bbff0d9"></a><!-- doxytag: member="Locale::getKeywordValue" ref="fd5dc6a5db78d87dad58e5423bbff0d9" args="(const char *keywordName, char *buffer, int32_t bufferCapacity, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Locale::getKeywordValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keywordName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>bufferCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value for a keyword.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keywordName</em> </td><td>name of the keyword for which we want the value. Case insensitive. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Returns any error information while performing this operation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The buffer to receive the keyword value. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bufferCapacity</em> </td><td>The capacity of receiving buffer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the length of keyword value</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000136">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c38eb45e0834b86b2ecd0516470a9c05"></a><!-- doxytag: member="Locale::getISO3Language" ref="c38eb45e0834b86b2ecd0516470a9c05" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Locale::getISO3Language </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the locale's three-letter language code, as specified in ISO draft standard ISO-639-2.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code, or NULL </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000137">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2c37bacceb782f9b0e39891974d0b7b5"></a><!-- doxytag: member="Locale::getISO3Country" ref="2c37bacceb782f9b0e39891974d0b7b5" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Locale::getISO3Country </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "name" with the locale's three-letter ISO-3166 country code.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An alias to the code, or NULL </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000138">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8f91b5cc02e8ed0f4cf0fc68bc492ae1"></a><!-- doxytag: member="Locale::getLCID" ref="8f91b5cc02e8ed0f4cf0fc68bc492ae1" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> Locale::getLCID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the Windows LCID value corresponding to this locale.
<p>
This value is stored in the resource data for the locale as a one-to-four-digit hexadecimal number. If the resource is missing, in the wrong format, or there is no Windows LCID value that corresponds to this locale, returns 0. <dl compact><dt><b><a class="el" href="stable.html#_stable000139">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4f4fb7e6d07f39da0898421980a4003c"></a><!-- doxytag: member="Locale::getDisplayLanguage" ref="4f4fb7e6d07f39da0898421980a4003c" args="(UnicodeString &dispLang) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayLanguage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispLang</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the default locale.
<p>
For example, if the locale's language code is "fr" and the default locale's language code is "en", this function would set dispLang to "French". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dispLang</em> </td><td>Receives the language's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispLang". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000140">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="6cc4a17115b6a553f6ddd94464a99c2b"></a><!-- doxytag: member="Locale::getDisplayLanguage" ref="6cc4a17115b6a553f6ddd94464a99c2b" args="(const Locale &displayLocale, UnicodeString &dispLang) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayLanguage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispLang</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the locale specified by "displayLocale".
<p>
For example, if the locale's language code is "en" and displayLocale's language code is "fr", this function would set dispLang to "Anglais". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>Specifies the locale to be used to display the name. In other words, if the locale's language code is "en", passing <a class="el" href="classLocale.html#c4577a88016e7111bd37906c136951c7">Locale::getFrench()</a> for displayLocale would result in "Anglais", while passing <a class="el" href="classLocale.html#018ee898b7223c3b4cb3385d0f10464d">Locale::getGerman()</a> for displayLocale would result in "Englisch". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dispLang</em> </td><td>Receives the language's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispLang". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000141">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c36cf3275f9677e1bd00831d6e6a5ca3"></a><!-- doxytag: member="Locale::getDisplayScript" ref="c36cf3275f9677e1bd00831d6e6a5ca3" args="(UnicodeString &dispScript) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayScript </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispScript</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispScript" with the name of this locale's script in a format suitable for user display in the default locale.
<p>
For example, if the locale's script code is "LATN" and the default locale's language code is "en", this function would set dispScript to "Latin". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dispScript</em> </td><td>Receives the scripts's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispScript". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000142">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b7db83a1c33606bda56a3f1202f363d"></a><!-- doxytag: member="Locale::getDisplayScript" ref="2b7db83a1c33606bda56a3f1202f363d" args="(const Locale &displayLocale, UnicodeString &dispScript) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayScript </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispScript</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispScript" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale".
<p>
For example, if the locale's script code is "LATN" and displayLocale's language code is "en", this function would set dispScript to "Latin". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>Specifies the locale to be used to display the name. In other words, if the locale's script code is "LATN", passing <a class="el" href="classLocale.html#c4577a88016e7111bd37906c136951c7">Locale::getFrench()</a> for displayLocale would result in "", while passing <a class="el" href="classLocale.html#018ee898b7223c3b4cb3385d0f10464d">Locale::getGerman()</a> for displayLocale would result in "". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dispScript</em> </td><td>Receives the scripts's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispScript". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000143">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2b24f12c2e527b8f0e75a1314f6ae5de"></a><!-- doxytag: member="Locale::getDisplayCountry" ref="2b24f12c2e527b8f0e75a1314f6ae5de" args="(UnicodeString &dispCountry) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayCountry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispCountry</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the default locale.
<p>
For example, if the locale's country code is "FR" and the default locale's language code is "en", this function would set dispCountry to "France". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dispCountry</em> </td><td>Receives the country's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispCountry". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000144">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ea34011e8cc92c985ab1f54342eed4c3"></a><!-- doxytag: member="Locale::getDisplayCountry" ref="ea34011e8cc92c985ab1f54342eed4c3" args="(const Locale &displayLocale, UnicodeString &dispCountry) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayCountry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispCountry</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale".
<p>
For example, if the locale's country code is "US" and displayLocale's language code is "fr", this function would set dispCountry to "&Eacute;tats-Unis". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>Specifies the locale to be used to display the name. In other words, if the locale's country code is "US", passing <a class="el" href="classLocale.html#c4577a88016e7111bd37906c136951c7">Locale::getFrench()</a> for displayLocale would result in "&Eacute;tats-Unis", while passing <a class="el" href="classLocale.html#018ee898b7223c3b4cb3385d0f10464d">Locale::getGerman()</a> for displayLocale would result in "Vereinigte Staaten". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dispCountry</em> </td><td>Receives the country's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispCountry". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000145">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="32f560c91588f6823be49ec8bbbfe302"></a><!-- doxytag: member="Locale::getDisplayVariant" ref="32f560c91588f6823be49ec8bbbfe302" args="(UnicodeString &dispVar) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayVariant </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispVar</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the default locale.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dispVar</em> </td><td>Receives the variant's name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispVar". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000146">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e4923d12044b090bca3ead5e0044d2ff"></a><!-- doxytag: member="Locale::getDisplayVariant" ref="e4923d12044b090bca3ead5e0044d2ff" args="(const Locale &displayLocale, UnicodeString &dispVar) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayVariant </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>dispVar</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the locale specified by "displayLocale".
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>Specifies the locale to be used to display the name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dispVar</em> </td><td>Receives the variant's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "dispVar". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000147">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c23fa119d789f1a2a4d3cab0f7caa49"></a><!-- doxytag: member="Locale::getDisplayName" ref="3c23fa119d789f1a2a4d3cab0f7caa49" args="(UnicodeString &name) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "name" with the name of this locale in a format suitable for user display in the default locale.
<p>
This function uses <a class="el" href="classLocale.html#4f4fb7e6d07f39da0898421980a4003c">getDisplayLanguage()</a>, <a class="el" href="classLocale.html#2b24f12c2e527b8f0e75a1314f6ae5de">getDisplayCountry()</a>, and <a class="el" href="classLocale.html#32f560c91588f6823be49ec8bbbfe302">getDisplayVariant()</a> to do its work, and outputs the display name in the format "language (country[,variant])". For example, if the default locale is en_US, then fr_FR's display name would be "French (France)", and es_MX_Traditional's display name would be "Spanish (Mexico,Traditional)". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Receives the locale's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "name". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000148">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1935ea040dab51999196c0bf89e87d99"></a><!-- doxytag: member="Locale::getDisplayName" ref="1935ea040dab51999196c0bf89e87d99" args="(const Locale &displayLocale, UnicodeString &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Locale::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Fills in "name" with the name of this locale in a format suitable for user display in the locale specfied by "displayLocale".
<p>
This function uses <a class="el" href="classLocale.html#4f4fb7e6d07f39da0898421980a4003c">getDisplayLanguage()</a>, <a class="el" href="classLocale.html#2b24f12c2e527b8f0e75a1314f6ae5de">getDisplayCountry()</a>, and <a class="el" href="classLocale.html#32f560c91588f6823be49ec8bbbfe302">getDisplayVariant()</a> to do its work, and outputs the display name in the format "language (country[,variant])". For example, if displayLocale is fr_FR, then en_US's display name would be "Anglais (&Eacute;tats-Unis)", and no_NO_NY's display name would be "norv&eacute;gien (Norv&egrave;ge,NY)". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>Specifies the locale to be used to display the name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Receives the locale's display name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to "name". </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000149">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="664433180261f7b97a7a1a83ca3dfe78"></a><!-- doxytag: member="Locale::hashCode" ref="664433180261f7b97a7a1a83ca3dfe78" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Locale::hashCode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generates a hash code for the locale.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000150">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4cb8b5e11ac02fedc83e9b23bfc5da70"></a><!-- doxytag: member="Locale::setToBogus" ref="4cb8b5e11ac02fedc83e9b23bfc5da70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Locale::setToBogus </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the locale to bogus A bogus locale represents a non-existing locale associated with services that can be instantiated from non-locale data in addition to locale (for example, collation can be instantiated from a locale and from a rule set).
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000151">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c671e591506f640ac36b5943230aeb18"></a><!-- doxytag: member="Locale::isBogus" ref="c671e591506f640ac36b5943230aeb18" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Locale::isBogus </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the bogus state.
<p>
<a class="el" href="classLocale.html">Locale</a> object can be bogus if it doesn't exist <dl class="return" compact><dt><b>Returns:</b></dt><dd>FALSE if it is a real locale, TRUE if it is a bogus locale </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000152">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="locid_8h-source.html#l00758">758</a> of file <a class="el" href="locid_8h-source.html">locid.h</a>.
</div>
</div><p>
<a class="anchor" name="bfddb5ad335e43c8a3c24a37014b1429"></a><!-- doxytag: member="Locale::getAvailableLocales" ref="bfddb5ad335e43c8a3c24a37014b1429" args="(int32_t &count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>* Locale::getAvailableLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> & </td>
<td class="paramname"> <em>count</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a list of all installed locales.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>Receives the number of locales in the list. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to an array of <a class="el" href="classLocale.html">Locale</a> objects. This array is the list of all locales with installed resource files. The called does NOT get ownership of this list, and must NOT delete it. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000153">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="345746448f2df515629586db8fb7dd46"></a><!-- doxytag: member="Locale::getISOCountries" ref="345746448f2df515629586db8fb7dd46" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* const* Locale::getISOCountries </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a list of all available 2-letter country codes defined in ISO 639.
<p>
This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a list of all available country codes </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000154">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="56822f6e1ba6371254ec55554d2f6546"></a><!-- doxytag: member="Locale::getISOLanguages" ref="56822f6e1ba6371254ec55554d2f6546" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* const* Locale::getISOLanguages </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a list of all available language codes defined in ISO 639.
<p>
This is a pointer to an array of pointers to arrays of char. All of these pointers are owned by ICU-- do not delete them, and do not write through them. The array is terminated with a null pointer. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a list of all available language codes </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000155">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d2ab98c38e3f6795a627631fec207061"></a><!-- doxytag: member="Locale::getStaticClassID" ref="d2ab98c38e3f6795a627631fec207061" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> Locale::getStaticClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for this class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000156">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="09cf70b7f4397a78df56a8c1ba9a2ccf"></a><!-- doxytag: member="Locale::getDynamicClassID" ref="09cf70b7f4397a78df56a8c1ba9a2ccf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> Locale::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for the actual class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000157">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#ce1dd31fb2c6f2c07dfebe8fd240ec37">UObject</a>.
</div>
</div><p>
<a class="anchor" name="132087eb22e087955c977a6c39bd79bb"></a><!-- doxytag: member="Locale::setFromPOSIXID" ref="132087eb22e087955c977a6c39bd79bb" args="(const char *posixID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Locale::setFromPOSIXID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>posixID</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this from a single POSIX style locale string.
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000010">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="0982d59a0bbc49100ca15e64674e3d44"></a><!-- doxytag: member="Locale::locale_set_default_internal" ref="0982d59a0bbc49100ca15e64674e3d44" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void locale_set_default_internal </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A friend to allow the default locale to be set by either the C or C++ API.
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000011">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="locid_8h-source.html">locid.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:42 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
280da2a01a3d16776505ea3f476de84f
>
files
>
93
