webshell/public/nsIDocumentLoaderFactory.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIChannel;
  42 interface nsIContentViewer;
  43 interface nsIStreamListener;
  44 interface nsIDocument;
  45 interface nsILoadGroup;
  46 interface nsIPrincipal;
  47
  48 /**
  49  * To get a component that implements nsIDocumentLoaderFactory
  50  * for a given mimetype, use nsICategoryManager to find an entry
  51  * with the mimetype as its name in the category "Gecko-Content-Viewers".
  52  * The value of the entry is the contractid of the component.
  53  * The component is a service, so use GetService, not CreateInstance to get it.
  54  */
  55
  56 [scriptable, uuid(5e7d2967-5a07-444f-95d5-25b533252d38)]
  57 interface nsIDocumentLoaderFactory : nsISupports {
  58     nsIContentViewer createInstance(in string aCommand,
  59                               in nsIChannel aChannel,
  60                               in nsILoadGroup aLoadGroup,
  61                               in string aContentType,
  62                               in nsISupports aContainer,
  63                               in nsISupports aExtraInfo,
  64                               out nsIStreamListener aDocListenerResult);
  65
  66     nsIContentViewer createInstanceForDocument(in nsISupports aContainer,
  67                                          in nsIDocument aDocument,
  68                                          in string aCommand);
  69
  70     /**
  71      * Create a blank document using the given loadgroup and given
  72      * principal.  aPrincipal is allowed to be null, in which case the
  73      * new document will get the about:blank codebase principal.
  74      */
  75     nsIDocument createBlankDocument(in nsILoadGroup aLoadGroup,
  76                                     in nsIPrincipal aPrincipal);
  77 };