Back to index

lightning-sunbird  0.9+nobinonly
nsIStringBundle.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 #include "nsISimpleEnumerator.idl"
00040 
00041 %{C++
00042 
00043 // Define Contractid and CID
00044 // {D85A17C1-AA7C-11d2-9B8C-00805F8A16D9}
00045 #define NS_STRINGBUNDLESERVICE_CID \
00046 { 0xd85a17c1, 0xaa7c, 0x11d2, \
00047   { 0x9b, 0x8c, 0x0, 0x80, 0x5f, 0x8a, 0x16, 0xd9 } }
00048 
00049 #define NS_STRINGBUNDLE_CONTRACTID "@mozilla.org/intl/stringbundle;1"
00050 
00054 #define NS_STRBUNDLE_LOADED_TOPIC "strbundle-loaded"
00055 
00056 %}
00057 
00058 native nsStrBundleLoadedFunc(nsStrBundleLoadedFunc);
00059 
00060 [scriptable, uuid(D85A17C2-AA7C-11d2-9B8C-00805F8A16D9)]
00061 interface nsIStringBundle : nsISupports
00062 {
00063   wstring GetStringFromID(in long aID);
00064   wstring GetStringFromName(in wstring aName);
00065 
00066   // this is kind of like smprintf - except that you can
00067   // only pass it unicode strings, using the %S formatting character.
00068   // the id or name should refer to a string in the bundle that
00069   // uses %S.. do NOT try to use any other types.
00070   // this uses nsTextFormatter::smprintf to do the dirty work.
00071   wstring formatStringFromID(in long aID,
00072                              [array, size_is(length)] in wstring params,
00073                              in unsigned long length);
00074   wstring formatStringFromName(in wstring aName,
00075                                [array, size_is(length)] in wstring params,
00076                                in unsigned long length);
00077   /*
00078   Implements nsISimpleEnumerator, replaces nsIEnumerator 
00079   */
00080   nsISimpleEnumerator getSimpleEnumeration();
00081 
00082 };
00083 
00084 [scriptable, uuid(D85A17C0-AA7C-11d2-9B8C-00805F8A16D9)]
00085 interface nsIStringBundleService : nsISupports
00086 {
00087   nsIStringBundle createBundle(in string aURLSpec);
00088   nsIStringBundle createExtensibleBundle(in string aRegistryKey);
00089 
00098   wstring formatStatusMessage(in nsresult aStatus, in wstring aStatusArg);
00099 
00109   void flushBundles();
00110 };