Overview | Module | Use | Devguide | Index

Elements' Summary | Elements' Details

:: com :: sun :: star :: lang ::
struct Locale
Description 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. Because a`Locale` object is just an identifier for a region, no validity check is performed. If you want to see whether particular resources are available for the`Locale` , use the XLocale::getAvailableLocales method to ask for the locales it supports. Note: When you ask for a resource for a particular locale, you get the best available match, not necessarily precisely what you asked for. For more information, see ::com::sun::star::resource::XResourceBundle . Each implementation that performs locale-sensitive operations allows you to get all the available objects of that type. Use the ::com::sun::star::resource::XLocale interface to set the locale.

Elements' Summary
Language | specifies an ISO Language Code .
Country | specifies an ISO Country Code.
Variant | contains a variant of the locale; codes are vendor and browser-specific.

Elements' Details
Language
string Language; Description specifies an 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` . If this field contains an empty string, the meaning depends on the context.
Country
string Country; Description specifies an 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` . If this field contains an empty string, the meaning depends on the context.
Variant
string Variant; Description contains a variant of the locale; codes are vendor and browser-specific. For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX. Wherever there are two variants, separate them with an underscore, and put the most important one first. For example, a traditional Spanish collation might construct a locale with parameters for language, country and variant as: "es", "ES", "Traditional_WIN".

Top of Page

Copyright © 2003 Sun Microsystems, Inc.