fune/dom/base/nsPIWindowRoot.h
Masayuki Nakano c84dfd928f Bug 1455514 - part 2: Add accessors and static helper methods to retrieve nsPIDOMWindowInner, nsPIDOMWindowOuter and nsPIWindowRoot r=smaug
Similar to the previous patch, there are a lot of QI from `EventTarget` to
window interfaces.  This patch adds them, but unfortunately,
`nsPIDOMWindowInner` and `nsPIDOMWindowOuter` do not inherit `EventTarget`
directly, and they are in a public header instead of their concrete classes
(`nsGlobalWindowInner` and `nsGlobalWindowOuter`).  So we cannot cast them
in `nsPIDOMWindow.h`, and it causes it's impossible to use the macros added
by the previous patch.

Differential Revision: https://phabricator.services.mozilla.com/D129782
2021-11-02 13:03:43 +00:00

99 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsPIWindowRoot_h__
#define nsPIWindowRoot_h__
#include "nsISupports.h"
#include "mozilla/dom/EventTarget.h"
class nsPIDOMWindowOuter;
class nsIControllers;
class nsIController;
class nsINode;
class nsIRemoteTab;
#define NS_IWINDOWROOT_IID \
{ \
0xb8724c49, 0xc398, 0x4f9b, { \
0x82, 0x59, 0x87, 0x27, 0xa6, 0x47, 0xdd, 0x0f \
} \
}
class nsPIWindowRoot : public mozilla::dom::EventTarget {
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IWINDOWROOT_IID)
bool IsRootWindow() const final { return true; }
NS_IMPL_FROMEVENTTARGET_HELPER(nsPIWindowRoot, IsRootWindow())
virtual nsPIDOMWindowOuter* GetWindow() = 0;
// get and set the node that is the context of a popup menu
virtual already_AddRefed<nsINode> GetPopupNode() = 0;
virtual void SetPopupNode(nsINode* aNode) = 0;
/**
* @param aForVisibleWindow true if caller needs controller which is
* associated with visible window.
*/
virtual nsresult GetControllerForCommand(const char* aCommand,
bool aForVisibleWindow,
nsIController** aResult) = 0;
/**
* @param aForVisibleWindow true if caller needs controllers which are
* associated with visible window.
*/
virtual nsresult GetControllers(bool aForVisibleWindow,
nsIControllers** aResult) = 0;
virtual void GetEnabledDisabledCommands(
nsTArray<nsCString>& aEnabledCommands,
nsTArray<nsCString>& aDisabledCommands) = 0;
virtual void SetParentTarget(mozilla::dom::EventTarget* aTarget) = 0;
virtual mozilla::dom::EventTarget* GetParentTarget() = 0;
// Stores a weak reference to the browser.
virtual void AddBrowser(nsIRemoteTab* aBrowser) = 0;
virtual void RemoveBrowser(nsIRemoteTab* aBrowser) = 0;
using BrowserEnumerator = void (*)(nsIRemoteTab* aTab, void* aArg);
// Enumerate all stored browsers that for which the weak reference is valid.
virtual void EnumerateBrowsers(BrowserEnumerator aEnumFunc, void* aArg) = 0;
virtual bool ShowFocusRings() = 0;
virtual void SetShowFocusRings(bool aEnable) = 0;
};
namespace mozilla::dom {
inline nsPIWindowRoot* EventTarget::GetAsWindowRoot() {
return IsRootWindow() ? static_cast<nsPIWindowRoot*>(this) : nullptr;
}
inline const nsPIWindowRoot* EventTarget::GetAsWindowRoot() const {
return IsRootWindow() ? static_cast<const nsPIWindowRoot*>(this) : nullptr;
}
inline nsPIWindowRoot* EventTarget::AsWindowRoot() {
MOZ_DIAGNOSTIC_ASSERT(IsRootWindow());
return static_cast<nsPIWindowRoot*>(this);
}
inline const nsPIWindowRoot* EventTarget::AsWindowRoot() const {
MOZ_DIAGNOSTIC_ASSERT(IsRootWindow());
return static_cast<const nsPIWindowRoot*>(this);
}
} // namespace mozilla::dom
NS_DEFINE_STATIC_IID_ACCESSOR(nsPIWindowRoot, NS_IWINDOWROOT_IID)
#endif // nsPIWindowRoot_h__