dom/base/nsIScriptExternalNameSet.h

   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 Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIScriptExternalNameSet_h__
  39 #define nsIScriptExternalNameSet_h__
  40
  41 #include "nsISupports.h"
  42
  43 #define NS_ISCRIPTEXTERNALNAMESET_IID \
  44   {0xa6cf90da, 0x15b3, 0x11d2,        \
  45   {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
  46
  47 class nsIScriptContext;
  48
  49 /**
  50  * This interface represents a set of names or symbols that should be
  51  * added to the "global" namespace of a script context. A name set is
  52  * registered with the name set registry (see
  53  * <code>nsIScriptNameSetRegistry</code>) at component registration
  54  * time using the category manager.
  55  */
  56
  57 class nsIScriptExternalNameSet : public nsISupports
  58 {
  59 public:
  60   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISCRIPTEXTERNALNAMESET_IID)
  61
  62   /**
  63    * Called to tell the name set to do any initialization it needs to
  64    */
  65   NS_IMETHOD InitializeNameSet(nsIScriptContext* aScriptContext) = 0;
  66 };
  67
  68 NS_DEFINE_STATIC_IID_ACCESSOR(nsIScriptExternalNameSet,
  69                               NS_ISCRIPTEXTERNALNAMESET_IID)
  70
  71 #endif /* nsIScriptExternalNameSet_h__ */