Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

Locale Class Reference

A Locale object represents a specific geographical, political, or cultural region. More...

#include <locid.h>

Inheritance diagram for Locale::

UObject UMemory List of all members.

Public Methods

 Locale ()
 Construct a default locale object, a Locale for the default locale ID. More...

 Locale (const char *language, const char *country=0, const char *variant=0, const char *keywordsAndValues=0)
 Construct a locale from language, country, variant. More...

 Locale (const Locale &other)
 Initializes a Locale object from another Locale object. More...

 ~Locale ()
 Destructor. More...

Locale & operator= (const Locale &other)
 Replaces the entire contents of *this with the specified value. More...

UBool operator== (const Locale &other) const
 Checks if two locale keys are the same. More...

UBool operator!= (const Locale &other) const
 Checks if two locale keys are not the same. More...

Locale * clone () const
 Clone this object. More...

const char * getLanguage () const
 Returns the locale's ISO-639 language code. More...

const char * getScript () const
 Returns the locale's ISO-15924 abbreviation script code. More...

const char * getCountry () const
 Returns the locale's ISO-3166 country code. More...

const char * getVariant () const
 Returns the locale's variant code. More...

const char * getName () const
 Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars. More...

const char * getBaseName () const
 Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars and without keywords. More...

StringEnumerationcreateKeywords (UErrorCode &status) const
 Gets the list of keywords for the specified locale. More...

int32_t getKeywordValue (const char *keywordName, char *buffer, int32_t bufLen, UErrorCode &status) const
 Get the value for a keyword. More...

const char * getISO3Language () const
 returns the locale's three-letter language code, as specified in ISO draft standard ISO-639-2.. More...

const char * getISO3Country () const
 Fills in "name" with the locale's three-letter ISO-3166 country code. More...

uint32_t getLCID (void) const
 Returns the Windows LCID value corresponding to this locale. More...

UnicodeStringgetDisplayLanguage (UnicodeString &dispLang) const
 Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the default locale. More...

UnicodeStringgetDisplayLanguage (const Locale &displayLocale, UnicodeString &dispLang) const
 Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the locale specified by "displayLocale". More...

UnicodeStringgetDisplayScript (UnicodeString &dispScript) const
 Fills in "dispScript" with the name of this locale's script in a format suitable for user display in the default locale. More...

UnicodeStringgetDisplayScript (const Locale &displayLocale, UnicodeString &dispScript) const
 Fills in "dispScript" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale". More...

UnicodeStringgetDisplayCountry (UnicodeString &dispCountry) const
 Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the default locale. More...

UnicodeStringgetDisplayCountry (const Locale &displayLocale, UnicodeString &dispCountry) const
 Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale". More...

UnicodeStringgetDisplayVariant (UnicodeString &dispVar) const
 Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the default locale. More...

UnicodeStringgetDisplayVariant (const Locale &displayLocale, UnicodeString &dispVar) const
 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". More...

UnicodeStringgetDisplayName (UnicodeString &name) const
 Fills in "name" with the name of this locale in a format suitable for user display in the default locale. More...

UnicodeStringgetDisplayName (const Locale &displayLocale, UnicodeString &name) const
 Fills in "name" with the name of this locale in a format suitable for user display in the locale specfied by "displayLocale". More...

int32_t hashCode (void) const
 Generates a hash code for the locale. More...

void setToBogus ()
 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). More...

UBool isBogus (void) const
 Gets the bogus state. More...

virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...


Static Public Methods

const Locale & getEnglish (void)
 Useful constant for this language. More...

const Locale & getFrench (void)
 Useful constant for this language. More...

const Locale & getGerman (void)
 Useful constant for this language. More...

const Locale & getItalian (void)
 Useful constant for this language. More...

const Locale & getJapanese (void)
 Useful constant for this language. More...

const Locale & getKorean (void)
 Useful constant for this language. More...

const Locale & getChinese (void)
 Useful constant for this language. More...

const Locale & getSimplifiedChinese (void)
 Useful constant for this language. More...

const Locale & getTraditionalChinese (void)
 Useful constant for this language. More...

const Locale & getFrance (void)
 Useful constant for this country/region. More...

const Locale & getGermany (void)
 Useful constant for this country/region. More...

const Locale & getItaly (void)
 Useful constant for this country/region. More...

const Locale & getJapan (void)
 Useful constant for this country/region. More...

const Locale & getKorea (void)
 Useful constant for this country/region. More...

const Locale & getChina (void)
 Useful constant for this country/region. More...

const Locale & getPRC (void)
 Useful constant for this country/region. More...

