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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
// Copyright 2017 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_VIEW_H_
#define COMPONENTS_USER_EDUCATION_VIEWS_HELP_BUBBLE_VIEW_H_
#include <cstddef>
#include <memory>
#include <optional>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "components/user_education/common/help_bubble/help_bubble_params.h"
#include "components/user_education/views/help_bubble_event_relay.h"
#include "ui/base/interaction/element_identifier.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/views/bubble/bubble_border.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/controls/button/label_button.h"
namespace views {
class ImageView;
class Label;
class MdTextButton;
} // namespace views
namespace user_education {
class HelpBubbleDelegate;
namespace internal {
// Describes how a help bubble should be anchored to a Views element, beyond
// what is specified by the HelpBubbleParams. Should only be instantiated by
// classes derived from HelpBubbleFactory (or in tests).
struct HelpBubbleAnchorParams {
// This is the View to be anchored to (mandatory).
raw_ptr<views::View> view = nullptr;
// This is an optional override of the anchor rect in screen coordinates.
// If unspecified, the bubble is anchored as normal to `view`.
std::optional<gfx::Rect> rect;
// Whether or not a visible arrow should be shown.
bool show_arrow = true;
};
} // namespace internal
// The HelpBubbleView is a special BubbleDialogDelegateView for
// in-product help which educates users about certain Chrome features in
// a deferred context.
class HelpBubbleView : public views::BubbleDialogDelegateView {
METADATA_HEADER(HelpBubbleView, views::BubbleDialogDelegateView)
public:
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kHelpBubbleElementIdForTesting);
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kDefaultButtonIdForTesting);
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kFirstNonDefaultButtonIdForTesting);
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kCloseButtonIdForTesting);
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kBodyTextIdForTesting);
DECLARE_CLASS_ELEMENT_IDENTIFIER_VALUE(kTitleTextIdForTesting);
// Minimum width of the bubble.
static constexpr int kMinWidthDip = 200;
// Maximum width of the bubble. Longer strings will cause wrapping.
static constexpr int kMaxWidthDip = 340;
HelpBubbleView(const HelpBubbleDelegate* delegate,
const internal::HelpBubbleAnchorParams& anchor,
HelpBubbleParams params,
std::unique_ptr<HelpBubbleEventRelay> event_relay = nullptr);
HelpBubbleView(const HelpBubbleView&) = delete;
HelpBubbleView& operator=(const HelpBubbleView&) = delete;
~HelpBubbleView() override;
// Returns whether the given dialog is a help bubble.
static bool IsHelpBubble(views::DialogDelegate* dialog);
views::LabelButton* GetDefaultButtonForTesting() const;
views::LabelButton* GetNonDefaultButtonForTesting(int index) const;
void SetForceAnchorRect(gfx::Rect force_anchor_rect);
protected:
// BubbleDialogDelegateView:
std::u16string GetAccessibleWindowTitle() const override;
void OnWidgetActivationChanged(views::Widget* widget, bool active) override;
void OnThemeChanged() override;
gfx::Size CalculatePreferredSize(
const views::SizeBounds& available_size) const override;
gfx::Rect GetAnchorRect() const override;
void OnBeforeBubbleWidgetInit(views::Widget::InitParams* params,
views::Widget* widget) const override;
private:
FRIEND_TEST_ALL_PREFIXES(HelpBubbleViewTimeoutTest,
RespectsProvidedTimeoutAfterActivate);
FRIEND_TEST_ALL_PREFIXES(HelpBubbleViewsTest, RootViewAccessibleName);
friend class HelpBubbleViewsTest;
friend class HelpBubbleEventRelay;
class AnchorViewObserver;
void MaybeStartAutoCloseTimer();
void OnTimeout();
const raw_ptr<const HelpBubbleDelegate> delegate_;
// In some (mostly South Asian) languages, a button could be wider than the
// normal max width *for the bubble*, after taking margins into account (see
// crbug.com/329216536). So if the minimum width of the bubble - even after
// buttons have gone to a vertical stack - is greater than the normal max
// width, allow the bubble to grow slightly.
int max_bubble_width_ = kMaxWidthDip;
// If set, overrides the anchor bounds within the anchor view.
std::optional<gfx::Rect> local_anchor_bounds_;
raw_ptr<views::ImageView> icon_view_ = nullptr;
std::vector<raw_ptr<views::Label, VectorExperimental>> labels_;
// If the bubble has buttons, it must be focusable.
std::vector<raw_ptr<views::MdTextButton, VectorExperimental>>
non_default_buttons_;
raw_ptr<views::MdTextButton> default_button_ = nullptr;
raw_ptr<views::Button> close_button_ = nullptr;
// This is the base accessible name of the window.
std::u16string accessible_name_;
// This is any additional hint text to read.
std::u16string screenreader_hint_text_;
// Track the number of times the widget has been activated; if it's greater
// than 1 we won't re-read the screenreader hint again.
int activate_count_ = 0;
// Prevents the widget we're anchored to from disappearing when it loses
// focus, even if it's marked as close_on_deactivate.
std::unique_ptr<CloseOnDeactivatePin> anchor_pin_;
// Sniffs events intended for a menu or dialog to ensure that hover, click,
// and tap events are still registered.
std::unique_ptr<HelpBubbleEventRelay> event_relay_;
// Observes the anchor view. Dismisses the help bubble if it loses visibility.
// Useful when our anchor element is not the anchor view.
std::unique_ptr<AnchorViewObserver> anchor_observer_;
// TODO(https://crbug.com/382611284): On some platforms the help bubble is not
// minimized with the window, leading to visual artifacts and errors. For now,
// work around this problem by closing the bubble if the widget is minimized.
// When the underlying issue is fixed at the framework level, this can be
// removed.
#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_MAC)
class PrimaryWidgetObserver;
std::unique_ptr<PrimaryWidgetObserver> primary_widget_observer_;
#endif
// Auto close timeout. If the value is 0 (default), the bubble never times
// out.
base::TimeDelta timeout_;
base::OneShotTimer auto_close_timer_;
base::OnceClosure timeout_callback_;
};
} // namespace user_education
#endif // COMPONENTS_USER_EDUCATION_VIEWS_HELP_BUBBLE_VIEW_H_
|
