content/base/public/nsIFrameLoader.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 Communicator client 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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Johnny Stenback <jst@netscape.com> (original author)
  24  *   Brian Ryner <bryner@brianryner.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42 interface nsIDocShell;
  43 interface nsIURI;
  44
  45 [scriptable, uuid(d675c531-6bdc-417c-b176-635060105f07)]
  46 interface nsIFrameLoader : nsISupports
  47 {
  48   /**
  49    * Get the docshell from the frame loader.
  50    */
  51   readonly attribute nsIDocShell docShell;
  52
  53   /**
  54    * Start loading the frame. This method figures out what to load
  55    * from the owner content in the frame loader.
  56    */
  57   void loadFrame();
  58
  59   /**
  60    * Loads the specified URI in this frame. Behaves identically to loadFrame,
  61    * except that this method allows specifying the URI to load.
  62    */
  63   void loadURI(in nsIURI aURI);
  64
  65   /**
  66    * Destroy the frame loader and everything inside it. This will
  67    * clear the weak owner content reference.
  68    */
  69   void destroy();
  70
  71   /**
  72    * Find out whether the loader's frame is at too great a depth in
  73    * the frame tree.  This can be used to decide what operations may
  74    * or may not be allowed on the loader's docshell.
  75    */
  76   readonly attribute boolean depthTooGreat;
  77 };
  78
  79 [scriptable, uuid(641c2d90-4ada-4367-bdb1-80831614161d)]
  80 interface nsIFrameLoaderOwner : nsISupports
  81 {
  82   /**
  83    * The frame loader owned by this nsIFrameLoaderOwner
  84    */
  85   readonly attribute nsIFrameLoader frameLoader;
  86
  87   /**
  88    * Swap frame loaders with the given nsIFrameLoaderOwner.  This may
  89    * only be posible in a very limited range of circumstances, or
  90    * never, depending on the object implementing this interface.
  91    *
  92    * @throws NS_ERROR_NOT_IMPLEMENTED if the swapping logic is not
  93    *   implemented for the two given frame loader owners.
  94    * @throws NS_ERROR_DOM_SECURITY_ERR if the swap is not allowed on
  95    *   security grounds.
  96    */
  97   void swapFrameLoaders(in nsIFrameLoaderOwner aOtherOwner);
  98 };