dom/base/nsIJSNativeInitializer.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.org 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 nsIJSNativeInitializer_h__
  39 #define nsIJSNativeInitializer_h__
  40
  41 #include "nsISupports.h"
  42 #include "jsapi.h"
  43
  44 #define NS_IJSNATIVEINITIALIZER_IID \
  45 { 0x536c5ad2, 0x1275, 0x4706,       \
  46   { 0x99, 0xbd, 0x4a, 0xef, 0xb2, 0x4a, 0xb7, 0xf7 } }
  47
  48 /**
  49  * A JavaScript specific interface used to initialize new
  50  * native objects, created as a result of calling a
  51  * JavaScript constructor. The arguments are passed in
  52  * their raw form as jsval's.
  53  */
  54
  55 class nsIJSNativeInitializer : public nsISupports {
  56 public:
  57   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IJSNATIVEINITIALIZER_IID)
  58
  59   /**
  60    * Initialize a newly created native instance using the owner of the
  61    * constructor and the parameters passed into the JavaScript constructor.
  62    */
  63   NS_IMETHOD Initialize(nsISupports* aOwner, JSContext *cx, JSObject *obj,
  64                         PRUint32 argc, jsval *argv) = 0;
  65 };
  66
  67 NS_DEFINE_STATIC_IID_ACCESSOR(nsIJSNativeInitializer,
  68                               NS_IJSNATIVEINITIALIZER_IID)
  69
  70 #endif // nsIJSNativeInitializer_h__