embedding/nsIWindowCreator2.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /**
   8  * nsIWindowCreator2 is an extension of nsIWindowCreator which allows
   9  * additional information about the context of the window creation to
  10  * be passed.
  11  *
  12  * @see nsIWindowCreator
  13  * @see nsIWindowWatcher
  14  *
  15  * @status
  16  */
  17
  18 #include "nsIWindowCreator.idl"
  19
  20 interface nsITabParent;
  21 interface nsIURI;
  22 interface nsIWebBrowserChrome;
  23
  24 [scriptable, uuid(e28f810b-9b49-4927-a4be-62a74fadfe21)]
  25
  26 interface nsIWindowCreator2 : nsIWindowCreator {
  27
  28   /**
  29    * Definitions for contextFlags
  30    */
  31
  32   // Likely that the window is an advertising popup.
  33   const unsigned long PARENT_IS_LOADING_OR_RUNNING_TIMEOUT = 0x00000001;
  34
  35   /** Create a new window. Gecko will/may call this method, if made
  36       available to it, to create new windows.
  37       @param parent Parent window, if any. Null if not. The newly created
  38                     window should be made a child/dependent window of
  39                     the parent, if any (and if the concept applies
  40                     to the underlying OS).
  41       @param chromeFlags Chrome features from nsIWebBrowserChrome
  42       @param contextFlags Flags about the context of the window being created.
  43       @param uri The URL for which this window is intended. It can be null
  44                  or zero-length. The implementation of this interface
  45                  may use the URL to help determine what sort of window
  46                  to open or whether to cancel window creation. It will not
  47                  load the URL.
  48       @param aOpeningTab The TabParent that is trying to open this new chrome
  49                          window. Can be nullptr.
  50       @param cancel Return |true| to reject window creation. If true the
  51                     implementation has determined the window should not
  52                     be created at all. The caller should not default
  53                     to any possible backup scheme for creating the window.
  54       @return the new window. Will be null if canceled or an error occurred.
  55   */
  56   nsIWebBrowserChrome createChromeWindow2(in nsIWebBrowserChrome parent,
  57                                           in uint32_t chromeFlags,
  58                                           in uint32_t contextFlags,
  59                                           in nsIURI uri,
  60                                           in nsITabParent aOpeningTab,
  61                                           out boolean cancel);
  62 };