browser/components/nsIBrowserGlue.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Firefox Browser Glue Service.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Giorgio Maone
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Giorgio Maone <g.maone@informaction.com>
  23  *   Asaf Romano <mano@mozilla.com>
  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 #include "nsISupports.idl"
  40
  41 interface nsIDOMWindow;
  42
  43 /**
  44  * nsIBrowserGlue is a dirty and rather fluid interface to host shared utility
  45  * methods used by browser UI code, but which are not local to a browser window.
  46  * The component implementing this interface is meant to be a singleton
  47  * (service) and should progressively replace some of the shared "glue" code
  48  * scattered in browser/base/content (e.g. bits of utilOverlay.js,
  49  * contentAreaUtils.js, globalOverlay.js, browser.js), avoiding dynamic
  50  * inclusion and initialization of a ton of JS code for *each* window.
  51  * Dued to its nature and origin, this interface won't probably be the most
  52  * elegant or stable in the mozilla codebase, but its aim is rather pragmatic:
  53  * 1) reducing the performance overhead which affects browser window load;
  54  * 2) allow global hooks (e.g. startup and shutdown observers) which survive
  55  * browser windows to accomplish browser-related activities, such as shutdown
  56  * sanitization (see bug #284086)
  57  *
  58  */
  59
  60 [scriptable, uuid(01639c88-c0eb-4d75-9ee1-f325c1e04215)]
  61 interface nsIBrowserGlue : nsISupports
  62 {
  63   /**
  64    * Deletes privacy sensitive data according to user preferences
  65    *
  66    * @param aParentWindow an optionally null window which is the parent of the
  67    *        sanitization dialog (if it has to be shown per user preferences)
  68    *
  69    */
  70   void sanitize(in nsIDOMWindow aParentWindow);
  71
  72   /**
  73    * Add Smart Bookmarks special queries to bookmarks menu and toolbar folder.
  74    */
  75   void ensurePlacesDefaultQueriesInitialized();
  76 };