docshell/base/nsIWebPageDescriptor.idl
author Gervase Markham <gerv@gerv.net>
Mon, 21 May 2012 12:12:37 +0100
changeset 98529 f4157e8c410708d76703f19e4dfb61859bfe32d8
parent 47159 84c1694a4ca9af3a0fd5605a7ec0e9b9e7bd0129
child 143576 fcfeafc7cf398ab7488855616882606f928f0514
permissions -rw-r--r--
Bug 716478 - update licence to MPL 2.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"

/**
 * The nsIWebPageDescriptor interface allows content being displayed in one
 * window to be loaded into another window without refetching it from the
 * network.
 */

[scriptable, uuid(6f30b676-3710-4c2c-80b1-0395fb26516e)]
interface nsIWebPageDescriptor : nsISupports
{
  const unsigned long DISPLAY_AS_SOURCE = 0x0001;
  const unsigned long DISPLAY_NORMAL    = 0x0002;

 /**
  * Tells the object to load the page specified by the page descriptor
  *
  * @return NS_OK            - 
  *         NS_ERROR_FAILURE - 
  */
  void loadPage(in nsISupports aPageDescriptor, in unsigned long aDisplayType);


 /**
  * Retrieves the page descriptor for the curent document.
  */
  readonly attribute nsISupports currentDescriptor;
};