michael@0: /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "domstubs.idl"
michael@0: 
michael@0: interface nsIFrameRequestCallback;
michael@0: interface nsIControllers;
michael@0: interface nsIDOMBlob;
michael@0: interface nsIDOMLocation;
michael@0: interface nsIDOMOfflineResourceList;
michael@0: interface nsIDOMStorage;
michael@0: interface nsIPrompt;
michael@0: interface nsISelection;
michael@0: interface nsIVariant;
michael@0: 
michael@0: /**
michael@0:  * The nsIDOMWindow interface is the primary interface for a DOM
michael@0:  * window object. It represents a single window object that may
michael@0:  * contain child windows if the document in the window contains a
michael@0:  * HTML frameset document or if the document contains iframe elements.
michael@0:  *
michael@0:  * @see <http://www.whatwg.org/html/#window>
michael@0:  */
michael@0: 
michael@0: [scriptable, uuid(1b4a23a2-2ccf-4690-9da7-f3a7a8308381)]
michael@0: interface nsIDOMWindow : nsISupports
michael@0: {
michael@0:   // the current browsing context
michael@0:   readonly attribute nsIDOMWindow                       window;
michael@0: 
michael@0:   /* [replaceable] self */
michael@0:   readonly attribute nsIDOMWindow                       self;
michael@0: 
michael@0:   /**
michael@0:    * Accessor for the document in this window.
michael@0:    */
michael@0:   readonly attribute nsIDOMDocument                     document;
michael@0: 
michael@0:   /**
michael@0:    * Set/Get the name of this window.
michael@0:    *
michael@0:    * This attribute is "replaceable" in JavaScript
michael@0:    */
michael@0:            attribute DOMString                          name;
michael@0: 
michael@0:   /* The setter that takes a string argument needs to be special cased! */
michael@0:   readonly attribute nsIDOMLocation                     location;
michael@0: 
michael@0:   readonly attribute nsISupports                        history;
michael@0: 
michael@0: 
michael@0:   /* [replaceable] locationbar */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        locationbar;
michael@0: 
michael@0:   /* [replaceable] menubar */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        menubar;
michael@0: 
michael@0:   /* [replaceable] personalbar */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        personalbar;
michael@0: 
michael@0:   /**
michael@0:    * Accessor for the object that controls whether or not scrollbars
michael@0:    * are shown in this window.
michael@0:    *
michael@0:    * This attribute is "replaceable" in JavaScript
michael@0:    */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        scrollbars;
michael@0: 
michael@0:   /* [replaceable] statusbar */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        statusbar;
michael@0: 
michael@0:   /* [replaceable] toolbar */
michael@0:   /* BarProp */
michael@0:   readonly attribute nsISupports                        toolbar;
michael@0: 
michael@0:   /* [replaceable] */
michael@0:            attribute DOMString                          status;
michael@0: 
michael@0:   void                      close();
michael@0:   void                      stop();
michael@0:   void                      focus();
michael@0:   void                      blur();
michael@0: 
michael@0: 
michael@0:   // other browsing contexts
michael@0:   /* [replaceable] length */
michael@0:   readonly attribute unsigned long                      length;
michael@0: 
michael@0:   /**
michael@0:    * |top| gets the root of the window hierarchy.
michael@0:    *
michael@0:    * This function does not cross chrome-content boundaries, so if this
michael@0:    * window's parent is of a different type, |top| will return this window.
michael@0:    *
michael@0:    * When script reads the top property, we run GetScriptableTop, which
michael@0:    * will not cross an <iframe mozbrowser> boundary.
michael@0:    *
michael@0:    * In contrast, C++ calls to GetTop are forwarded to GetRealTop, which
michael@0:    * ignores <iframe mozbrowser> boundaries.
michael@0:    *
michael@0:    * This property is "replaceable" in JavaScript.
michael@0:    */
michael@0:   [binaryname(ScriptableTop)]
michael@0:   readonly attribute nsIDOMWindow                       top;
michael@0: 
michael@0:   /**
michael@0:    * You shouldn't need to call this function directly; call GetTop instead.
michael@0:    */
michael@0:   [noscript]
michael@0:   readonly attribute nsIDOMWindow                       realTop;
michael@0: 
michael@0:   %{C++
michael@0:   nsresult GetTop(nsIDOMWindow **aWindow)
michael@0:   {
michael@0:     return GetRealTop(aWindow);
michael@0:   }
michael@0:   %}
michael@0: 
michael@0:   /**
michael@0:    * |parent| gets this window's parent window.  If this window has no parent,
michael@0:    * we return the window itself.
michael@0:    *
michael@0:    * This property does not cross chrome-content boundaries, so if this
michael@0:    * window's parent is of a different type, we return the window itself as its
michael@0:    * parent.
michael@0:    *
michael@0:    * When script reads the property (or when C++ calls ScriptableTop), this
michael@0:    * property does not cross <iframe mozbrowser> boundaries.  In contrast, when
michael@0:    * C++ calls GetParent, we ignore the mozbrowser attribute.
michael@0:    */
michael@0:   [binaryname(ScriptableParent)]
michael@0:   readonly attribute nsIDOMWindow                       parent;
michael@0: 
michael@0:   /**
michael@0:    * You shouldn't need to read this property directly; call GetParent instead.
michael@0:    */
michael@0:   [noscript]
michael@0:   readonly attribute nsIDOMWindow                       realParent;
michael@0: 
michael@0:   %{C++
michael@0:   inline nsresult GetParent(nsIDOMWindow **aWindow)
michael@0:   {
michael@0:     return GetRealParent(aWindow);
michael@0:   }
michael@0:   %}
michael@0: 
michael@0:   [implicit_jscontext, binaryname(ScriptableOpener)]
michael@0:            attribute jsval                              opener;
michael@0: 
michael@0:   [noscript, binaryname(Opener)]
michael@0:            attribute nsIDOMWindow                       openerWindow;
michael@0: 
michael@0:   /**
michael@0:    * |frameElement| gets this window's <iframe> or <frame> element, if it has
michael@0:    * one.
michael@0:    *
michael@0:    * When script reads this property (or when C++ calls
michael@0:    * ScriptableFrameElement), we return |null| if the window is inside an
michael@0:    * <iframe mozbrowser>.  In contrast, when C++ calls GetFrameElement, we
michael@0:    * ignore the mozbrowser attribute.
michael@0:    */
michael@0:   [binaryname(ScriptableFrameElement)]
michael@0:   readonly attribute nsIDOMElement                      frameElement;
michael@0: 
michael@0:   /**
michael@0:    * You shouldn't need to read this property directly; call GetFrameElement
michael@0:    * instead.
michael@0:    */
michael@0:   [noscript]
michael@0:   readonly attribute nsIDOMElement                      realFrameElement;
michael@0: 
michael@0:   %{C++
michael@0:   inline nsresult GetFrameElement(nsIDOMElement **aElement)
michael@0:   {
michael@0:     return GetRealFrameElement(aElement);
michael@0:   }
michael@0:   %}
michael@0: 
michael@0: 
michael@0:   // the user agent
michael@0:   readonly attribute nsIDOMNavigator                    navigator;
michael@0: 
michael@0:   /**
michael@0:    * Get the application cache object for this window.
michael@0:    */
michael@0:   readonly attribute nsIDOMOfflineResourceList          applicationCache;
michael@0: 
michael@0: 
michael@0:   // user prompts
michael@0:   void                      alert([optional, Null(Stringify)] in DOMString text);
michael@0:   boolean                   confirm([optional] in DOMString text);
michael@0: 
michael@0:   // prompt() should return a null string if cancel is pressed
michael@0:   DOMString                 prompt([optional] in DOMString aMessage,
michael@0:                                    [optional] in DOMString aInitial);
michael@0: 
michael@0:   void                      print();
michael@0: 
michael@0:   [optional_argc]
michael@0:   nsIVariant                showModalDialog(in DOMString aURI,
michael@0:                                             [optional] in nsIVariant aArgs,
michael@0:                                             [optional] in DOMString aOptions);
michael@0: 
michael@0: 
michael@0:   // cross-document messaging
michael@0:   /**
michael@0:    * Implements a safe message-passing system which can cross same-origin
michael@0:    * boundaries.
michael@0:    *
michael@0:    * This method, when called, causes a MessageEvent to be asynchronously
michael@0:    * dispatched at the primary document for the window upon which this method is
michael@0:    * called.  (Note that the postMessage property on windows is allAccess and
michael@0:    * thus is readable cross-origin.)  The dispatched event will have message as
michael@0:    * its data, the calling context's window as its source, and an origin
michael@0:    * determined by the calling context's main document URI.  The targetOrigin
michael@0:    * argument specifies a URI and is used to restrict the message to be sent
michael@0:    * only when the target window has the same origin as targetOrigin (since,
michael@0:    * when the sender and the target have different origins, neither can read the
michael@0:    * location of the other).
michael@0:    * 
michael@0:    * @see <http://www.whatwg.org/html/#dom-window-postmessage>
michael@0:    */
michael@0:   [implicit_jscontext, binaryname(PostMessageMoz)]
michael@0:     void postMessage(in jsval message, in DOMString targetOrigin,
michael@0:                      [optional] in jsval transfer);
michael@0: 
michael@0: 
michael@0:   // WindowBase64
michael@0:   // Ascii base64 data to binary data and vice versa...
michael@0:   DOMString                 atob(in DOMString aAsciiString);
michael@0:   DOMString                 btoa(in DOMString aBase64Data);
michael@0: 
michael@0: 
michael@0:   // WindowSessionStorage
michael@0:   /**
michael@0:    * Session storage for the current browsing context.
michael@0:    */
michael@0:   readonly attribute nsIDOMStorage sessionStorage;
michael@0: 
michael@0: 
michael@0:   // WindowLocalStorage
michael@0:   /**
michael@0:    * Local storage for the current browsing context.
michael@0:    */
michael@0:   readonly attribute nsIDOMStorage localStorage;
michael@0: 
michael@0: 
michael@0:   // IndexedDB
michael@0:   // https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#requests
michael@0:   // IDBEnvironment
michael@0:   readonly attribute nsISupports indexedDB;
michael@0:   readonly attribute nsISupports mozIndexedDB;
michael@0: 
michael@0: 
michael@0:   // DOM Range
michael@0:   /**
michael@0:    * Method for accessing this window's selection object.
michael@0:    */
michael@0:   nsISelection              getSelection();
michael@0: 
michael@0: 
michael@0:   // CSSOM-View
michael@0:   // http://dev.w3.org/csswg/cssom-view/#extensions-to-the-window-interface
michael@0:   nsISupports      matchMedia(in DOMString media_query_list);
michael@0: 
michael@0:   readonly attribute nsIDOMScreen                       screen;
michael@0: 
michael@0:   // viewport
michael@0:            attribute long                               innerWidth;
michael@0:            attribute long                               innerHeight;
michael@0: 
michael@0: 
michael@0:   // viewport scrolling
michael@0:   /**
michael@0:    * Accessor for the current x scroll position in this window in
michael@0:    * pixels.
michael@0:    *
michael@0:    * This attribute is "replaceable" in JavaScript
michael@0:    */
michael@0:   readonly attribute long                               scrollX;
michael@0: 
michael@0:   /* The offset in pixels by which the window is scrolled */
michael@0:   readonly attribute long                               pageXOffset;
michael@0: 
michael@0:   /**
michael@0:    * Accessor for the current y scroll position in this window in
michael@0:    * pixels.
michael@0:    *
michael@0:    * This attribute is "replaceable" in JavaScript
michael@0:    */
michael@0:   readonly attribute long                               scrollY;
michael@0: 
michael@0:   /* The offset in pixels by which the window is scrolled */
michael@0:   readonly attribute long                               pageYOffset;
michael@0: 
michael@0:   void                      scroll(in long xScroll, in long yScroll);
michael@0: 
michael@0:   /**
michael@0:    * Method for scrolling this window to an absolute pixel offset.
michael@0:    */
michael@0:   void                      scrollTo(in long xScroll, in long yScroll);
michael@0: 
michael@0:   /**
michael@0:    * Method for scrolling this window to a pixel offset relative to
michael@0:    * the current scroll position.
michael@0:    */
michael@0:   void                      scrollBy(in long xScrollDif, in long yScrollDif);
michael@0: 
michael@0: 
michael@0:   // client
michael@0:            attribute long                        screenX;
michael@0:            attribute long                        screenY;
michael@0:            attribute long                        outerWidth;
michael@0:            attribute long                        outerHeight;
michael@0: 
michael@0: 
michael@0:   // CSSOM
michael@0:   /**
michael@0:    * @see <http://dev.w3.org/csswg/cssom/#dom-window-getcomputedstyle>
michael@0:    */
michael@0:   nsIDOMCSSStyleDeclaration getComputedStyle(in nsIDOMElement elt, 
michael@0:                                              [optional] in DOMString pseudoElt);
michael@0:   nsIDOMCSSStyleDeclaration getDefaultComputedStyle(in nsIDOMElement elt,
michael@0:                                                     [optional] in DOMString pseudoElt);
michael@0: 
michael@0: 
michael@0:   // Mozilla extensions
michael@0:   /**
michael@0:    * Get the window root for this window. This is useful for hooking
michael@0:    * up event listeners to this window and every other window nested
michael@0:    * in the window root.
michael@0:    */
michael@0:   [noscript] readonly attribute nsIDOMEventTarget windowRoot;
michael@0: 
michael@0:   /**
michael@0:    * Accessor for the child windows in this window.
michael@0:    */
michael@0:   [noscript] readonly attribute nsIDOMWindowCollection  frames;
michael@0: 
michael@0:   /**
michael@0:    * Set/Get the document scale factor as a multiplier on the default
michael@0:    * size. When setting this attribute, a NS_ERROR_NOT_IMPLEMENTED
michael@0:    * error may be returned by implementations not supporting
michael@0:    * zoom. Implementations not supporting zoom should return 1.0 all
michael@0:    * the time for the Get operation. 1.0 is equals normal size,
michael@0:    * i.e. no zoom.
michael@0:    */
michael@0:   [noscript] attribute float                            textZoom;
michael@0: 
michael@0:   /**
michael@0:    * Method for scrolling this window by a number of lines.
michael@0:    */
michael@0:   void                      scrollByLines(in long numLines);
michael@0: 
michael@0:   /**
michael@0:    * Method for scrolling this window by a number of pages.
michael@0:    */
michael@0:   void                      scrollByPages(in long numPages);
michael@0: 
michael@0:   /**
michael@0:    * Method for sizing this window to the content in the window.
michael@0:    */
michael@0:   void                      sizeToContent();
michael@0: 
michael@0:   /* [replaceable] content */
michael@0:   [noscript] readonly attribute nsIDOMWindow            content;
michael@0: 
michael@0:   /* [replaceable] prompter */
michael@0:   [noscript] readonly attribute nsIPrompt               prompter;
michael@0: 
michael@0:   readonly attribute boolean                            closed;
michael@0: 
michael@0:   readonly attribute nsIDOMCrypto                       crypto;
michael@0: 
michael@0:   // Note: this is [ChromeOnly] scriptable via WebIDL.
michael@0:   [noscript] readonly attribute nsIControllers          controllers;
michael@0: 
michael@0:   readonly attribute float                              mozInnerScreenX;
michael@0:   readonly attribute float                              mozInnerScreenY;
michael@0:   readonly attribute float                              devicePixelRatio;
michael@0: 
michael@0:   /* The maximum offset that the window can be scrolled to
michael@0:      (i.e., the document width/height minus the scrollport width/height) */
michael@0:   readonly attribute long                               scrollMaxX;
michael@0:   readonly attribute long                               scrollMaxY;
michael@0: 
michael@0:            attribute boolean                            fullScreen;
michael@0: 
michael@0:   void                      back();
michael@0:   void                      forward();
michael@0:   void                      home();
michael@0: 
michael@0:   void                      moveTo(in long xPos, in long yPos);
michael@0:   void                      moveBy(in long xDif, in long yDif);
michael@0:   void                      resizeTo(in long width, in long height);
michael@0:   void                      resizeBy(in long widthDif, in long heightDif);
michael@0: 
michael@0:   /**
michael@0:    * Open a new window with this one as the parent.  This method will
michael@0:    * NOT examine the JS stack for purposes of determining a caller.
michael@0:    * This window will be used for security checks during the search by
michael@0:    * name and the default character set on the newly opened window
michael@0:    * will just be the default character set of this window.
michael@0:    */
michael@0:   [noscript] nsIDOMWindow   open(in DOMString url, in DOMString name,
michael@0:                                  in DOMString options);
michael@0: 
michael@0:   /**
michael@0:    * This method works like open except that aExtraArgument gets
michael@0:    * converted into the array window.arguments in JS, if
michael@0:    * aExtraArgument is a nsISupportsArray then the individual items in
michael@0:    * the array are inserted into window.arguments, and primitive
michael@0:    * nsISupports (nsISupportsPrimitives) types are converted to native
michael@0:    * JS types when possible.
michael@0:    */
michael@0:   [noscript] nsIDOMWindow   openDialog(in DOMString url, in DOMString name,
michael@0:                                        in DOMString options,
michael@0:                                        in nsISupports aExtraArgument);
michael@0: 
michael@0:   // XXX Should this be in nsIDOMChromeWindow?
michael@0:   void                      updateCommands(in DOMString action);
michael@0: 
michael@0:   /* Find in page.
michael@0:    * @param str: the search pattern
michael@0:    * @param caseSensitive: is the search caseSensitive
michael@0:    * @param backwards: should we search backwards
michael@0:    * @param wrapAround: should we wrap the search
michael@0:    * @param wholeWord: should we search only for whole words
michael@0:    * @param searchInFrames: should we search through all frames
michael@0:    * @param showDialog: should we show the Find dialog
michael@0:    */
michael@0:   boolean                   find([optional] in DOMString str,
michael@0:                                  [optional] in boolean caseSensitive,
michael@0:                                  [optional] in boolean backwards,
michael@0:                                  [optional] in boolean wrapAround,
michael@0:                                  [optional] in boolean wholeWord,
michael@0:                                  [optional] in boolean searchInFrames,
michael@0:                                  [optional] in boolean showDialog);
michael@0: 
michael@0:   /**
michael@0:    * Returns the number of times this document for this window has
michael@0:    * been painted to the screen.
michael@0:    */
michael@0:   readonly attribute unsigned long long mozPaintCount;
michael@0: 
michael@0:   /**
michael@0:    * Request a refresh of this browser window.
michael@0:    *
michael@0:    * @see <http://dvcs.w3.org/hg/webperf/raw-file/tip/specs/RequestAnimationFrame/Overview.html>
michael@0:    */
michael@0:   // Argument is optional only so we can warn when it's null
michael@0:   long
michael@0:     mozRequestAnimationFrame([optional] in nsIFrameRequestCallback aCallback);
michael@0:   // jsval because we want a WebIDL callback here
michael@0:   [implicit_jscontext]
michael@0:   long requestAnimationFrame(in jsval aCallback);
michael@0: 
michael@0:   /**
michael@0:    * Cancel a refresh callback.
michael@0:    */
michael@0:   void mozCancelAnimationFrame(in long aHandle);
michael@0:   // Backwards-compat shim for now to make Google maps work
michael@0:   void mozCancelRequestAnimationFrame(in long aHandle);
michael@0:   void cancelAnimationFrame(in long aHandle);
michael@0: 
michael@0:   /**
michael@0:    * The current animation start time in milliseconds since the epoch.
michael@0:    */
michael@0:   readonly attribute long long mozAnimationStartTime;
michael@0: 
michael@0:   /**
michael@0:    * HTML5 event attributes that only apply to windows and <body>/<frameset>
michael@0:    */
michael@0:   [implicit_jscontext] attribute jsval onafterprint;
michael@0:   [implicit_jscontext] attribute jsval onbeforeprint;
michael@0:   [implicit_jscontext] attribute jsval onbeforeunload;
michael@0:   [implicit_jscontext] attribute jsval onhashchange;
michael@0:   [implicit_jscontext] attribute jsval onmessage;
michael@0:   [implicit_jscontext] attribute jsval onoffline;
michael@0:   [implicit_jscontext] attribute jsval ononline;
michael@0:   [implicit_jscontext] attribute jsval onpopstate;
michael@0:   [implicit_jscontext] attribute jsval onpagehide;
michael@0:   [implicit_jscontext] attribute jsval onpageshow;
michael@0:   // Not supported yet
michael@0:   // [implicit_jscontext] attribute jsval onredo;
michael@0:   [implicit_jscontext] attribute jsval onresize;
michael@0:   // Not supported yet
michael@0:   // [implicit_jscontext] attribute jsval onstorage;
michael@0:   // Not supported yet
michael@0:   // [implicit_jscontext] attribute jsval onundo;
michael@0:   [implicit_jscontext] attribute jsval onunload;
michael@0: 
michael@0:   /**
michael@0:    * Non-HTML5 window-specific event attributes
michael@0:    */
michael@0:   [implicit_jscontext] attribute jsval ondevicemotion;
michael@0:   [implicit_jscontext] attribute jsval ondeviceorientation;
michael@0:   [implicit_jscontext] attribute jsval ondeviceproximity;
michael@0:   [implicit_jscontext] attribute jsval onuserproximity;
michael@0:   [implicit_jscontext] attribute jsval ondevicelight;
michael@0: 
michael@0:   [implicit_jscontext] attribute jsval onmouseenter;
michael@0:   [implicit_jscontext] attribute jsval onmouseleave;
michael@0: 
michael@0:   /**
michael@0:    * Console API
michael@0:    */
michael@0:   [implicit_jscontext] attribute jsval console;
michael@0: };
michael@0: 
michael@0: [scriptable, uuid(2146c906-57f7-486c-a1b4-8cdb57ef577f)]
michael@0: interface nsIDOMWindowPerformance : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * A namespace to hold performance related data and statistics.
michael@0:    */
michael@0:   readonly attribute nsISupports performance;
michael@0: };
michael@0: 
michael@0: /**
michael@0:  * Empty interface for compatibility with older versions.
michael@0:  * @deprecated Use nsIDOMWindow instead
michael@0:  */
michael@0: [scriptable, uuid(2ec49e81-b2ba-4633-991a-f48f1e1d8800)]
michael@0: interface nsIDOMWindowInternal : nsIDOMWindow {};