content/xbl/src/nsXBLEventHandler.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 Communicator client 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  *   Original Author: David W. Hyatt (hyatt@netscape.com)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsXBLEventHandler_h__
  40 #define nsXBLEventHandler_h__
  41
  42 #include "nsCOMPtr.h"
  43 #include "nsIDOMEventListener.h"
  44 #include "nsVoidArray.h"
  45
  46 class nsIAtom;
  47 class nsIContent;
  48 class nsIDOM3EventTarget;
  49 class nsIDOMKeyEvent;
  50 class nsPIDOMEventTarget;
  51 class nsXBLPrototypeHandler;
  52
  53 class nsXBLEventHandler : public nsIDOMEventListener
  54 {
  55 public:
  56   nsXBLEventHandler(nsXBLPrototypeHandler* aHandler);
  57   virtual ~nsXBLEventHandler();
  58
  59   NS_DECL_ISUPPORTS
  60
  61   NS_DECL_NSIDOMEVENTLISTENER
  62
  63 protected:
  64   nsXBLPrototypeHandler* mProtoHandler;
  65
  66 private:
  67   nsXBLEventHandler();
  68   virtual PRBool EventMatched(nsIDOMEvent* aEvent)
  69   {
  70     return PR_TRUE;
  71   }
  72 };
  73
  74 class nsXBLMouseEventHandler : public nsXBLEventHandler
  75 {
  76 public:
  77   nsXBLMouseEventHandler(nsXBLPrototypeHandler* aHandler);
  78   virtual ~nsXBLMouseEventHandler();
  79
  80 private:
  81   PRBool EventMatched(nsIDOMEvent* aEvent);
  82 };
  83
  84 class nsXBLKeyEventHandler : public nsIDOMEventListener
  85 {
  86 public:
  87   nsXBLKeyEventHandler(nsIAtom* aEventType, PRUint8 aPhase, PRUint8 aType);
  88   virtual ~nsXBLKeyEventHandler();
  89
  90   NS_DECL_ISUPPORTS
  91
  92   NS_DECL_NSIDOMEVENTLISTENER
  93
  94   void AddProtoHandler(nsXBLPrototypeHandler* aProtoHandler)
  95   {
  96     mProtoHandlers.AppendElement(aProtoHandler);
  97   }
  98
  99   PRBool Matches(nsIAtom* aEventType, PRUint8 aPhase, PRUint8 aType) const
 100   {
 101     return (mEventType == aEventType && mPhase == aPhase && mType == aType);
 102   }
 103
 104   void GetEventName(nsAString& aString) const
 105   {
 106     mEventType->ToString(aString);
 107   }
 108
 109   PRUint8 GetPhase() const
 110   {
 111     return mPhase;
 112   }
 113
 114   PRUint8 GetType() const
 115   {
 116     return mType;
 117   }
 118
 119   void SetIsBoundToChrome(PRBool aIsBoundToChrome)
 120   {
 121     mIsBoundToChrome = aIsBoundToChrome;
 122   }
 123 private:
 124   nsXBLKeyEventHandler();
 125   PRBool ExecuteMatchedHandlers(nsIDOMKeyEvent* aEvent, PRUint32 aCharCode,
 126                                 PRBool aIgnoreShiftKey);
 127
 128   nsVoidArray mProtoHandlers;
 129   nsCOMPtr<nsIAtom> mEventType;
 130   PRUint8 mPhase;
 131   PRUint8 mType;
 132   PRPackedBool mIsBoundToChrome;
 133 };
 134
 135 nsresult
 136 NS_NewXBLEventHandler(nsXBLPrototypeHandler* aHandler,
 137                       nsIAtom* aEventType,
 138                       nsXBLEventHandler** aResult);
 139
 140 nsresult
 141 NS_NewXBLKeyEventHandler(nsIAtom* aEventType, PRUint8 aPhase,
 142                          PRUint8 aType, nsXBLKeyEventHandler** aResult);
 143
 144 #endif