mozilla
Your Search Results

    nsILocaleService

    The Locale service interface.
    1.0
    28
    Introduced
    Gecko 1.6
    Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3)

    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

    nsILocale getApplicationLocale();
    AString getLocaleComponentForUserAgent();
    nsILocale getLocaleFromAcceptLanguage(in string acceptLanguage);
    nsILocale getSystemLocale();
    nsILocale newLocale(in AString aLocale);
    nsILocale newLocaleObject(in nsILocaleDefinition localeDefinition); Obsolete since Gecko 1.9

    Methods

    getApplicationLocale()

    Gets the user preference for locale from the operating system.

    Note: This has nothing to do with the locale used for localization of the application (UI text strings and so on.). This method returns something similar to getSystemLocale.

    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.

    Note: This has nothing to do with any HTTP User-Agent. This method returns the same as getSystemLocale.getCategory("NSILOCALE_MESSAGES").

    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.

    Obsolete since Gecko 1.9 (Firefox 3)

    newLocaleObject()

    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.

    Document Tags and Contributors

    Contributors to this page: Sheppy, trevorh, fscholz, Neil
    Last updated by: Sheppy,