const Locale & getTaiwan (void)
 Useful constant for this country/region. More...

const Locale & getUK (void)
 Useful constant for this country/region. More...

const Locale & getUS (void)
 Useful constant for this country/region. More...

const Locale & getCanada (void)
 Useful constant for this country/region. More...

const Locale & getCanadaFrench (void)
 Useful constant for this country/region. More...

const Locale & getDefault (void)
 Common methods of getting the current default Locale. More...

void setDefault (const Locale &newLocale, UErrorCode &success)
 Sets the default. More...

Locale createFromName (const char *name)
 Creates a locale which has had minimal canonicalization as per uloc_getName(). More...

const Locale * getAvailableLocales (int32_t &count)
 Returns a list of all installed locales. More...

const char *const * getISOCountries ()
 Gets a list of all available 2-letter country codes defined in ISO 639. More...

const char *const * getISOLanguages ()
 Gets a list of all available language codes defined in ISO 639. More...

UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...


Protected Methods

void setFromPOSIXID (const char *posixID)
 Set this from a single POSIX style locale string. More...


Private Types

enum  ELocaleType { eBOGUS }

Private Methods

Locale & init (const char *cLocaleID)
 Initialize the locale object with a new name. More...

 Locale (ELocaleType)

Static Private Methods

Locale * getLocaleCache (void)
 Initialize the locale cache for commonly used locales. More...

const Locale & getLocale (int locid)

Private Attributes

char language [ULOC_LANG_CAPACITY]
char script [ULOC_SCRIPT_CAPACITY]
char country [ULOC_COUNTRY_CAPACITY]
int32_t variantBegin
char * fullName
char fullNameBuffer [ULOC_FULLNAME_CAPACITY]
char * baseName
char baseNameBuffer [ULOC_FULLNAME_CAPACITY]
UBool fIsBogus

Friends

void locale_set_default_internal (const char *)
 A friend to allow the default locale to be set by either the C or C++ API. More...


Detailed Description

A Locale object represents a specific geographical, political, or cultural region.

An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale 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.

The Locale class is not suitable for subclassing.

You create a Locale object using the constructor in this class:

 .      Locale( const   char*  language, 
 .              const   char*  country, 
 .              const   char*  variant);
 
The first argument to the constructors is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a full list of these codes at a number of sites, such as:
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

The second argument to the constructors is a valid ISO Country Code. 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:
http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

The third constructor requires a third argument--the Variant. The Variant codes are vendor and browser-specific. For example, use WIN for Windows, MAC for Macintosh, 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_WIN".

Because a Locale object is just an identifier for a region, no validity check is performed when you construct a Locale. If you want to see whether particular resources are available for the Locale you construct, you must query those resources. For example, ask the NumberFormat for the locales it supports using its getAvailableLocales method.
Note: 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 ResourceBundle.

The Locale class provides a number of convenient constants that you can use to create Locale objects for commonly used locales. For example, the following refers to a Locale object for the United States:

       Locale::getUS()
 

Once you've created a Locale you can query it for information about itself. Use getCountry to get the ISO Country Code and getLanguage to get the ISO Language Code. You can use getDisplayCountry to get the name of the country suitable for displaying to the user. Similarly, you can use getDisplayLanguage to get the name of the language suitable for displaying to the user. Interestingly, the getDisplayXXX 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.

The TIFC provides a number of classes that perform locale-sensitive operations. For example, the NumberFormat class formats numbers, currency, or percentages in a locale-sensitive manner. Classes such as NumberFormat have a number of convenience methods for creating a default object of that type. For example, the NumberFormat class provides these three convenience methods for creating a default NumberFormat object:

     UErrorCode success = U_ZERO_ERROR;
     Locale myLocale;
     NumberFormat *nf;
 
     nf = NumberFormat::createInstance( success );          delete nf;
     nf = NumberFormat::createCurrencyInstance( success );  delete nf;
     nf = NumberFormat::createPercentInstance( success );   delete nf;
 
Each of these methods has two variants; one with an explicit locale and one without; the latter using the default locale.
     nf = NumberFormat::createInstance( myLocale, success );          delete nf;
     nf = NumberFormat::createCurrencyInstance( myLocale, success );  delete nf;
     nf = NumberFormat::createPercentInstance( myLocale, success );   delete nf;
 
A Locale is the mechanism for identifying the kind of object (NumberFormat) that you would like to get. The locale is just a mechanism for identifying objects, not a container for the objects themselves.

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:

       static Locale* getAvailableLocales(int32_t& numLocales)
       static UnicodeString& getDisplayName(const Locale&  objectLocale,
                                            const Locale&  displayLocale,
                                            UnicodeString& displayName)
       static UnicodeString& getDisplayName(const Locale&  objectLocale,
                                            UnicodeString& displayName)
 

