content/base/public/nsIScriptLoader.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vidur Apparao <vidur@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or 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 nsIDocument;
  42 interface nsIScriptElement;
  43 interface nsIScriptLoaderObserver;
  44
  45 [scriptable, uuid(339a4eb5-dac6-4034-8c43-f4f8c645ce57)]
  46 interface nsIScriptLoader : nsISupports {
  47   /**
  48    * Initialize loader with a document. The container of this document
  49    * will be used for getting script evaluation information, including
  50    * the context in which to do the evaluation. The loader maintains a
  51    * strong reference to the document.
  52    *
  53    * @param aDocument The document to use as the basis for script
  54    *        processing.
  55    */
  56   void init(in nsIDocument aDocument);
  57
  58   /**
  59    * The loader maintains a strong reference to the document with
  60    * which it is initialized. This call forces the reference to
  61    * be dropped.
  62    */
  63   void dropDocumentReference();
  64
  65   /**
  66    * Add an observer for all scripts loaded through this loader.
  67    *
  68    * @param aObserver observer for all script processing.
  69    */
  70   void addObserver(in nsIScriptLoaderObserver aObserver);
  71
  72   /**
  73    * Remove an observer.
  74    *
  75    * @param aObserver observer to be removed
  76    */
  77   void removeObserver(in nsIScriptLoaderObserver aObserver);
  78
  79   /**
  80    * Process a script element. This will include both loading the
  81    * source of the element if it is not inline and evaluating
  82    * the script itself.
  83    *
  84    * @param aElement The element representing the script to be loaded and
  85    *        evaluated.
  86    * @param aObserver An observer for this script load only
  87    *
  88    */
  89   void processScriptElement(in nsIScriptElement aElement,
  90                             in nsIScriptLoaderObserver aObserver);
  91
  92   /**
  93    * Gets the currently executing script. This is useful if you want to
  94    * generate a unique key based on the currently executing script.
  95    */
  96   nsIScriptElement getCurrentScript();
  97
  98   /**
  99    * Whether the loader is enabled or not.
 100    * When disabled, processing of new script elements is disabled.
 101    * Any call to processScriptElement() will fail with a return code of
 102    * NS_ERROR_NOT_AVAILABLE. Note that this DOES NOT disable
 103    * currently loading or executing scripts.
 104    */
 105   attribute boolean enabled;
 106 };