Back to index

lightning-sunbird  0.9+nobinonly
nsXMLEventsManager.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  * Olli Pettay.
00019  * Portions created by the Initial Developer are Copyright (C) 2004
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Olli Pettay <Olli.Pettay@helsinki.fi> (original author)
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 nsXMLEventsManager_h___
00040 #define nsXMLEventsManager_h___
00041 
00042 #include "nsCOMPtr.h"
00043 #include "nsIDocument.h"
00044 #include "nsIContent.h"
00045 #include "nsCOMArray.h"
00046 #include "nsIDOMEventListener.h"
00047 #include "nsInterfaceHashtable.h"
00048 #include "nsIAtom.h"
00049 
00050 /*
00051  * The implementation of the XML Events Basic profile
00052  */
00053 
00054 class nsXMLEventsManager;
00055 class nsXMLEventsListener : public nsIDOMEventListener {
00056 public:
00057   static PRBool InitXMLEventsListener(nsIDocument * aDocument, 
00058                                       nsXMLEventsManager * aManager, 
00059                                       nsIContent * aContent);
00060   nsXMLEventsListener(nsXMLEventsManager * aManager,
00061                       nsIContent * aElement,
00062                       nsIContent* aObserver,
00063                       nsIContent * aHandler,
00064                       const nsAString& aEvent,
00065                       PRBool aPhase,
00066                       PRBool aStopPropagation,
00067                       PRBool aCancelDefault,
00068                       const nsAString& aTarget);
00069   ~nsXMLEventsListener();
00070   void Unregister();
00071   //Removes this event listener from observer and adds the element back to the
00072   //list of incomplete XML Events declarations in XMLEventsManager
00073   void SetIncomplete();
00074   PRBool ObserverEquals(nsIContent * aTarget);
00075   PRBool HandlerEquals(nsIContent * aTarget);
00076   
00077   NS_DECL_ISUPPORTS
00078   NS_DECL_NSIDOMEVENTLISTENER
00079 private:
00080   nsXMLEventsManager * mManager;
00081   nsCOMPtr<nsIContent> mElement;
00082   nsCOMPtr<nsIContent> mObserver;
00083   nsCOMPtr<nsIContent> mHandler;
00084   nsString mEvent;
00085   nsCOMPtr<nsIAtom> mTarget;
00086   PRPackedBool mPhase;
00087   PRPackedBool mStopPropagation;
00088   PRPackedBool mCancelDefault;
00089   
00090 };
00091 
00092 class nsXMLEventsManager : public nsIDocumentObserver {
00093 public:
00094   nsXMLEventsManager();
00095   ~nsXMLEventsManager();
00096   NS_DECL_ISUPPORTS
00097   NS_DECL_NSIDOCUMENTOBSERVER
00098 
00099   void AddXMLEventsContent(nsIContent * aContent);
00100   void RemoveXMLEventsContent(nsIContent * aContent);
00101   void AddListener(nsIContent * aContent, nsXMLEventsListener * aListener);
00102   //Returns PR_TRUE if a listener was removed.
00103   PRBool RemoveListener(nsIContent * aXMLElement);
00104 private:
00105   void AddListeners(nsIDocument* aDocument);
00106   nsInterfaceHashtable<nsISupportsHashKey,nsXMLEventsListener> mListeners;
00107   nsCOMArray<nsIContent> mIncomplete;
00108 };
00109 
00110 #endif /* nsXMLEventsManager_h___ */