Stable:
ICU 2.0
See also:
ResourceBundle

Definition at line 181 of file locid.h.


Member Enumeration Documentation

enum Locale::ELocaleType [private]
 

Enumeration values:
eBOGUS 

Definition at line 681 of file locid.h.


Constructor & Destructor Documentation

Locale::Locale  
 

Construct a default locale object, a Locale for the default locale ID.

See also:
getDefault , uloc_getDefault
Stable:
ICU 2.0

Locale::Locale const char *    language,
const char *    country = 0,
const char *    variant = 0,
const char *    keywordsAndValues = 0
 

Construct a locale from language, country, variant.

If an error occurs, then the constructed object will be "bogus" (isBogus() will return TRUE).

Parameters:
language  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 Locale class does NOT accept the form 'new Locale("en_US")' but only 'new Locale("en","US")'
country  Uppercase two-letter ISO-3166 code. (optional)
variant  Uppercase vendor and browser specific code. See class description. (optional)
keywordsAndValues  A string consisting of keyword/values pairs, such as "collation=phonebook;currency=euro"
See also:
getDefault , uloc_getDefault
Stable:
ICU 2.0

Locale::Locale const Locale &    other
 

Initializes a Locale object from another Locale object.

Parameters:
other  The Locale object being copied in.
Stable:
ICU 2.0

Locale::~Locale  
 

Destructor.

Stable:
ICU 2.0

Locale::Locale ELocaleType    [private]
 


Member Function Documentation

Locale* Locale::clone void    const
 

Clone this object.

Clones can be used concurrently in multiple threads. If an error occurs, then NULL is returned. The caller must delete the clone.

Returns:
a clone of this object
See also:
getDynamicClassID
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

Locale Locale::createFromName const char *    name [static]
 

Creates a locale which has had minimal canonicalization as per uloc_getName().

Parameters:
name  The name to create from. If name is null, the default Locale is used.
Returns:
new locale object
Stable:
ICU 2.0
See also:
uloc_getName

StringEnumeration* Locale::createKeywords UErrorCode   status const
 

Gets the list of keywords for the specified locale.

Returns:
pointer to StringEnumeration class. Client must dispose of it by calling delete.
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

const Locale* Locale::getAvailableLocales int32_t &    numLocales [static]
 

Returns a list of all installed locales.

Parameters:
count  Receives the number of locales in the list.
Returns:
A pointer to an array of Locale 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.
Stable:
ICU 2.0

const char* Locale::getBaseName   const
 

Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars and without keywords.

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"

Returns:
A pointer to "name".
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

const Locale& Locale::getCanada void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getCanadaFrench void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getChina void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getChinese void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const char * Locale::getCountry   const [inline]
 

Returns the locale's ISO-3166 country code.

Returns:
An alias to the code
Stable:
ICU 2.0

Definition at line 719 of file locid.h.

const Locale& Locale::getDefault void    [static]
 

Common methods of getting the current default Locale.

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.)

More advanced programs will allow users to use different locales for different fields, e.g. in a spreadsheet.

Note that the initial setting will match the host system.

Returns:
a reference to the Locale object for the default locale ID
System:
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayCountry const Locale &    displayLocale,
UnicodeString   dispCountry
const
 

Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale".

For example, if the locale's country code is "US" and displayLocale's language code is "fr", this function would set dispCountry to "Etats-Unis".

Parameters:
displayLocale  Specifies the locale to be used to display the name. In other words, if the locale's country code is "US", passing Locale::getFrench() for displayLocale would result in "États-Unis", while passing Locale::getGerman() for displayLocale would result in "Vereinigte Staaten".
dispCountry  Receives the country's display name.
Returns:
A reference to "dispCountry".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayCountry UnicodeString   dispCountry const
 

Fills in "dispCountry" with the name of this locale's country in a format suitable for user display in the default locale.

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".

Parameters:
dispCountry  Receives the country's display name.
Returns:
A reference to "dispCountry".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayLanguage const Locale &    displayLocale,
UnicodeString   dispLang
const
 

Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the locale specified by "displayLocale".

For example, if the locale's language code is "en" and displayLocale's language code is "fr", this function would set dispLang to "Anglais".

Parameters:
displayLocale  Specifies the locale to be used to display the name. In other words, if the locale's language code is "en", passing Locale::getFrench() for displayLocale would result in "Anglais", while passing Locale::getGerman() for displayLocale would result in "Englisch".
dispLang  Receives the language's display name.
Returns:
A reference to "dispLang".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayLanguage UnicodeString   dispLang const
 

