nsILocaleService

Implemented by: @mozilla.org/intl/nslocaleservice;1. To use this service, use:

var localeService = Components.classes["@mozilla.org/intl/nslocaleservice;1"]
                              .getService(Components.interfaces.nsILocaleService);

 Method overview

Methods

getApplicationLocale()

Gets the user preference for locale from the operating system.

nsILocale getApplicationLocale();

Parameters

None.

Return value

The user's OS setting for preferred locale.

getLocaleComponentForUserAgent()

Gets the user preference for locale from the operating system.

AString getLocaleComponentForUserAgent();

Parameters

None.

Return value

The user's OS setting for preferred locale in the format described in nsILocale.

getLocaleFromAcceptLanguage()

Gets the most preferred locale from a list of locale preferences.

nsILocale getLocaleFromAcceptLanguage(
  in string acceptLanguage
);

Parameters

acceptLanguage

Locale preference in the same format as the Accept-Language HTTP header.

Return value

The most preferred locale according to the acceptLanguage parameter.

getSystemLocale()

Gets the user preference for locale from the operating system.

nsILocale getSystemLocale();

Parameters

None.

Return value

The user's OS setting for preferred locale.

newLocale()

Create a new nsILocale from a locale string.

nsILocale newLocale(
  in AString aLocale
);

Parameters

aLocale

A locale code as described in nsILocale.

Return value

A nsILocale representing the given locale.

nsILocale newLocaleObject(
  in nsILocaleDefinition localeDefinition
);

Parameters

localeDefinition

A locale definition as described in nsILocaleDefinition.

Return value

A nsILocale representing the given locale. Calls to its getCategory method return the values originally passed to the locale definition's addCategory method.