Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: resource ::

interface XLocale

Base Interface
com::sun::star::uno::XInterface

Description
offers some operations on Locale structures.
See also
XResourceBundle
See also
Locale


Methods' Summary

create creates a locale from language, country, and variant.
getDefault the common method of getting the current default locale.
setDefault sets the default locale for the whole environment.
getAvailableLocales
getISOCountries
getISOLanguages
getLanguagesForCountry
getISO3Language
getISO3Country
getDisplayLanguage_Default
getDisplayLanguage
getDisplayCountry_Default
getDisplayCountry
getDisplayVariant_Default
getDisplayVariant
getDisplayName_Default
getDisplayName
equals

Methods' Details

create
 
com::sun::star::lang::Locale
create(
[ in ] string aLanguage,
[ in ] string aCountry,
[ in ] string aVariant );

Description
creates a locale from language, country, and variant.

NOTE: ISO 639 is not a stable standard; some of the language codes it defines (specifically iw, ji, and in) have changed. This constructor accepts both the old codes (iw, ji, and in) and the new codes (he, yi, and id), but all other API on XLocale will return only the NEW codes.

Note: The Java class Locale returns the old codes.

getDefault
 
com::sun::star::lang::Locale
getDefault();
Description
the common method of getting the current default locale.

It is used for the presentation (for menus, dialogs, etc.). It is, 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 allow users to use different locales for different fields, for example, in a spreadsheet.
Note that the initial setting will match the host system.

setDefault
 
void
setDefault(
[ in ] com::sun::star::lang::Locale newLocale );

Description
sets the default locale for the whole environment.

It is normally set once at the beginning of an application, then never reset. setDefault does not reset the host locale.

getAvailableLocales
 
sequence< com::sun::star::lang::Locale >
getAvailableLocales();
Returns
a sequence of all locales which are available in the system.
getISOCountries
 
sequence< string >
getISOCountries();
Returns
a sequence of all ISO country codes known to the component.
getISOLanguages
 
sequence< string >
getISOLanguages();
Returns
a sequence of all ISO language codes known to the component.
getLanguagesForCountry
 
sequence< string >
getLanguagesForCountry(
[ in ] string country );

Returns
a sequence for language codes which are valid within the given country.
getISO3Language
 
string
getISO3Language(
[ in ] com::sun::star::lang::Locale locale )
raises ( com::sun::star::resource::MissingResourceException );

Returns
the ISO language code for the specified locale.
getISO3Country
 
string
getISO3Country(
[ in ] com::sun::star::lang::Locale locale )
raises ( com::sun::star::resource::MissingResourceException );

Returns
the ISO country code for the specified locale.
getDisplayLanguage_Default
 
string
getDisplayLanguage_Default(
[ in ] com::sun::star::lang::Locale locale );

Returns
language code for display of field to user. If the localized name is not found, returns the ISO code. The desired user language is from the default locale.
getDisplayLanguage
 
string
getDisplayLanguage(
[ in ] com::sun::star::lang::Locale locale,
[ in ] com::sun::star::lang::Locale inLocale );

Returns
language code for display of field to user. If the localized name is not found, returns the ISO codes.
Parameter inLocale
specifies the desired user language.
Example
"English (UK)", "Deutch", "Germany"
getDisplayCountry_Default
 
string
getDisplayCountry_Default(
[ in ] com::sun::star::lang::Locale locale );

Returns
country code for display of field to user. If the localized name is not found, returns the ISO code. The desired user country is from the default locale.
getDisplayCountry
 
string
getDisplayCountry(
[ in ] com::sun::star::lang::Locale locale,
[ in ] com::sun::star::lang::Locale inLocale );

Returns
country code for display of field to user. If the localized name is not found, returns the ISO codes.
Parameter inLocale
specifies the desired user country.
getDisplayVariant_Default
 
string
getDisplayVariant_Default(
[ in ] com::sun::star::lang::Locale locale );

Returns
variant code for display of field to user. The desired user variant is from the default locale.
getDisplayVariant
 
string
getDisplayVariant(
[ in ] com::sun::star::lang::Locale locale,
[ in ] com::sun::star::lang::Locale inLocale );

Returns
variant code for display of field to user. If the localized name is not found, returns the ISO codes.
Parameter inLocale
specifies the desired user variant.
getDisplayName_Default
 
string
getDisplayName_Default(
[ in ] com::sun::star::lang::Locale locale );

Returns
a string to display the entire locale to user. If the localized name is not found, uses the ISO codes. The default locale is used for the presentation language.
getDisplayName
 
string
getDisplayName(
[ in ] com::sun::star::lang::Locale locale,
[ in ] com::sun::star::lang::Locale inLocale );

Returns
a string to display the entire locale to user. If the localized name is not found, uses the ISO codes.
Parameter inLocale
specifies the desired user locale.
equals
 
boolean
equals(
[ in ] com::sun::star::lang::Locale l1,
[ in ] com::sun::star::lang::Locale l2 );

Returns
true if the Locale l1 is equal to the other one.

A locale is deemed equal to another locale with identical language, country, and variant, and unequal to all other objects.


Top of Page