Fills in "dispLang" with the name of this locale's language in a format suitable for user display in the default locale.

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".

Parameters:
dispLang  Receives the language's display name.
Returns:
A reference to "dispLang".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayName const Locale &    displayLocale,
UnicodeString   name
const
 

Fills in "name" with the name of this locale in a format suitable for user display in the locale specfied by "displayLocale".

This function uses getDisplayLanguage(), getDisplayCountry(), and getDisplayVariant() 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 (États-Unis)", and no_NO_NY's display name would be "norvégien (Norvège,NY)".

Parameters:
displayLocale  Specifies the locale to be used to display the name.
name  Receives the locale's display name.
Returns:
A reference to "name".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayName UnicodeString   name const
 

Fills in "name" with the name of this locale in a format suitable for user display in the default locale.

This function uses getDisplayLanguage(), getDisplayCountry(), and getDisplayVariant() 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)".

Parameters:
name  Receives the locale's display name.
Returns:
A reference to "name".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayScript const Locale &    displayLocale,
UnicodeString   dispScript
const
 

Fills in "dispScript" with the name of this locale's country in a format suitable for user display in the locale specified by "displayLocale".

For example, if the locale's script code is "LATN" and displayLocale's language code is "en", this function would set dispScript to "Latin".

Parameters:
displayLocale  Specifies the locale to be used to display the name. In other words, if the locale's script code is "LATN", passing Locale::getFrench() for displayLocale would result in "", while passing Locale::getGerman() for displayLocale would result in "".
dispScript  Receives the scripts's display name.
Returns:
A reference to "dispScript".
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

UnicodeString& Locale::getDisplayScript UnicodeString   dispScript const
 

Fills in "dispScript" with the name of this locale's script in a format suitable for user display in the default locale.

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".

Parameters:
dispScript  Receives the scripts's display name.
Returns:
A reference to "dispScript".
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

UnicodeString& Locale::getDisplayVariant const Locale &    displayLocale,
UnicodeString   dispVar
const
 

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".

Parameters:
displayLocale  Specifies the locale to be used to display the name.
dispVar  Receives the variant's display name.
Returns:
A reference to "dispVar".
Stable:
ICU 2.0

UnicodeString& Locale::getDisplayVariant UnicodeString   dispVar const
 

Fills in "dispVar" with the name of this locale's variant code in a format suitable for user display in the default locale.

Parameters:
dispVar  Receives the variant's name.
Returns:
A reference to "dispVar".
Stable:
ICU 2.0

virtual UClassID Locale::getDynamicClassID void    const [virtual]
 

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
ICU 2.2

Reimplemented from UObject.

const Locale& Locale::getEnglish void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const Locale& Locale::getFrance void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getFrench void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const Locale& Locale::getGerman void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const Locale& Locale::getGermany void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const char* Locale::getISO3Country   const
 

Fills in "name" with the locale's three-letter ISO-3166 country code.

Returns:
An alias to the code, or NULL
Stable:
ICU 2.0

const char* Locale::getISO3Language   const
 

returns the locale's three-letter language code, as specified in ISO draft standard ISO-639-2..

Returns:
An alias to the code, or NULL
Stable:
ICU 2.0

const char* const* Locale::getISOCountries   [static]
 

Gets a list of all available 2-letter country codes defined in ISO 639.

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.

Returns:
a list of all available country codes
Stable:
ICU 2.0

const char* const* Locale::getISOLanguages   [static]
 

Gets a list of all available language codes defined in ISO 639.

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.

Returns:
a list of all available language codes
Stable:
ICU 2.0

const Locale& Locale::getItalian void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const Locale& Locale::getItaly void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getJapan void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getJapanese void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

int32_t Locale::getKeywordValue const char *    keywordName,
char *    buffer,
int32_t    bufLen,
UErrorCode   status
const
 

Get the value for a keyword.

Parameters:
keywordName  name of the keyword for which we want the value. Case insensitive.
Returns:
pointer to the keyword value owned by the Locale object or NULL if there is no such a keyword.
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

const Locale& Locale::getKorea void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getKorean void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

uint32_t Locale::getLCID void    const
 

Returns the Windows LCID value corresponding to this locale.

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.

Stable:
ICU 2.0

const char * Locale::getLanguage   const [inline]
 

Returns the locale's ISO-639 language code.

Returns:
An alias to the code
Stable:
ICU 2.0

Definition at line 725 of file locid.h.

