xpfe/appshell/nsIWindowlessBrowser.idl

   1 /* -*- Mode: IDL; tab-width: 4; 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 #include "nsIWebNavigation.idl"
   8
   9 interface nsIDocShell;
  10 webidl BrowsingContext;
  11
  12 /**
  13  * This interface represents a nsIWebBrowser instance with no associated OS
  14  * window. Its main function is to manage the lifetimes of those windows.
  15  * A strong reference to this object must be held until the window is
  16  * ready to be destroyed.
  17  */
  18 [scriptable, builtinclass, uuid(abb46f48-abfc-41bf-aa9a-7feccefcf977)]
  19 interface nsIWindowlessBrowser : nsIWebNavigation
  20 {
  21   /**
  22    * "Closes" the windowless browser and destroys its associated nsIWebBrowser
  23    * and docshell.
  24    *
  25    * This method *must* be called for every windowless browser before its last
  26    * reference is released.
  27    */
  28   void close();
  29
  30   /**
  31    * Get the docshell for this browser.  This is the docshell that gets
  32    * navigated when the browser's nsIWebNavigation interface is used.
  33    */
  34   readonly attribute nsIDocShell docShell;
  35
  36   /**
  37    * Get the Browsing Context for this browser.  This is the Browsing Context
  38    * that owns the docshell used for navigation.
  39    */
  40   readonly attribute BrowsingContext browsingContext;
  41 };