docshell/base/nsIWebPageDescriptor.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4 #include "nsISupports.idl"
   5
   6 /**
   7  * The nsIWebPageDescriptor interface allows content being displayed in one
   8  * window to be loaded into another window without refetching it from the
   9  * network.
  10  */
  11
  12 [scriptable, uuid(6f30b676-3710-4c2c-80b1-0395fb26516e)]
  13 interface nsIWebPageDescriptor : nsISupports
  14 {
  15   const unsigned long DISPLAY_AS_SOURCE = 0x0001;
  16   const unsigned long DISPLAY_NORMAL    = 0x0002;
  17
  18  /**
  19   * Tells the object to load the page specified by the page descriptor
  20   *
  21   * @throws NS_ERROR_FAILURE -
  22   */
  23   void loadPage(in nsISupports aPageDescriptor, in unsigned long aDisplayType);
  24
  25
  26  /**
  27   * Retrieves the page descriptor for the curent document.
  28   */
  29   readonly attribute nsISupports currentDescriptor;
  30 };