Back to index

lightning-sunbird  0.9+nobinonly
nsXBLEventHandler.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 Communicator client 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  *   Original Author: David W. Hyatt (hyatt@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsXBLEventHandler_h__
00040 #define nsXBLEventHandler_h__
00041 
00042 #include "nsCOMPtr.h"
00043 #include "nsIDOMEventListener.h"
00044 #include "nsVoidArray.h"
00045 
00046 class nsIAtom;
00047 class nsIContent;
00048 class nsIDOM3EventTarget;
00049 class nsIDOMEventReceiver;
00050 class nsXBLPrototypeHandler;
00051 
00052 class nsXBLEventHandler : public nsIDOMEventListener
00053 {
00054 public:
00055   nsXBLEventHandler(nsXBLPrototypeHandler* aHandler);
00056   virtual ~nsXBLEventHandler();
00057 
00058   NS_DECL_ISUPPORTS
00059 
00060   NS_DECL_NSIDOMEVENTLISTENER
00061 
00062 protected:
00063   nsXBLPrototypeHandler* mProtoHandler;
00064 
00065 private:
00066   nsXBLEventHandler();
00067   virtual PRBool EventMatched(nsIDOMEvent* aEvent)
00068   {
00069     return PR_TRUE;
00070   }
00071 };
00072 
00073 class nsXBLMouseEventHandler : public nsXBLEventHandler
00074 {
00075 public:
00076   nsXBLMouseEventHandler(nsXBLPrototypeHandler* aHandler);
00077   virtual ~nsXBLMouseEventHandler();
00078 
00079 private:
00080   PRBool EventMatched(nsIDOMEvent* aEvent);
00081 };
00082 
00083 class nsXBLKeyEventHandler : public nsIDOMEventListener
00084 {
00085 public:
00086   nsXBLKeyEventHandler(nsIAtom* aEventType, PRUint8 aPhase, PRUint8 aType);
00087   virtual ~nsXBLKeyEventHandler();
00088 
00089   NS_DECL_ISUPPORTS
00090 
00091   NS_DECL_NSIDOMEVENTLISTENER
00092 
00093   void AddProtoHandler(nsXBLPrototypeHandler* aProtoHandler)
00094   {
00095     mProtoHandlers.AppendElement(aProtoHandler);
00096   }
00097 
00098   PRBool Matches(nsIAtom* aEventType, PRUint8 aPhase, PRUint8 aType) const
00099   {
00100     return (mEventType == aEventType && mPhase == aPhase && mType == aType);
00101   }
00102 
00103   void GetEventName(nsAString& aString) const
00104   {
00105     mEventType->ToString(aString);
00106   }
00107 
00108   PRUint8 GetPhase() const
00109   {
00110     return mPhase;
00111   }
00112 
00113   PRUint8 GetType() const
00114   {
00115     return mType;
00116   }
00117 
00118 private:
00119   nsXBLKeyEventHandler();
00120 
00121   nsVoidArray mProtoHandlers;
00122   nsCOMPtr<nsIAtom> mEventType;
00123   PRUint8 mPhase;
00124   PRUint8 mType;
00125 };
00126 
00127 nsresult
00128 NS_NewXBLEventHandler(nsXBLPrototypeHandler* aHandler,
00129                       nsIAtom* aEventType,
00130                       nsXBLEventHandler** aResult);
00131 
00132 nsresult
00133 NS_NewXBLKeyEventHandler(nsIAtom* aEventType, PRUint8 aPhase,
00134                          PRUint8 aType, nsXBLKeyEventHandler** aResult);
00135 
00136 #endif