const Locale& Locale::getLocale int    locid [static, private]
 

Locale* Locale::getLocaleCache void    [static, private]
 

Initialize the locale cache for commonly used locales.

const char * Locale::getName   const [inline]
 

Returns the programmatic name of the entire locale, with the language, country and variant separated by underbars.

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"

Returns:
A pointer to "name".
Stable:
ICU 2.0

Definition at line 743 of file locid.h.

Referenced by RuleBasedCollator::setUCollator().

const Locale& Locale::getPRC void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const char * Locale::getScript   const [inline]
 

Returns the locale's ISO-15924 abbreviation script code.

Returns:
An alias to the code
See also:
uscript_getShortName , uscript_getCode
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

Definition at line 731 of file locid.h.

const Locale& Locale::getSimplifiedChinese void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

UClassID Locale::getStaticClassID void    [static]
 

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:
ICU 2.2

const Locale& Locale::getTaiwan void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getTraditionalChinese void    [static]
 

Useful constant for this language.

Stable:
ICU 2.0

const Locale& Locale::getUK void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const Locale& Locale::getUS void    [static]
 

Useful constant for this country/region.

Stable:
ICU 2.0

const char * Locale::getVariant   const [inline]
 

Returns the locale's variant code.

Returns:
An alias to the code
Stable:
ICU 2.0

Definition at line 737 of file locid.h.

int32_t Locale::hashCode void    const
 

Generates a hash code for the locale.

Stable:
ICU 2.0

Locale& Locale::init const char *    cLocaleID [private]
 

Initialize the locale object with a new name.

Was deprecated - used in implementation - moved internal

Parameters:
cLocaleID  The new locale name.

UBool Locale::isBogus void    const [inline]
 

Gets the bogus state.

Locale object can be bogus if it doesn't exist

Returns:
FALSE if it is a real locale, TRUE if it is a bogus locale
Stable:
ICU 2.1

Definition at line 749 of file locid.h.

UBool Locale::operator!= const Locale &    other const [inline]
 

Checks if two locale keys are not the same.

Parameters:
other  The locale key object to be compared with this.
Returns:
True if the two locale keys are not the same, false otherwise.
Stable:
ICU 2.0

Definition at line 713 of file locid.h.

Locale& Locale::operator= const Locale &    other
 

Replaces the entire contents of *this with the specified value.

Parameters:
other  The Locale object being copied in.
Returns:
*this
Stable:
ICU 2.0

UBool Locale::operator== const Locale &    other const
 

Checks if two locale keys are the same.

Parameters:
other  The locale key object to be compared with this.
Returns:
True if the two locale keys are the same, false otherwise.
Stable:
ICU 2.0

Referenced by operator!=().

void Locale::setDefault const Locale &    newLocale,
UErrorCode   success
[static]
 

Sets the default.

Normally set once at the beginning of a process, then never reset. setDefault() only changes ICU's default locale ID, not the default locale ID of the runtime environment.

Parameters:
newLocale  Locale to set to. If NULL, set to the value obtained from the runtime environement.
success  The error code.
System:
Stable:
ICU 2.0

void Locale::setFromPOSIXID const char *    posixID [protected]
 

Set this from a single POSIX style locale string.

Internal:
For internal use only.

void Locale::setToBogus  
 

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).

Stable:
ICU 2.1


Friends And Related Function Documentation

void locale_set_default_internal const char *    [friend]
 

A friend to allow the default locale to be set by either the C or C++ API.

Internal:
For internal use only.


Member Data Documentation

char* Locale::baseName [private]
 

Definition at line 698 of file locid.h.

char Locale::baseNameBuffer[ULOC_FULLNAME_CAPACITY] [private]
 

Definition at line 699 of file locid.h.

char Locale::country[ULOC_COUNTRY_CAPACITY] [private]
 

Definition at line 693 of file locid.h.

UBool Locale::fIsBogus [private]
 

Definition at line 701 of file locid.h.

char* Locale::fullName [private]
 

Definition at line 695 of file locid.h.

char Locale::fullNameBuffer[ULOC_FULLNAME_CAPACITY] [private]
 

Definition at line 696 of file locid.h.

char Locale::language[ULOC_LANG_CAPACITY] [private]
 

Definition at line 691 of file locid.h.

char Locale::script[ULOC_SCRIPT_CAPACITY] [private]
 

Definition at line 692 of file locid.h.

int32_t Locale::variantBegin [private]
 

Definition at line 694 of file locid.h.


The documentation for this class was generated from the following file:
Generated on Mon Nov 24 14:36:38 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001