Back to index

lightning-sunbird  0.9+nobinonly
nsIEventListenerManager.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 nsIEventListenerManager_h__
00039 #define nsIEventListenerManager_h__
00040 
00041 #include "nsEvent.h"
00042 #include "nsISupports.h"
00043 #include "nsVoidArray.h"
00044 
00045 class nsPresContext;
00046 class nsIDOMEventListener;
00047 class nsIScriptContext;
00048 class nsIDOMEventTarget;
00049 class nsIDOMEventGroup;
00050 class nsIAtom;
00051 struct JSObject;
00052 
00053 /*
00054  * Event listener manager interface.
00055  */
00056 #define NS_IEVENTLISTENERMANAGER_IID \
00057 {0xc23b877c, 0xb396, 0x11d9, \
00058 {0x86, 0xbd, 0x00, 0x11, 0x24, 0x78, 0xd6, 0x26} }
00059 
00060 class nsIEventListenerManager : public nsISupports {
00061 
00062 public:
00063   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IEVENTLISTENERMANAGER_IID)
00064 
00065   
00069   NS_IMETHOD AddEventListenerByIID(nsIDOMEventListener *aListener,
00070                                    const nsIID& aIID, PRInt32 flags) = 0;
00071 
00076   NS_IMETHOD RemoveEventListenerByIID(nsIDOMEventListener *aListener,
00077                                       const nsIID& aIID, PRInt32 flags) = 0;
00078 
00083   NS_IMETHOD AddEventListenerByType(nsIDOMEventListener *aListener,
00084                                     const nsAString& type,
00085                                     PRInt32 flags,
00086                                     nsIDOMEventGroup* aEvtGrp) = 0;
00087 
00092   NS_IMETHOD RemoveEventListenerByType(nsIDOMEventListener *aListener,
00093                                        const nsAString& type,
00094                                        PRInt32 flags,
00095                                        nsIDOMEventGroup* aEvtGrp) = 0;
00096 
00102   NS_IMETHOD AddScriptEventListener(nsISupports *aObject,
00103                                     nsIAtom *aName,
00104                                     const nsAString& aFunc,
00105                                     PRBool aDeferCompilation,
00106                                     PRBool aPermitUntrustedEvents) = 0;
00107 
00108 
00109   NS_IMETHOD RemoveScriptEventListener(nsIAtom *aName) = 0;
00110 
00118   NS_IMETHOD RegisterScriptEventListener(nsIScriptContext *aContext,
00119                                          JSObject *aScopeObject,
00120                                          nsISupports *aObject,
00121                                          nsIAtom* aName) = 0;
00122 
00127   NS_IMETHOD CompileScriptEventListener(nsIScriptContext *aContext,
00128                                         JSObject *aScopeObject,
00129                                         nsISupports *aObject,
00130                                         nsIAtom* aName,
00131                                         PRBool *aDidCompile) = 0;
00132 
00138   NS_IMETHOD HandleEvent(nsPresContext* aPresContext,
00139                          nsEvent* aEvent,
00140                          nsIDOMEvent** aDOMEvent,
00141                          nsIDOMEventTarget* aCurrentTarget,
00142                          PRUint32 aFlags,
00143                          nsEventStatus* aEventStatus) = 0;
00144 
00150   NS_IMETHOD CreateEvent(nsPresContext* aPresContext,
00151                          nsEvent* aEvent,
00152                          const nsAString& aEventType,
00153                          nsIDOMEvent** aDOMEvent) = 0;
00154 
00159   NS_IMETHOD CaptureEvent(PRInt32 aEventTypes) = 0;
00160 
00165   NS_IMETHOD ReleaseEvent(PRInt32 aEventTypes) = 0;
00166 
00181   NS_IMETHOD Disconnect(PRBool aUnusedParam = PR_FALSE) = 0;
00182 
00187   NS_IMETHOD SetListenerTarget(nsISupports* aTarget) = 0;
00188 
00192   NS_IMETHOD HasMutationListeners(PRBool* aListener) = 0;
00193 
00199   NS_IMETHOD GetSystemEventGroupLM(nsIDOMEventGroup** aGroup) = 0;
00200 
00205   virtual PRBool HasUnloadListeners() = 0;
00206 };
00207 
00208 nsresult
00209 NS_NewEventListenerManager(nsIEventListenerManager** aInstancePtrResult);
00210 
00211 #endif // nsIEventListenerManager_h__