content/events/src/nsXMLEventsManager.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  * Olli Pettay.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Olli Pettay <Olli.Pettay@helsinki.fi> (original author)
  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 nsXMLEventsManager_h___
  40 #define nsXMLEventsManager_h___
  41
  42 #include "nsCOMPtr.h"
  43 #include "nsIDocument.h"
  44 #include "nsIContent.h"
  45 #include "nsCOMArray.h"
  46 #include "nsIDOMEventListener.h"
  47 #include "nsInterfaceHashtable.h"
  48 #include "nsIAtom.h"
  49
  50 /*
  51  * The implementation of the XML Events Basic profile
  52  */
  53
  54 class nsXMLEventsManager;
  55 class nsXMLEventsListener : public nsIDOMEventListener {
  56 public:
  57   static PRBool InitXMLEventsListener(nsIDocument * aDocument,
  58                                       nsXMLEventsManager * aManager,
  59                                       nsIContent * aContent);
  60   nsXMLEventsListener(nsXMLEventsManager * aManager,
  61                       nsIContent * aElement,
  62                       nsIContent* aObserver,
  63                       nsIContent * aHandler,
  64                       const nsAString& aEvent,
  65                       PRBool aPhase,
  66                       PRBool aStopPropagation,
  67                       PRBool aCancelDefault,
  68                       const nsAString& aTarget);
  69   ~nsXMLEventsListener();
  70   void Unregister();
  71   //Removes this event listener from observer and adds the element back to the
  72   //list of incomplete XML Events declarations in XMLEventsManager
  73   void SetIncomplete();
  74   PRBool ObserverEquals(nsIContent * aTarget);
  75   PRBool HandlerEquals(nsIContent * aTarget);
  76
  77   NS_DECL_ISUPPORTS
  78   NS_DECL_NSIDOMEVENTLISTENER
  79 private:
  80   nsXMLEventsManager * mManager;
  81   nsCOMPtr<nsIContent> mElement;
  82   nsCOMPtr<nsIContent> mObserver;
  83   nsCOMPtr<nsIContent> mHandler;
  84   nsString mEvent;
  85   nsCOMPtr<nsIAtom> mTarget;
  86   PRPackedBool mPhase;
  87   PRPackedBool mStopPropagation;
  88   PRPackedBool mCancelDefault;
  89
  90 };
  91
  92 class nsXMLEventsManager : public nsIDocumentObserver {
  93 public:
  94   nsXMLEventsManager();
  95   ~nsXMLEventsManager();
  96   NS_DECL_ISUPPORTS
  97   NS_DECL_NSIDOCUMENTOBSERVER
  98
  99   void AddXMLEventsContent(nsIContent * aContent);
 100   void RemoveXMLEventsContent(nsIContent * aContent);
 101   void AddListener(nsIContent * aContent, nsXMLEventsListener * aListener);
 102   //Returns PR_TRUE if a listener was removed.
 103   PRBool RemoveListener(nsIContent * aXMLElement);
 104 private:
 105   void AddListeners(nsIDocument* aDocument);
 106   nsInterfaceHashtable<nsISupportsHashKey,nsXMLEventsListener> mListeners;
 107   nsCOMArray<nsIContent> mIncomplete;
 108 };
 109
 110 #endif /* nsXMLEventsManager_h___ */