Back to index

lightning-sunbird  0.9+nobinonly
nsIXPTLoader.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 the external XPT loader interface.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corp.
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   John Bandhauer <jband@netscape.com>
00024  *   Alec Flett <alecf@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 
00041 #include "nsISupports.idl"
00042 #include "nsILocalFile.idl"
00043 #include "nsIInputStream.idl"
00044 
00049 [scriptable, uuid(6E48C500-8682-4730-ADD6-7DB693B9E7BA)]
00050 interface nsIXPTLoaderSink : nsISupports {
00051     
00058     void foundEntry(in string itemName,
00059                     in long index,
00060                     in nsIInputStream xptData);
00061 };
00062 
00067 [scriptable, uuid(368A15D9-17A9-4c2b-AC3D-A35B3A22B876)]
00068 interface nsIXPTLoader : nsISupports {
00078     void enumerateEntries(in nsILocalFile file,
00079                           in nsIXPTLoaderSink sink );
00080 
00088     nsIInputStream loadEntry(in nsILocalFile file,
00089                              in string name);
00090 };
00091 
00092 
00093 %{C++
00094 
00095 // the first part of the contractID for any loader
00096 // append the type of loader that you need, such as "zip"
00097 #define NS_XPTLOADER_CONTRACTID_PREFIX \
00098    "@mozilla.org/xptinfo/loader;1&type="
00099 
00100 %}