Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgStringService.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; 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 /* The nsIMsgStringService is a a generic interface for our
00039    component based string bundle services. The idea is to have
00040    say imap implement this interface for the imap string bundle. 
00041    local will have its own version of the service for local 
00042    strings (pop, mailbox). 
00043 
00044    The first time the service is asked to fetch the string for an ID, 
00045    it will cache the string bundle that is returned and re-use it for 
00046    all future requests.
00047 */
00048 #include "nsISupports.idl"
00049 
00050 #include "nsIStringBundle.idl"
00051 
00052 [scriptable, uuid(6AC107B1-D558-11d3-98B1-001083010E9B)]
00053 interface nsIMsgStringService : nsISupports {
00054   /* GetStringByID --> pass in the ID for the string you are
00055      interested in. You get back a PRUnichar * which you must
00056      of course release
00057   */
00058   wstring getStringByID (in long aStringID);
00059   readonly attribute nsIStringBundle bundle;
00060 };
00061 
00062 %{C++
00063 #define NS_MAILNEWS_STRINGSERVICE_CONTRACTID      "@mozilla.org/messenger/stringservice;1"
00064 #define NS_MAILNEWS_STRINGSERVICE_CONTRACTID_PREFIX NS_MAILNEWS_STRINGSERVICE_CONTRACTID"?type="
00065 %}