gecko-dev/dom/webidl/MozFrameLoaderOwner.webidl
Nika Layzell f103e26834 Bug 1579213 - Remove unused fields from ChangeRemoteness API, r=farre
This patch changes a few things about how nsFrameLoader is created, specifically
around the ChangeRemoteness API.

1. The private 'nsFrameLoader::nsFrameLoader' constructor has been simplified to
   only have one overload, shared by the different `::Create` static methods.

2. The creation static method used by `ChangeRemoteness` has changed name to
   `::Recreate`, as the signature is becoming more like the old method.

3. The `mNetworkCreated` bit is preserved when doing a `ChangeRemoteness`, as a
   remoteness change shouldn't be affecting that property.

4. Unused fields are removed from the ChangeRemoteness API.

5. The `remoteType` attribute is now mandatory in the ChangeRemoteness API,
   which simplifies the logic and makes it harder to accidentally misuse.

Differential Revision: https://phabricator.services.mozilla.com/D44893

--HG--
extra : moz-landing-system : lando
2019-09-11 08:09:58 +00:00

51 lines
1.6 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 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/.
*/
dictionary RemotenessOptions {
required DOMString? remoteType;
// Used to indicate that there is an error condition that needs to
// be handled.
unsigned long error;
// Used to resume a given channel load within the target process. If present,
// it will be used rather than the `src` & `srcdoc` attributes on the
// frameloader to control the load behaviour.
unsigned long long pendingSwitchID;
boolean replaceBrowsingContext = false;
};
/**
* An interface implemented by elements that are 'browsing context containers'
* in HTML5 terms (that is, elements such as iframe that creates a new
* browsing context):
*
* https://html.spec.whatwg.org/#browsing-context-container
*
* Object implementing this interface must implement nsFrameLoaderOwner in
* native C++ code.
*/
[NoInterfaceObject]
interface MozFrameLoaderOwner {
[ChromeOnly]
readonly attribute FrameLoader? frameLoader;
[ChromeOnly]
readonly attribute BrowsingContext? browsingContext;
[ChromeOnly, Throws]
void presetOpenerWindow(WindowProxy? window);
[ChromeOnly, Throws]
void swapFrameLoaders(XULFrameElement aOtherLoaderOwner);
[ChromeOnly, Throws]
void swapFrameLoaders(HTMLIFrameElement aOtherLoaderOwner);
[ChromeOnly, Throws]
void changeRemoteness(RemotenessOptions aOptions);
};