/* -*- 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/. * * The origin of this IDL file is: * http://www.whatwg.org/specs/web-apps/current-work/ * https://dvcs.w3.org/hg/editing/raw-file/tip/editing.html * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html * http://dev.w3.org/csswg/cssom/ * http://dev.w3.org/csswg/cssom-view/ * https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/RequestAnimationFrame/Overview.html * https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html * https://dvcs.w3.org/hg/webcrypto-api/raw-file/tip/spec/Overview.html * http://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html * https://w3c.github.io/webappsec-secure-contexts/#monkey-patching-global-object * https://w3c.github.io/requestidlecallback/ * https://drafts.css-houdini.org/css-paint-api-1/#dom-window-paintworklet */ interface ApplicationCache; interface IID; interface nsIBrowserDOMWindow; interface XULControllers; // http://www.whatwg.org/specs/web-apps/current-work/ [PrimaryGlobal, LegacyUnenumerableNamedProperties, NeedResolve] /*sealed*/ interface Window : EventTarget { // the current browsing context [Unforgeable, Constant, StoreInSlot, CrossOriginReadable] readonly attribute Window window; [Replaceable, Constant, StoreInSlot, CrossOriginReadable] readonly attribute Window self; [Unforgeable, StoreInSlot, Pure] readonly attribute Document? document; [Throws] attribute DOMString name; [PutForwards=href, Unforgeable, BinaryName="getLocation", CrossOriginReadable, CrossOriginWritable] readonly attribute Location location; [Throws] readonly attribute History history; [Func="CustomElementRegistry::IsCustomElementEnabled"] readonly attribute CustomElementRegistry customElements; [Replaceable, Throws] readonly attribute BarProp locationbar; [Replaceable, Throws] readonly attribute BarProp menubar; [Replaceable, Throws] readonly attribute BarProp personalbar; [Replaceable, Throws] readonly attribute BarProp scrollbars; [Replaceable, Throws] readonly attribute BarProp statusbar; [Replaceable, Throws] readonly attribute BarProp toolbar; [Throws] attribute DOMString status; [Throws, CrossOriginCallable] void close(); [Throws, CrossOriginReadable] readonly attribute boolean closed; [Throws] void stop(); [Throws, CrossOriginCallable] void focus(); [Throws, CrossOriginCallable] void blur(); [Replaceable] readonly attribute any event; // other browsing contexts [Replaceable, Throws, CrossOriginReadable] readonly attribute WindowProxy frames; [Replaceable, CrossOriginReadable] readonly attribute unsigned long length; //[Unforgeable, Throws, CrossOriginReadable] readonly attribute WindowProxy top; [Unforgeable, Throws, CrossOriginReadable] readonly attribute WindowProxy? top; [Throws, CrossOriginReadable] attribute any opener; //[Throws] readonly attribute WindowProxy parent; [Replaceable, Throws, CrossOriginReadable] readonly attribute WindowProxy? parent; [Throws, NeedsSubjectPrincipal] readonly attribute Element? frameElement; //[Throws] WindowProxy? open(optional USVString url = "about:blank", optional DOMString target = "_blank", [TreatNullAs=EmptyString] optional DOMString features = ""); [Throws] WindowProxy? open(optional DOMString url = "", optional DOMString target = "", [TreatNullAs=EmptyString] optional DOMString features = ""); getter object (DOMString name); // the user agent readonly attribute Navigator navigator; #ifdef HAVE_SIDEBAR [Replaceable, Throws] readonly attribute External external; #endif [Throws, Pref="browser.cache.offline.enable", Func="nsGlobalWindowInner::OfflineCacheAllowedForContext"] readonly attribute ApplicationCache applicationCache; // user prompts [Throws, NeedsSubjectPrincipal] void alert(); [Throws, NeedsSubjectPrincipal] void alert(DOMString message); [Throws, NeedsSubjectPrincipal] boolean confirm(optional DOMString message = ""); [Throws, NeedsSubjectPrincipal] DOMString? prompt(optional DOMString message = "", optional DOMString default = ""); [Throws, Func="nsGlobalWindowInner::IsWindowPrintEnabled"] void print(); [Throws, CrossOriginCallable, NeedsSubjectPrincipal] void postMessage(any message, DOMString targetOrigin, optional sequence transfer = []); // also has obsolete members }; Window implements GlobalEventHandlers; Window implements WindowEventHandlers; // https://www.w3.org/TR/appmanifest/#onappinstalled-attribute partial interface Window { [Pref="dom.manifest.onappinstalled"] attribute EventHandler onappinstalled; }; // http://www.whatwg.org/specs/web-apps/current-work/ [NoInterfaceObject] interface WindowSessionStorage { //[Throws] readonly attribute Storage sessionStorage; [Throws] readonly attribute Storage? sessionStorage; }; Window implements WindowSessionStorage; // http://www.whatwg.org/specs/web-apps/current-work/ [NoInterfaceObject] interface WindowLocalStorage { [Throws] readonly attribute Storage? localStorage; }; Window implements WindowLocalStorage; // http://www.whatwg.org/specs/web-apps/current-work/ partial interface Window { void captureEvents(); void releaseEvents(); }; // https://dvcs.w3.org/hg/editing/raw-file/tip/editing.html partial interface Window { //[Throws] Selection getSelection(); [Throws] Selection? getSelection(); }; // http://dev.w3.org/csswg/cssom/ partial interface Window { //[NewObject, Throws] CSSStyleDeclaration getComputedStyle(Element elt, optional DOMString pseudoElt = ""); [NewObject, Throws] CSSStyleDeclaration? getComputedStyle(Element elt, optional DOMString pseudoElt = ""); }; // http://dev.w3.org/csswg/cssom-view/ enum ScrollBehavior { "auto", "instant", "smooth" }; dictionary ScrollOptions { ScrollBehavior behavior = "auto"; }; dictionary ScrollToOptions : ScrollOptions { unrestricted double left; unrestricted double top; }; partial interface Window { //[Throws, NewObject, NeedsCallerType] MediaQueryList matchMedia(DOMString query); [Throws, NewObject, NeedsCallerType] MediaQueryList? matchMedia(DOMString query); // Per spec, screen is SameObject, but we don't actually guarantee that given // nsGlobalWindow::Cleanup. :( //[SameObject, Replaceable, Throws] readonly attribute Screen screen; [Replaceable, Throws] readonly attribute Screen screen; // browsing context //[Throws] void moveTo(double x, double y); //[Throws] void moveBy(double x, double y); //[Throws] void resizeTo(double x, double y); //[Throws] void resizeBy(double x, double y); [Throws, NeedsCallerType] void moveTo(long x, long y); [Throws, NeedsCallerType] void moveBy(long x, long y); [Throws, NeedsCallerType] void resizeTo(long x, long y); [Throws, NeedsCallerType] void resizeBy(long x, long y); // viewport // These are writable because we allow chrome to write them. And they need // to use 'any' as the type, because non-chrome writing them needs to act // like a [Replaceable] attribute would, which needs the original JS value. //[Replaceable, Throws] readonly attribute double innerWidth; //[Replaceable, Throws] readonly attribute double innerHeight; [Throws, NeedsCallerType] attribute any innerWidth; [Throws, NeedsCallerType] attribute any innerHeight; // viewport scrolling void scroll(unrestricted double x, unrestricted double y); void scroll(optional ScrollToOptions options); void scrollTo(unrestricted double x, unrestricted double y); void scrollTo(optional ScrollToOptions options); void scrollBy(unrestricted double x, unrestricted double y); void scrollBy(optional ScrollToOptions options); // mozScrollSnap is used by chrome to perform scroll snapping after the // user performs actions that may affect scroll position // mozScrollSnap is deprecated, to be replaced by a web accessible API, such // as an extension to the ScrollOptions dictionary. See bug 1137937. [ChromeOnly] void mozScrollSnap(); // The four properties below are double per spec at the moment, but whether // that will continue is unclear. [Replaceable, Throws] readonly attribute double scrollX; [Replaceable, Throws] readonly attribute double pageXOffset; [Replaceable, Throws] readonly attribute double scrollY; [Replaceable, Throws] readonly attribute double pageYOffset; // client // These are writable because we allow chrome to write them. And they need // to use 'any' as the type, because non-chrome writing them needs to act // like a [Replaceable] attribute would, which needs the original JS value. //[Replaceable, Throws] readonly attribute double screenX; //[Replaceable, Throws] readonly attribute double screenY; //[Replaceable, Throws] readonly attribute double outerWidth; //[Replaceable, Throws] readonly attribute double outerHeight; [Throws, NeedsCallerType] attribute any screenX; [Throws, NeedsCallerType] attribute any screenY; [Throws, NeedsCallerType] attribute any outerWidth; [Throws, NeedsCallerType] attribute any outerHeight; }; // https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/RequestAnimationFrame/Overview.html partial interface Window { [Throws] long requestAnimationFrame(FrameRequestCallback callback); [Throws] void cancelAnimationFrame(long handle); }; callback FrameRequestCallback = void (DOMHighResTimeStamp time); // https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html partial interface Window { [Replaceable, Pure, StoreInSlot] readonly attribute Performance? performance; }; // https://dvcs.w3.org/hg/webcrypto-api/raw-file/tip/spec/Overview.html Window implements GlobalCrypto; // https://fidoalliance.org/specifications/download/ Window implements GlobalU2F; #ifdef MOZ_WEBSPEECH // http://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html [NoInterfaceObject] interface SpeechSynthesisGetter { [Throws, Pref="media.webspeech.synth.enabled"] readonly attribute SpeechSynthesis speechSynthesis; }; Window implements SpeechSynthesisGetter; #endif // Mozilla-specific stuff partial interface Window { //[NewObject, Throws] CSSStyleDeclaration getDefaultComputedStyle(Element elt, optional DOMString pseudoElt = ""); [NewObject, Throws] CSSStyleDeclaration? getDefaultComputedStyle(Element elt, optional DOMString pseudoElt = ""); // Mozilla extensions /** * Method for scrolling this window by a number of lines. */ void scrollByLines(long numLines, optional ScrollOptions options); /** * Method for scrolling this window by a number of pages. */ void scrollByPages(long numPages, optional ScrollOptions options); /** * Method for sizing this window to the content in the window. */ [Throws, NeedsCallerType] void sizeToContent(); // XXX Shouldn't this be in nsIDOMChromeWindow? [ChromeOnly, Replaceable, Throws] readonly attribute XULControllers controllers; [ChromeOnly, Throws] readonly attribute Element? realFrameElement; [Throws, NeedsCallerType] readonly attribute float mozInnerScreenX; [Throws, NeedsCallerType] readonly attribute float mozInnerScreenY; [Replaceable, Throws, NeedsCallerType] readonly attribute double devicePixelRatio; /* The maximum offset that the window can be scrolled to (i.e., the document width/height minus the scrollport width/height) */ [ChromeOnly, Throws] readonly attribute long scrollMinX; [ChromeOnly, Throws] readonly attribute long scrollMinY; [Replaceable, Throws] readonly attribute long scrollMaxX; [Replaceable, Throws] readonly attribute long scrollMaxY; [Throws] attribute boolean fullScreen; [Throws, ChromeOnly] void back(); [Throws, ChromeOnly] void forward(); [Throws, ChromeOnly, NeedsSubjectPrincipal] void home(); // XXX Should this be in nsIDOMChromeWindow? void updateCommands(DOMString action, optional Selection? sel = null, optional short reason = 0); /* Find in page. * @param str: the search pattern * @param caseSensitive: is the search caseSensitive * @param backwards: should we search backwards * @param wrapAround: should we wrap the search * @param wholeWord: should we search only for whole words * @param searchInFrames: should we search through all frames * @param showDialog: should we show the Find dialog */ [Throws] boolean find(optional DOMString str = "", optional boolean caseSensitive = false, optional boolean backwards = false, optional boolean wrapAround = false, optional boolean wholeWord = false, optional boolean searchInFrames = false, optional boolean showDialog = false); /** * Returns the number of times this document for this window has * been painted to the screen. */ [Throws] readonly attribute unsigned long long mozPaintCount; attribute EventHandler ondevicemotion; attribute EventHandler ondeviceorientation; attribute EventHandler onabsolutedeviceorientation; attribute EventHandler ondeviceproximity; attribute EventHandler onuserproximity; attribute EventHandler ondevicelight; void dump(DOMString str); /** * This method is here for backwards compatibility with 4.x only, * its implementation is a no-op */ void setResizable(boolean resizable); /** * This is the scriptable version of * nsIDOMWindow::openDialog() that takes 3 optional * arguments, plus any additional arguments are passed on as * arguments on the dialog's window object (window.arguments). */ [Throws, ChromeOnly] WindowProxy? openDialog(optional DOMString url = "", optional DOMString name = "", optional DOMString options = "", any... extraArguments); [ #ifdef NIGHTLY_BUILD ChromeOnly, #endif NonEnumerable, Replaceable, Throws, NeedsCallerType] readonly attribute object? content; [Throws, ChromeOnly] any getInterface(IID iid); /** * Same as nsIDOMWindow.windowRoot, useful for event listener targeting. */ [ChromeOnly, Throws] readonly attribute WindowRoot? windowRoot; /** * ChromeOnly method to determine if a particular window should see console * reports from service workers of the given scope. */ [ChromeOnly] boolean shouldReportForServiceWorkerScope(USVString aScope); /** * InstallTrigger is used for extension installs. Ideally it would * be something like a WebIDL namespace, but we don't support * JS-implemented static things yet. See bug 863952. */ [Replaceable] readonly attribute InstallTriggerImpl? InstallTrigger; }; Window implements TouchEventHandlers; Window implements OnErrorEventHandlerForWindow; #if defined(MOZ_WIDGET_ANDROID) // https://compat.spec.whatwg.org/#windoworientation-interface partial interface Window { [NeedsCallerType] readonly attribute short orientation; attribute EventHandler onorientationchange; }; #endif #ifdef HAVE_SIDEBAR // Mozilla extension partial interface Window { [Replaceable, Throws, UseCounter] readonly attribute (External or WindowProxy) sidebar; }; #endif callback PromiseDocumentFlushedCallback = any (); // Mozilla extensions for Chrome windows. partial interface Window { // The STATE_* constants need to match the corresponding enum in nsGlobalWindow.cpp. [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] const unsigned short STATE_MAXIMIZED = 1; [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] const unsigned short STATE_MINIMIZED = 2; [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] const unsigned short STATE_NORMAL = 3; [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] const unsigned short STATE_FULLSCREEN = 4; [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] readonly attribute unsigned short windowState; [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] readonly attribute boolean isFullyOccluded; /** * browserDOMWindow provides access to yet another layer of * utility functions implemented by chrome script. It will be null * for DOMWindows not corresponding to browsers. */ [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] attribute nsIBrowserDOMWindow? browserDOMWindow; [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void getAttention(); [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void getAttentionWithCycleCount(long aCycleCount); [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void setCursor(DOMString cursor); [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void maximize(); [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void minimize(); [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void restore(); /** * Notify a default button is loaded on a dialog or a wizard. * defaultButton is the default button. */ [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void notifyDefaultButtonLoaded(Element defaultButton); [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] readonly attribute ChromeMessageBroadcaster messageManager; /** * Returns the message manager identified by the given group name that * manages all frame loaders belonging to that group. */ [Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] ChromeMessageBroadcaster getGroupMessageManager(DOMString aGroup); /** * On some operating systems, we must allow the window manager to * handle window dragging. This function tells the window manager to * start dragging the window. This function will fail unless called * while the left mouse button is held down, callers must check this. * * Throws NS_ERROR_NOT_IMPLEMENTED if the OS doesn't support this. */ [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] void beginWindowMove(Event mouseDownEvent); /** * Calls the given function as soon as a style or layout flush for the * top-level document is not necessary, and returns a Promise which * resolves to the callback's return value after it executes. * * In the event that the window goes away before a flush can occur, the * callback will still be called and the Promise resolved as the window * tears itself down. * * Note that the callback can be called either synchronously or asynchronously * depending on whether or not flushes are pending: * * The callback will be called synchronously when calling * promiseDocumentFlushed when NO flushes are already pending. This is * to ensure that no script has a chance to dirty the DOM before the callback * is called. * * The callback will be called asynchronously if a flush is pending. * * The expected execution order is that all pending callbacks will * be fired first (and in the order that they were queued) and then the * Promise resolution handlers will all be invoked later on during the * next microtask checkpoint. * * promiseDocumentFlushed does not support re-entrancy - so calling it from * within a promiseDocumentFlushed callback will result in the inner call * throwing an NS_ERROR_FAILURE exception, and the outer Promise rejecting * with that exception. * * The callback function *must not make any changes which would require * a style or layout flush*. * * Also throws NS_ERROR_FAILURE if the window is not in a state where flushes * can be waited for (for example, the PresShell has not yet been created). * * @param {function} callback * @returns {Promise} */ [Throws, Func="nsGlobalWindowInner::IsPrivilegedChromeWindow"] Promise promiseDocumentFlushed(PromiseDocumentFlushedCallback callback); [Func="IsChromeOrXBL"] readonly attribute boolean isChromeWindow; }; partial interface Window { [Pref="dom.vr.enabled"] attribute EventHandler onvrdisplayconnect; [Pref="dom.vr.enabled"] attribute EventHandler onvrdisplaydisconnect; [Pref="dom.vr.enabled"] attribute EventHandler onvrdisplayactivate; [Pref="dom.vr.enabled"] attribute EventHandler onvrdisplaydeactivate; [Pref="dom.vr.enabled"] attribute EventHandler onvrdisplaypresentchange; }; // https://drafts.css-houdini.org/css-paint-api-1/#dom-window-paintworklet partial interface Window { [Pref="dom.paintWorklet.enabled", Throws] readonly attribute Worklet paintWorklet; }; Window implements WindowOrWorkerGlobalScope; partial interface Window { [Throws, Func="nsGlobalWindowInner::IsRequestIdleCallbackEnabled"] unsigned long requestIdleCallback(IdleRequestCallback callback, optional IdleRequestOptions options); [Func="nsGlobalWindowInner::IsRequestIdleCallbackEnabled"] void cancelIdleCallback(unsigned long handle); }; dictionary IdleRequestOptions { unsigned long timeout; }; callback IdleRequestCallback = void (IdleDeadline deadline); partial interface Window { /** * Returns a list of locales that the internationalization components * should be localized to. * * The function name refers to Regional Preferences which can be either * fetched from the internal internationalization database (CLDR), or * from the host environment. * * The result is a sorted list of valid locale IDs and it should be * used for all APIs that accept list of locales, like ECMA402 and L10n APIs. * * This API always returns at least one locale. * * Example: ["en-US", "de", "pl", "sr-Cyrl", "zh-Hans-HK"] */ [Func="IsChromeOrXBL"] sequence getRegionalPrefsLocales(); /** * Getter funcion for IntlUtils, which provides helper functions for * localization. */ [Throws, Func="IsChromeOrXBL"] readonly attribute IntlUtils intlUtils; }; Window implements WebGPUProvider;