dom/public/nsIJSEventListener.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 nsIJSEventListener_h__
  39 #define nsIJSEventListener_h__
  40
  41 #include "nsIScriptContext.h"
  42
  43 class nsIScriptObjectOwner;
  44 class nsIDOMEventListener;
  45 class nsIAtom;
  46
  47 #define NS_IJSEVENTLISTENER_IID     \
  48 { 0xa6cf9118, 0x15b3, 0x11d2,       \
  49 {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
  50
  51 // Implemented by script event listeners. Used to retrieve the
  52 // script object corresponding to the event target.
  53 // (Note this interface is now used to store script objects for all
  54 // script languages, so is no longer JS specific)
  55 class nsIJSEventListener : public nsISupports
  56 {
  57 public:
  58   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IJSEVENTLISTENER_IID)
  59
  60   nsIJSEventListener(nsIScriptContext *aContext, void *aScopeObject,
  61                      nsISupports *aTarget)
  62     : mContext(aContext), mScopeObject(aScopeObject),
  63       mTarget(do_QueryInterface(aTarget))
  64   {
  65   }
  66
  67   nsIScriptContext *GetEventContext()
  68   {
  69     return mContext;
  70   }
  71
  72   nsISupports *GetEventTarget()
  73   {
  74     return mTarget;
  75   }
  76
  77   void *GetEventScope()
  78   {
  79     return mScopeObject;
  80   }
  81
  82   virtual void SetEventName(nsIAtom* aName) = 0;
  83
  84 protected:
  85   virtual ~nsIJSEventListener()
  86   {
  87   }
  88   nsCOMPtr<nsIScriptContext> mContext;
  89   void *mScopeObject;
  90   nsCOMPtr<nsISupports> mTarget;
  91 };
  92
  93 NS_DEFINE_STATIC_IID_ACCESSOR(nsIJSEventListener, NS_IJSEVENTLISTENER_IID)
  94
  95 /* factory function */
  96 nsresult NS_NewJSEventListener(nsIScriptContext *aContext,
  97                                void *aScopeObject, nsISupports *aObject,
  98                                nsIDOMEventListener **aReturn);
  99
 100 #endif // nsIJSEventListener_h__