uriloader/base/nsIDocumentLoader.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1999
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 interface nsILoadGroup;
  40 interface nsIChannel;
  41 interface nsIURI;
  42 interface nsIWebProgress;
  43 interface nsIRequest;
  44
  45 /**
  46  * An nsIDocumentLoader is an interface responsible for tracking groups of
  47  * loads that belong together (images, external scripts, etc) and subdocuments
  48  * (<iframe>, <frame>, etc). It is also responsible for sending
  49  * nsIWebProgressListener notifications.
  50  * XXXbz this interface should go away, we think...
  51  */
  52 [scriptable, uuid(bbe961ee-59e9-42bb-be50-0331979bb79f)]
  53 interface nsIDocumentLoader : nsISupports
  54 {
  55   // Stop all loads in the loadgroup of this docloader
  56   void stop();
  57
  58   // XXXbz is this needed?  For embedding?  What this does is does is not
  59   // defined by this interface!
  60   readonly attribute nsISupports container;
  61
  62   // The loadgroup associated with this docloader
  63   readonly attribute nsILoadGroup loadGroup;
  64
  65   // The defaultLoadRequest of the loadgroup associated with this docloader
  66   readonly attribute nsIChannel documentChannel;
  67 };
  68