dom/src/base/nsWindowRoot.h

   1 /* -*- Mode: C++; tab-width: 3; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   David W. Hyatt <hyatt@netscape.com> (Original Author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsWindowRoot_h__
  41 #define nsWindowRoot_h__
  42
  43 class nsIDOMWindow;
  44 class nsIDOMEventListener;
  45 class nsIEventListenerManager;
  46 class nsIDOMEvent;
  47 class nsEventChainPreVisitor;
  48 class nsEventChainPostVisitor;
  49
  50 #include "nsIDOMEventTarget.h"
  51 #include "nsIDOM3EventTarget.h"
  52 #include "nsIDOMNSEventTarget.h"
  53 #include "nsIEventListenerManager.h"
  54 #include "nsPIWindowRoot.h"
  55 #include "nsIFocusController.h"
  56 #include "nsIDOMEventTarget.h"
  57 #include "nsCycleCollectionParticipant.h"
  58
  59 class nsWindowRoot : public nsIDOMEventTarget,
  60                      public nsIDOM3EventTarget,
  61                      public nsIDOMNSEventTarget,
  62                      public nsPIWindowRoot
  63 {
  64 public:
  65   nsWindowRoot(nsIDOMWindow* aWindow);
  66   virtual ~nsWindowRoot();
  67
  68   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  69   NS_DECL_NSIDOMEVENTTARGET
  70   NS_DECL_NSIDOM3EVENTTARGET
  71   NS_DECL_NSIDOMNSEVENTTARGET
  72
  73   virtual nsresult PreHandleEvent(nsEventChainPreVisitor& aVisitor);
  74   virtual nsresult PostHandleEvent(nsEventChainPostVisitor& aVisitor);
  75   virtual nsresult DispatchDOMEvent(nsEvent* aEvent,
  76                                     nsIDOMEvent* aDOMEvent,
  77                                     nsPresContext* aPresContext,
  78                                     nsEventStatus* aEventStatus);
  79   virtual nsresult GetListenerManager(PRBool aCreateIfNotFound,
  80                                       nsIEventListenerManager** aResult);
  81   virtual nsresult AddEventListenerByIID(nsIDOMEventListener *aListener,
  82                                          const nsIID& aIID);
  83   virtual nsresult RemoveEventListenerByIID(nsIDOMEventListener *aListener,
  84                                             const nsIID& aIID);
  85   virtual nsresult GetSystemEventGroup(nsIDOMEventGroup** aGroup);
  86   virtual nsresult GetContextForEventHandlers(nsIScriptContext** aContext)
  87   {
  88     *aContext = nsnull;
  89     return NS_OK;
  90   }
  91
  92   // nsPIWindowRoot
  93   NS_IMETHOD GetFocusController(nsIFocusController** aResult);
  94
  95   virtual nsIDOMWindow* GetWindow();
  96
  97   NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsWindowRoot, nsIDOMEventTarget)
  98
  99 protected:
 100   // Members
 101   nsIDOMWindow* mWindow; // [Weak]. The window will hold on to us and let go when it dies.
 102   nsCOMPtr<nsIEventListenerManager> mListenerManager; // [Strong]. We own the manager, which owns event listeners attached
 103                                                       // to us.
 104   nsCOMPtr<nsIFocusController> mFocusController; // The focus controller for the root.
 105 };
 106
 107 extern nsresult
 108 NS_NewWindowRoot(nsIDOMWindow* aWindow,
 109                  nsPIDOMEventTarget** aResult);
 110
 111 #endif