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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_VIEWS_BUBBLE_TOOLTIP_ICON_H_
#define UI_VIEWS_BUBBLE_TOOLTIP_ICON_H_
#include <memory>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "base/scoped_observation.h"
#include "base/timer/timer.h"
#include "ui/views/bubble/bubble_border.h"
#include "ui/views/controls/image_view.h"
#include "ui/views/mouse_watcher.h"
#include "ui/views/views_export.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_observer.h"
namespace views {
class InfoBubble;
// A tooltip icon that shows a bubble on hover. Looks like (i).
class VIEWS_EXPORT TooltipIcon : public ImageView,
public MouseWatcherListener,
public WidgetObserver {
METADATA_HEADER(TooltipIcon, ImageView)
public:
class Observer : public base::CheckedObserver {
public:
// Called when tooltip bubble of the TooltipIcon is shown.
virtual void OnTooltipBubbleShown(TooltipIcon* icon) = 0;
// Called when the TooltipIcon is being destroyed.
virtual void OnTooltipIconDestroying(TooltipIcon* icon) = 0;
};
explicit TooltipIcon(const std::u16string& tooltip,
int tooltip_icon_size = 16);
TooltipIcon(const TooltipIcon&) = delete;
TooltipIcon& operator=(const TooltipIcon&) = delete;
~TooltipIcon() override;
// Sets and gets the bubble preferred width.
void SetBubbleWidth(int preferred_width);
int GetBubbleWidth() const;
// Sets and gets the point at which to anchor the tooltip.
void SetAnchorPointArrow(BubbleBorder::Arrow arrow);
BubbleBorder::Arrow GetAnchorPointArrow() const;
// ImageView:
void OnMouseEntered(const ui::MouseEvent& event) override;
void OnMouseExited(const ui::MouseEvent& event) override;
bool OnMousePressed(const ui::MouseEvent& event) override;
void OnFocus() override;
void OnBlur() override;
void OnGestureEvent(ui::GestureEvent* event) override;
void OnThemeChanged() override;
// MouseWatcherListener:
void MouseMovedOutOfHost() override;
// WidgetObserver:
void OnWidgetDestroyed(Widget* widget) override;
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
private:
// Changes the color to reflect the hover node_data.
void SetDrawAsHovered(bool hovered);
// Creates and shows |bubble_|. If |bubble_| already exists, just cancels a
// potential close timer.
void ShowBubble();
// Hides |bubble_| if necessary.
void HideBubble();
// The text to show in a bubble when hovered.
std::u16string tooltip_;
// The size of the tooltip icon, in dip.
// Must be set in the constructor, otherwise the pre-hovered icon will show
// the default size.
int tooltip_icon_size_;
// The point at which to anchor the tooltip.
BubbleBorder::Arrow anchor_point_arrow_ = BubbleBorder::TOP_RIGHT;
// Whether the mouse is inside this tooltip.
bool mouse_inside_ = false;
// A bubble shown on hover. Weak; owns itself. NULL while hiding.
raw_ptr<InfoBubble> bubble_;
// The width the tooltip prefers to be. Default is 0 (no preference).
int preferred_width_ = 0;
// A timer to delay showing |bubble_|.
base::OneShotTimer show_timer_;
// A watcher that keeps |bubble_| open if the user's mouse enters it.
std::unique_ptr<MouseWatcher> mouse_watcher_;
base::ScopedObservation<Widget, WidgetObserver> observation_{this};
base::ObserverList<Observer, /*check_empty=*/true> observers_;
};
BEGIN_VIEW_BUILDER(VIEWS_EXPORT, TooltipIcon, ImageView)
VIEW_BUILDER_PROPERTY(int, BubbleWidth)
VIEW_BUILDER_PROPERTY(BubbleBorder::Arrow, AnchorPointArrow)
END_VIEW_BUILDER
} // namespace views
DEFINE_VIEW_BUILDER(VIEWS_EXPORT, views::TooltipIcon)
#endif // UI_VIEWS_BUBBLE_TOOLTIP_ICON_H_
|
