docshell/base/nsIWebPageDescriptor.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

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

mercurial