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
|
// 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 UI_VIEWS_COREWM_TOOLTIP_STATE_MANAGER_H_
#define UI_VIEWS_COREWM_TOOLTIP_STATE_MANAGER_H_
#include <map>
#include <memory>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
#include "ui/gfx/geometry/point.h"
#include "ui/views/corewm/tooltip.h"
#include "ui/views/corewm/tooltip_controller.h"
#include "ui/views/views_export.h"
namespace aura {
class Window;
}
namespace wm {
class TooltipObserver;
}
namespace views::corewm {
namespace test {
class TooltipControllerTestHelper;
} // namespace test
// TooltipStateManager separates the state handling from the events handling of
// the TooltipController. It is in charge of updating the tooltip state and
// keeping track of it.
class VIEWS_EXPORT TooltipStateManager {
public:
explicit TooltipStateManager(std::unique_ptr<Tooltip> tooltip);
TooltipStateManager(const TooltipStateManager&) = delete;
TooltipStateManager& operator=(const TooltipStateManager&) = delete;
~TooltipStateManager();
void AddObserver(wm::TooltipObserver* observer);
void RemoveObserver(wm::TooltipObserver* observer);
int GetMaxWidth(const gfx::Point& location) const;
// Hides the tooltip, clears timers, and resets controller states.
void HideAndReset();
bool IsVisible() const { return tooltip_->IsVisible(); }
// Updates the tooltip state attributes and starts timer to show the tooltip.
// If `hide_delay` is greater than 0, sets a timer to hide it after a specific
// delay. Otherwise, shows the tooltip indefinitely.
void Show(aura::Window* window,
const std::u16string& tooltip_text,
const gfx::Point& position,
TooltipTrigger trigger,
const base::TimeDelta show_delay,
const base::TimeDelta hide_delay);
// Returns the `tooltip_id_`, which corresponds to the pointer of the view on
// which the tooltip was last added.
const void* tooltip_id() const { return tooltip_id_; }
// Returns the `tooltip_text_`, which corresponds to the last value the
// tooltip got updated to.
const std::u16string& tooltip_text() const { return tooltip_text_; }
const aura::Window* tooltip_parent_window() const {
return tooltip_parent_window_;
}
TooltipTrigger tooltip_trigger() const { return tooltip_trigger_; }
// Updates the 'position_' if we're about to show the tooltip. This is to
// ensure that the tooltip's position is aligned with either the latest cursor
// location for a cursor triggered tooltip or the most recent position
// received for a keyboard triggered tooltip.
void UpdatePositionIfNeeded(const gfx::Point& position,
TooltipTrigger trigger);
private:
friend class test::TooltipControllerTestHelper;
// Called once the `will_show_tooltip_timer_` fires to show the tooltip.
void ShowNow(const std::u16string& trimmed_text,
const base::TimeDelta hide_delay);
// Start the show timer to show the tooltip.
void StartWillShowTooltipTimer(const std::u16string& trimmed_text,
const base::TimeDelta show_delay,
const base::TimeDelta hide_delay);
// For tests only.
bool IsWillShowTooltipTimerRunningForTesting() const {
return will_show_tooltip_timer_.IsRunning();
}
bool IsWillHideTooltipTimerRunningForTesting() const {
return will_hide_tooltip_timer_.IsRunning();
}
// The current position of the tooltip. This position is relative to the
// `tooltip_parent_window_` and in that window's coordinate space.
gfx::Point position_;
std::unique_ptr<Tooltip> tooltip_;
// The pointer to the view for which the tooltip is set.
// TODO(crbug.com/40285438) - Fix this dangling pointer.
raw_ptr<const void, DanglingUntriaged> tooltip_id_ = nullptr;
// The text value used at the last tooltip update.
std::u16string tooltip_text_;
// The window on which the tooltip is added.
raw_ptr<aura::Window> tooltip_parent_window_ = nullptr;
TooltipTrigger tooltip_trigger_ = TooltipTrigger::kCursor;
// Two timers for the tooltip: one to hide an on-screen tooltip after a delay,
// and one to display the tooltip when the timer fires.
base::OneShotTimer will_hide_tooltip_timer_;
base::OneShotTimer will_show_tooltip_timer_;
// WeakPtrFactory to use for callbacks.
base::WeakPtrFactory<TooltipStateManager> weak_factory_{this};
};
} // namespace views::corewm
#endif // UI_VIEWS_COREWM_TOOLTIP_STATE_MANAGER_H_
|
