content/base/public/nsIScriptLoaderObserver.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 nsIScriptElement;
  42 interface nsIURI;
  43
  44 [scriptable, uuid(7b787204-76fb-4764-96f1-fb7a666db4f4)]
  45 interface nsIScriptLoaderObserver : nsISupports {
  46
  47   /**
  48    * The script is available for evaluation. For inline scripts, this
  49    * method will be called synchronously. For externally loaded scripts,
  50    * this method will be called when the load completes.
  51    *
  52    * @param aResult A result code representing the result of loading
  53    *        a script. If this is a failure code, script evaluation
  54    *        will not occur.
  55    * @param aElement The element being processed.
  56    * @param aIsInline Is this an inline script or externally loaded?
  57    * @param aURI What is the URI of the script (the document URI if
  58    *        it is inline).
  59    * @param aLineNo At what line does the script appear (generally 1
  60    *        if it is a loaded script).
  61    */
  62   void scriptAvailable(in nsresult aResult,
  63                        in nsIScriptElement aElement,
  64                        in boolean aIsInline,
  65                        in nsIURI aURI,
  66                        in PRInt32 aLineNo);
  67
  68   /**
  69    * The script has been evaluated.
  70    *
  71    * @param aResult A result code representing the success or failure of
  72    *        the script evaluation.
  73    * @param aElement The element being processed.
  74    * @param aIsInline Is this an inline script or externally loaded?
  75    */
  76   void scriptEvaluated(in nsresult aResult,
  77                        in nsIScriptElement aElement,
  78                        in boolean aIsInline);
  79
  80 };