docshell/base/nsIWebPageDescriptor.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corp.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36 #include "nsISupports.idl"
  37
  38 /**
  39  * The nsIWebPageDescriptor interface allows content being displayed in one
  40  * window to be loaded into another window without refetching it from the
  41  * network.
  42  */
  43
  44 [scriptable, uuid(6f30b676-3710-4c2c-80b1-0395fb26516e)]
  45 interface nsIWebPageDescriptor : nsISupports
  46 {
  47   const unsigned long DISPLAY_AS_SOURCE = 0x0001;
  48   const unsigned long DISPLAY_NORMAL    = 0x0002;
  49
  50  /**
  51   * Tells the object to load the page specified by the page descriptor
  52   *
  53   * @return NS_OK            -
  54   *         NS_ERROR_FAILURE -
  55   */
  56   void loadPage(in nsISupports aPageDescriptor, in unsigned long aDisplayType);
  57
  58
  59  /**
  60   * Retrieves the page descriptor for the curent document.
  61   */
  62   readonly attribute nsISupports currentDescriptor;
  63 };