1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_WEB_MODAL_WEB_CONTENTS_MODAL_DIALOG_MANAGER_H_
#define COMPONENTS_WEB_MODAL_WEB_CONTENTS_MODAL_DIALOG_MANAGER_H_
#include <memory>
#include "base/containers/circular_deque.h"
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "build/build_config.h"
#include "components/web_modal/single_web_contents_dialog_manager.h"
#include "components/web_modal/web_modal_export.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/gfx/native_widget_types.h"
namespace content {
enum class Visibility;
} // namespace content
namespace web_modal {
class WebContentsModalDialogManagerDelegate;
// Per-WebContents class to manage WebContents-modal dialogs.
class WEB_MODAL_EXPORT WebContentsModalDialogManager
: public SingleWebContentsDialogManagerDelegate,
public content::WebContentsObserver,
public content::WebContentsUserData<WebContentsModalDialogManager> {
public:
// Observes when web modal dialog is about to close as a result of a page
// navigation.
class Observer : public base::CheckedObserver {
public:
Observer(const Observer&) = delete;
Observer& operator=(const Observer&) = delete;
// Called when the web modal is closing due to host web contents navigation.
virtual void OnWillCloseOnNavigation() {}
// Called when ShowDialogWithManager() is called.
virtual void OnWillShow() {}
protected:
Observer() = default;
};
WebContentsModalDialogManager(const WebContentsModalDialogManager&) = delete;
WebContentsModalDialogManager& operator=(
const WebContentsModalDialogManager&) = delete;
~WebContentsModalDialogManager() override;
WebContentsModalDialogManagerDelegate* delegate() const { return delegate_; }
void SetDelegate(WebContentsModalDialogManagerDelegate* d);
// Allow clients to supply their own native dialog manager. Suitable for
// bubble clients.
void ShowDialogWithManager(
gfx::NativeWindow dialog,
std::unique_ptr<SingleWebContentsDialogManager> manager);
// Returns true if any dialogs are active and not closed.
bool IsDialogActive() const;
// Focus the topmost modal dialog. IsDialogActive() must be true when calling
// this function.
void FocusTopmostDialog() const;
// Manages observer for when dialogs are closed as a result of page
// navigation.
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// SingleWebContentsDialogManagerDelegate:
content::WebContents* GetWebContents() const override;
void WillClose(gfx::NativeWindow dialog) override;
// For testing.
class TestApi {
public:
explicit TestApi(WebContentsModalDialogManager* manager)
: manager_(manager) {}
TestApi(const TestApi&) = delete;
TestApi& operator=(const TestApi&) = delete;
void CloseAllDialogs() { manager_->CloseAllDialogs(); }
void WebContentsVisibilityChanged(content::Visibility visibility) {
manager_->OnVisibilityChanged(visibility);
}
private:
raw_ptr<WebContentsModalDialogManager> manager_;
};
// Closes all WebContentsModalDialogs.
void CloseAllDialogs();
private:
explicit WebContentsModalDialogManager(content::WebContents* web_contents);
friend class content::WebContentsUserData<WebContentsModalDialogManager>;
struct DialogState {
DialogState(gfx::NativeWindow dialog,
std::unique_ptr<SingleWebContentsDialogManager> manager);
DialogState(DialogState&& state);
~DialogState();
gfx::NativeWindow dialog;
std::unique_ptr<SingleWebContentsDialogManager> manager;
};
// Blocks/unblocks interaction with renderer process.
void BlockWebContentsInteraction(bool blocked);
bool IsWebContentsVisible() const;
// Overridden from content::WebContentsObserver:
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
void DidGetIgnoredUIEvent() override;
void OnVisibilityChanged(content::Visibility visibility) override;
void WebContentsDestroyed() override;
// Delegate for notifying our owner about stuff. Not owned by us.
raw_ptr<WebContentsModalDialogManagerDelegate> delegate_ = nullptr;
// All active dialogs.
base::circular_deque<DialogState> child_dialogs_;
// The WebContents' visibility.
content::Visibility web_contents_visibility_;
// True while closing the dialogs on WebContents close.
bool closing_all_dialogs_ = false;
// Optional closure to re-enable input events, if we're ignored them.
std::optional<content::WebContents::ScopedIgnoreInputEvents>
scoped_ignore_input_events_;
base::ObserverList<Observer> observer_list_;
WEB_CONTENTS_USER_DATA_KEY_DECL();
};
} // namespace web_modal
#endif // COMPONENTS_WEB_MODAL_WEB_CONTENTS_MODAL_DIALOG_MANAGER_H_
|
