Back to index

lightning-sunbird  0.9+nobinonly
nsIJSEventListener.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsIJSEventListener_h__
00039 #define nsIJSEventListener_h__
00040 
00041 #include "nsIScriptContext.h"
00042 
00043 class nsIScriptObjectOwner;
00044 class nsIDOMEventListener;
00045 class nsIAtom;
00046 struct JSObject;
00047 
00048 #define NS_IJSEVENTLISTENER_IID     \
00049 { 0xa6cf9118, 0x15b3, 0x11d2,       \
00050 {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
00051 
00052 // Implemented by JS event listeners. Used to retrieve the
00053 // JSObject corresponding to the event target.
00054 class nsIJSEventListener : public nsISupports
00055 {
00056 public:
00057   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IJSEVENTLISTENER_IID)
00058 
00059   nsIJSEventListener(nsIScriptContext *aContext, JSObject *aScopeObject,
00060                      nsISupports *aTarget)
00061     : mContext(aContext), mScopeObject(aScopeObject), mTarget(aTarget)
00062   {
00063     // mTarget is a weak reference. We are guaranteed because of the
00064     // ownership model that the target will be freed (and the
00065     // references dropped) before either the context or the owner goes
00066     // away.
00067 
00068     NS_IF_ADDREF(mContext);
00069   }
00070 
00071   nsIScriptContext *GetEventContext()
00072   {
00073     return mContext;
00074   }
00075 
00076   nsISupports *GetEventTarget()
00077   {
00078     return mTarget;
00079   }
00080 
00081   JSObject *GetEventScope()
00082   {
00083     return mScopeObject;
00084   }
00085 
00086   virtual void SetEventName(nsIAtom* aName) = 0;
00087 
00088 protected:
00089   ~nsIJSEventListener()
00090   {
00091     NS_IF_RELEASE(mContext);
00092   }
00093 
00094   nsIScriptContext *mContext;
00095   JSObject *mScopeObject;
00096   nsISupports *mTarget;
00097 };
00098 
00099 /* factory function */
00100 nsresult NS_NewJSEventListener(nsIScriptContext *aContext,
00101                                JSObject *aScopeObject, nsISupports *aObject,
00102                                nsIDOMEventListener **aReturn);
00103 
00104 #endif // nsIJSEventListener_h__