gecko/intl/locale/idl/nsILocaleService.idl

110 lines
3.9 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "nsILocale.idl"
/**
* The Locale service interface. This is a singleton object, and should be
* obtained from the <tt>nsServiceManager</tt>.
*/
[scriptable, uuid(c2edc848-4219-4440-abbf-98119882c83f)]
interface nsILocaleService : nsISupports
{
/**
* Create a new nsILocale from a locale string.
*
* @param aLocale
* A locale code as described in nsILocale.
* @return A nsILocale representing the given locale.
*/
nsILocale newLocale(in AString aLocale);
/**
* Get the user preference for locale from the operating system.
*
* @return User's OS setting for preferred locale.
*/
nsILocale getSystemLocale();
/**
* Get 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 etc.). This method returns something
* similar to getSystemLocale.
*
* @return User's OS setting for preferred locale.
*/
nsILocale getApplicationLocale();
/**
* Get the most preferred locale from a list of locale preferences.
*
* @param acceptLanguage
* Locale preference in the same format as the Accept-Language HTTP
* header.
* @return The most preferred locale according to the acceptLanguage
* parameter.
*/
nsILocale getLocaleFromAcceptLanguage(in string acceptLanguage);
/**
* Get 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, but as a string.
*
* @return User's OS setting for preferred locale in the format described
* in nsILocale.
*/
AString getLocaleComponentForUserAgent();
};
%{C++
// {C8E518C1-47AE-11d3-91CD-00105AA3F7DC}
#define NS_LOCALESERVICE_CID {0xc8e518c1,0x47ae,0x11d3,{0x91,0xcd,0x0,0x10,0x5a,0xa3,0xf7,0xdc}}
#define NS_LOCALESERVICE_CONTRACTID "@mozilla.org/intl/nslocaleservice;1"
extern nsresult
NS_NewLocaleService(nsILocaleService** result);
%}