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 interface nsIDocShell;
   6
   7 /**
   8  * The nsIWebPageDescriptor interface allows content being displayed in one
   9  * window to be loaded into another window without refetching it from the
  10  * network.
  11  */
  12
  13 [scriptable, uuid(6f30b676-3710-4c2c-80b1-0395fb26516e)]
  14 interface nsIWebPageDescriptor : nsISupports
  15 {
  16  /**
  17   * Tells the object to load the page that otherDocShell is currently loading,
  18   * or has loaded already, as view source, with the url being `aURL`.
  19   *
  20   * @throws NS_ERROR_FAILURE - NS_ERROR_INVALID_POINTER
  21   */
  22   void loadPageAsViewSource(in nsIDocShell otherDocShell, in AString aURL);
  23
  24
  25  /**
  26   * Retrieves the page descriptor for the curent document.
  27   * @note, currentDescriptor is currently always an nsISHEntry object or null.
  28   */
  29   readonly attribute nsISupports currentDescriptor;
  30 };