embedding/base/nsIWindowCreator2.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 2001
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /**
  40  * nsIWindowCreator2 is an extension of nsIWindowCreator which allows
  41  * additional information about the context of the window creation to
  42  * be passed.
  43  *
  44  * @see nsIWindowCreator
  45  * @see nsIWindowWatcher
  46  *
  47  * @status
  48  */
  49
  50 #include "nsIWindowCreator.idl"
  51
  52 interface nsIURI;
  53 interface nsIWebBrowserChrome;
  54
  55 [scriptable, uuid(f673ec81-a4b0-11d6-964b-eb5a2bf216fc)]
  56
  57 interface nsIWindowCreator2 : nsIWindowCreator {
  58
  59   /**
  60    * Definitions for contextFlags
  61    */
  62
  63   // Likely that the window is an advertising popup.
  64   const unsigned long PARENT_IS_LOADING_OR_RUNNING_TIMEOUT = 0x00000001;
  65
  66   /** Create a new window. Gecko will/may call this method, if made
  67       available to it, to create new windows.
  68       @param parent Parent window, if any. Null if not. The newly created
  69                     window should be made a child/dependent window of
  70                     the parent, if any (and if the concept applies
  71                     to the underlying OS).
  72       @param chromeFlags Chrome features from nsIWebBrowserChrome
  73       @param contextFlags Flags about the context of the window being created.
  74       @param uri The URL for which this window is intended. It can be null
  75                  or zero-length. The implementation of this interface
  76                  may use the URL to help determine what sort of window
  77                  to open or whether to cancel window creation. It will not
  78                  load the URL.
  79       @param cancel Return |true| to reject window creation. If true the
  80                     implementation has determined the window should not
  81                     be created at all. The caller should not default
  82                     to any possible backup scheme for creating the window.
  83       @return the new window. Will be null if canceled or an error occurred.
  84   */
  85   nsIWebBrowserChrome createChromeWindow2(in nsIWebBrowserChrome parent,
  86                                           in PRUint32 chromeFlags,
  87                                           in PRUint32 contextFlags,
  88                                           in nsIURI uri,
  89                                           out boolean cancel);
  90 };