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
|
// Copyright 2021 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_USER_EDUCATION_VIEWS_HELP_BUBBLE_FACTORY_VIEWS_H_
#define COMPONENTS_USER_EDUCATION_VIEWS_HELP_BUBBLE_FACTORY_VIEWS_H_
#include "base/callback_list.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "components/user_education/common/help_bubble.h"
#include "components/user_education/common/help_bubble_factory.h"
#include "components/user_education/common/help_bubble_params.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "ui/base/accelerators/accelerator.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/interaction/element_tracker.h"
#include "ui/base/interaction/framework_specific_implementation.h"
#include "ui/color/color_id.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_observer.h"
namespace user_education {
class HelpBubbleDelegate;
class HelpBubbleView;
namespace internal {
struct HelpBubbleAnchorParams;
}
// Views-specific implementation of the help bubble.
//
// Because this is a FrameworkSpecificImplementation, you can use:
// help_bubble->AsA<HelpBubbleViews>()->bubble_view()
// to retrieve the underlying bubble view.
class HelpBubbleViews : public HelpBubble,
public views::WidgetObserver,
public ui::AcceleratorTarget {
public:
~HelpBubbleViews() override;
DECLARE_FRAMEWORK_SPECIFIC_METADATA()
// Retrieve the bubble view. If the bubble has been closed, this may return
// null.
HelpBubbleView* bubble_view() { return help_bubble_view_; }
const HelpBubbleView* bubble_view() const { return help_bubble_view_; }
// HelpBubble:
bool ToggleFocusForAccessibility() override;
void OnAnchorBoundsChanged() override;
gfx::Rect GetBoundsInScreen() const override;
ui::ElementContext GetContext() const override;
// ui::AcceleratorTarget
bool AcceleratorPressed(const ui::Accelerator& accelerator) override;
bool CanHandleAccelerators() const override;
private:
friend class HelpBubbleFactoryViews;
friend class HelpBubbleFactoryMac;
friend class HelpBubbleViewsTest;
explicit HelpBubbleViews(HelpBubbleView* help_bubble_view,
ui::TrackedElement* anchor_element);
// Clean up properties on the anchor view, if applicable.
void MaybeResetAnchorView();
// HelpBubble:
void CloseBubbleImpl() override;
// views::WidgetObserver:
void OnWidgetDestroying(views::Widget* widget) override;
void OnElementHidden(ui::TrackedElement* element);
void OnElementBoundsChanged(ui::TrackedElement* element);
raw_ptr<HelpBubbleView> help_bubble_view_;
base::ScopedObservation<views::Widget, views::WidgetObserver>
scoped_observation_{this};
// Track the anchor element to determine if/when it goes away.
raw_ptr<const ui::TrackedElement, AcrossTasksDanglingUntriaged>
anchor_element_;
// Listens so that the bubble can be closed if the anchor element disappears.
// The specific anchor view is not tracked because in a few cases (e.g. Mac
// native menus) the anchor view is not the anchor element itself but a
// placeholder.
base::CallbackListSubscription anchor_hidden_subscription_;
// Listens for changes to the anchor bounding rect that are independent of the
// anchor view. Necessary for e.g. WebUI elements, which can be scrolled or
// moved within the web page.
base::CallbackListSubscription anchor_bounds_changed_subscription_;
base::WeakPtrFactory<HelpBubbleViews> weak_ptr_factory_{this};
};
// Factory implementation for HelpBubbleViews.
class HelpBubbleFactoryViews : public HelpBubbleFactory {
public:
explicit HelpBubbleFactoryViews(const HelpBubbleDelegate* delegate);
~HelpBubbleFactoryViews() override;
DECLARE_FRAMEWORK_SPECIFIC_METADATA()
// HelpBubbleFactory:
std::unique_ptr<HelpBubble> CreateBubble(ui::TrackedElement* element,
HelpBubbleParams params) override;
bool CanBuildBubbleForTrackedElement(
const ui::TrackedElement* element) const override;
protected:
std::unique_ptr<HelpBubble> CreateBubbleImpl(
ui::TrackedElement* element,
const internal::HelpBubbleAnchorParams& anchor,
HelpBubbleParams params);
private:
raw_ptr<const HelpBubbleDelegate> delegate_;
};
} // namespace user_education
#endif // COMPONENTS_USER_EDUCATION_VIEWS_HELP_BUBBLE_FACTORY_VIEWS_H_
|
