docshell/base/nsDocShellTreeOwner.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsDocShellTreeOwner_h__
   8 #define nsDocShellTreeOwner_h__
   9
  10 // Helper Classes
  11 #include "nsCOMPtr.h"
  12 #include "nsString.h"
  13
  14 // Interfaces Needed
  15 #include "nsIBaseWindow.h"
  16 #include "nsIDocShellTreeOwner.h"
  17 #include "nsIInterfaceRequestor.h"
  18 #include "nsIInterfaceRequestorUtils.h"
  19 #include "nsIWebBrowserChrome.h"
  20 #include "nsIDOMEventListener.h"
  21 #include "nsIEmbeddingSiteWindow.h"
  22 #include "nsIWebProgressListener.h"
  23 #include "nsWeakReference.h"
  24 #include "nsITimer.h"
  25 #include "nsIPrompt.h"
  26 #include "nsIAuthPrompt.h"
  27 #include "nsITooltipTextProvider.h"
  28 #include "nsCTooltipTextProvider.h"
  29
  30 namespace mozilla {
  31 namespace dom {
  32 class Event;
  33 class EventTarget;
  34 }  // namespace dom
  35 }  // namespace mozilla
  36
  37 class nsIDocShellTreeItem;
  38 class nsWebBrowser;
  39 class ChromeTooltipListener;
  40
  41 class nsDocShellTreeOwner final : public nsIDocShellTreeOwner,
  42                                   public nsIBaseWindow,
  43                                   public nsIInterfaceRequestor,
  44                                   public nsIWebProgressListener,
  45                                   public nsIDOMEventListener,
  46                                   public nsSupportsWeakReference {
  47   friend class nsWebBrowser;
  48
  49  public:
  50   NS_DECL_ISUPPORTS
  51
  52   NS_DECL_NSIBASEWINDOW
  53   NS_DECL_NSIDOCSHELLTREEOWNER
  54   NS_DECL_NSIDOMEVENTLISTENER
  55   NS_DECL_NSIINTERFACEREQUESTOR
  56   NS_DECL_NSIWEBPROGRESSLISTENER
  57
  58  protected:
  59   nsDocShellTreeOwner();
  60   virtual ~nsDocShellTreeOwner();
  61
  62   void WebBrowser(nsWebBrowser* aWebBrowser);
  63
  64   nsWebBrowser* WebBrowser();
  65   NS_IMETHOD SetTreeOwner(nsIDocShellTreeOwner* aTreeOwner);
  66   NS_IMETHOD SetWebBrowserChrome(nsIWebBrowserChrome* aWebBrowserChrome);
  67
  68   NS_IMETHOD AddChromeListeners();
  69   NS_IMETHOD RemoveChromeListeners();
  70
  71   void EnsurePrompter();
  72   void EnsureAuthPrompter();
  73
  74   void AddToWatcher();
  75   void RemoveFromWatcher();
  76
  77   void EnsureContentTreeOwner();
  78
  79   // These helper functions return the correct instances of the requested
  80   // interfaces.  If the object passed to SetWebBrowserChrome() implements
  81   // nsISupportsWeakReference, then these functions call QueryReferent on
  82   // that object.  Otherwise, they return an addrefed pointer.  If the
  83   // WebBrowserChrome object doesn't exist, they return nullptr.
  84   already_AddRefed<nsIWebBrowserChrome> GetWebBrowserChrome();
  85   already_AddRefed<nsIEmbeddingSiteWindow> GetOwnerWin();
  86   already_AddRefed<nsIInterfaceRequestor> GetOwnerRequestor();
  87
  88  protected:
  89   // Weak References
  90   nsWebBrowser* mWebBrowser;
  91   nsIDocShellTreeOwner* mTreeOwner;
  92   nsIDocShellTreeItem* mPrimaryContentShell;
  93
  94   nsIWebBrowserChrome* mWebBrowserChrome;
  95   nsIEmbeddingSiteWindow* mOwnerWin;
  96   nsIInterfaceRequestor* mOwnerRequestor;
  97
  98   nsWeakPtr mWebBrowserChromeWeak;  // nsIWebBrowserChrome
  99
 100   // the objects that listen for chrome events like context menus and tooltips.
 101   // They are separate objects to avoid circular references between |this|
 102   // and the DOM.
 103   RefPtr<ChromeTooltipListener> mChromeTooltipListener;
 104
 105   RefPtr<nsDocShellTreeOwner> mContentTreeOwner;
 106
 107   nsCOMPtr<nsIPrompt> mPrompter;
 108   nsCOMPtr<nsIAuthPrompt> mAuthPrompter;
 109   nsCOMPtr<nsIRemoteTab> mPrimaryRemoteTab;
 110 };
 111
 112 #endif /* nsDocShellTreeOwner_h__ */