From 7e79563bb9db3ba864e689fd6eb0c243adbc5a84 Mon Sep 17 00:00:00 2001
From: Andreas Kling <kling@serenityos.org>
Date: Mon, 28 Dec 2020 21:26:47 +0100
Subject: [PATCH] LibGUI: Show tooltip after a small delay

It always felt a bit jarring that tooltips would pop in right away when
you hover over a toolbar button. This patch adds a 700ms delay before
they appear, and a 50ms delay before they disappear.

Once a tooltip is up, moving the cursor between two widgets that both
have tooltips will leave the tooltip on screen without delays.
---
 Libraries/LibGUI/Application.cpp      | 122 ++++++++++++++++----------
 Libraries/LibGUI/Application.h        |   7 +-
 Libraries/LibGUI/Widget.cpp           |   2 +-
 Libraries/LibWeb/InProcessWebView.cpp |   4 +-
 4 files changed, 84 insertions(+), 51 deletions(-)

diff --git a/Libraries/LibGUI/Application.cpp b/Libraries/LibGUI/Application.cpp
index 18837aeb07..a70e7d5b39 100644
--- a/Libraries/LibGUI/Application.cpp
+++ b/Libraries/LibGUI/Application.cpp
@@ -40,6 +40,34 @@
 
 namespace GUI {
 
+class Application::TooltipWindow final : public Window {
+    C_OBJECT(TooltipWindow);
+
+public:
+    void set_tooltip(String tooltip)
+    {
+        // FIXME: Add some kind of GUI::Label auto-sizing feature.
+        int text_width = m_label->font().width(tooltip);
+        set_rect(rect().x(), rect().y(), text_width + 10, m_label->font().glyph_height() + 8);
+        m_label->set_text(move(tooltip));
+    }
+
+private:
+    TooltipWindow()
+    {
+        set_window_type(WindowType::Tooltip);
+        m_label = set_main_widget<Label>();
+        m_label->set_background_role(Gfx::ColorRole::Tooltip);
+        m_label->set_foreground_role(Gfx::ColorRole::TooltipText);
+        m_label->set_fill_with_background_color(true);
+        m_label->set_frame_thickness(1);
+        m_label->set_frame_shape(Gfx::FrameShape::Container);
+        m_label->set_frame_shadow(Gfx::FrameShadow::Plain);
+    }
+
+    RefPtr<Label> m_label;
+};
+
 static NeverDestroyed<WeakPtr<Application>> s_the;
 
 Application* Application::the()
@@ -64,6 +92,14 @@ Application::Application(int argc, char** argv)
         String arg(argv[i]);
         m_args.append(move(arg));
     }
+
+    m_tooltip_show_timer = Core::Timer::create_single_shot(700, [this] {
+        tooltip_show_timer_did_fire();
+    });
+
+    m_tooltip_hide_timer = Core::Timer::create_single_shot(50, [this] {
+        tooltip_hide_timer_did_fire();
+    });
 }
 
 Application::~Application()
@@ -108,65 +144,29 @@ Action* Application::action_for_key_event(const KeyEvent& event)
     return (*it).value;
 }
 
-class Application::TooltipWindow final : public Window {
-    C_OBJECT(TooltipWindow);
-
-public:
-    void set_tooltip(const StringView& tooltip)
-    {
-        // FIXME: Add some kind of GUI::Label auto-sizing feature.
-        int text_width = m_label->font().width(tooltip);
-        set_rect(rect().x(), rect().y(), text_width + 10, m_label->font().glyph_height() + 8);
-        m_label->set_text(tooltip);
-    }
-
-private:
-    TooltipWindow()
-    {
-        set_window_type(WindowType::Tooltip);
-        m_label = set_main_widget<Label>();
-        m_label->set_background_role(Gfx::ColorRole::Tooltip);
-        m_label->set_foreground_role(Gfx::ColorRole::TooltipText);
-        m_label->set_fill_with_background_color(true);
-        m_label->set_frame_thickness(1);
-        m_label->set_frame_shape(Gfx::FrameShape::Container);
-        m_label->set_frame_shadow(Gfx::FrameShadow::Plain);
-    }
-
-    RefPtr<Label> m_label;
-};
-
-void Application::show_tooltip(const StringView& tooltip, const Gfx::IntPoint& screen_location, const Widget* tooltip_source_widget)
+void Application::show_tooltip(String tooltip, const Widget* tooltip_source_widget)
 {
     m_tooltip_source_widget = tooltip_source_widget;
     if (!m_tooltip_window) {
         m_tooltip_window = TooltipWindow::construct();
         m_tooltip_window->set_double_buffering_enabled(false);
     }
-    m_tooltip_window->set_tooltip(tooltip);
+    m_tooltip_window->set_tooltip(move(tooltip));
 
-    Gfx::IntRect desktop_rect = Desktop::the().rect();
-
-    const int margin = 30;
-    Gfx::IntPoint adjusted_pos = screen_location;
-    if (adjusted_pos.x() + m_tooltip_window->width() >= desktop_rect.width() - margin) {
-        adjusted_pos = adjusted_pos.translated(-m_tooltip_window->width(), 0);
+    if (m_tooltip_window->is_visible()) {
+        tooltip_show_timer_did_fire();
+        m_tooltip_show_timer->stop();
+        m_tooltip_hide_timer->stop();
+    } else {
+        m_tooltip_show_timer->restart();
+        m_tooltip_hide_timer->stop();
     }
-    if (adjusted_pos.y() + m_tooltip_window->height() >= desktop_rect.height() - margin) {
-        adjusted_pos = adjusted_pos.translated(0, -(m_tooltip_window->height() * 2));
-    }
-
-    m_tooltip_window->move_to(adjusted_pos);
-    m_tooltip_window->show();
 }
 
 void Application::hide_tooltip()
 {
-    m_tooltip_source_widget = nullptr;
-    if (m_tooltip_window) {
-        m_tooltip_window->hide();
-        m_tooltip_window = nullptr;
-    }
+    m_tooltip_show_timer->stop();
+    m_tooltip_hide_timer->start();
 }
 
 void Application::did_create_window(Badge<Window>)
@@ -202,4 +202,32 @@ Gfx::Palette Application::palette() const
     return Palette(*m_palette);
 }
 
+void Application::tooltip_show_timer_did_fire()
+{
+    ASSERT(m_tooltip_window);
+    Gfx::IntRect desktop_rect = Desktop::the().rect();
+
+    const int margin = 30;
+    Gfx::IntPoint adjusted_pos = WindowServerConnection::the().send_sync<Messages::WindowServer::GetGlobalCursorPosition>()->position();
+
+    adjusted_pos.move_by(0, 18);
+
+    if (adjusted_pos.x() + m_tooltip_window->width() >= desktop_rect.width() - margin) {
+        adjusted_pos = adjusted_pos.translated(-m_tooltip_window->width(), 0);
+    }
+    if (adjusted_pos.y() + m_tooltip_window->height() >= desktop_rect.height() - margin) {
+        adjusted_pos = adjusted_pos.translated(0, -(m_tooltip_window->height() * 2));
+    }
+
+    m_tooltip_window->move_to(adjusted_pos);
+    m_tooltip_window->show();
+}
+
+void Application::tooltip_hide_timer_did_fire()
+{
+    m_tooltip_source_widget = nullptr;
+    if (m_tooltip_window)
+        m_tooltip_window->hide();
+}
+
 }
diff --git a/Libraries/LibGUI/Application.h b/Libraries/LibGUI/Application.h
index d28b9da7ce..834120bf16 100644
--- a/Libraries/LibGUI/Application.h
+++ b/Libraries/LibGUI/Application.h
@@ -54,7 +54,7 @@ public:
     void register_global_shortcut_action(Badge<Action>, Action&);
     void unregister_global_shortcut_action(Badge<Action>, Action&);
 
-    void show_tooltip(const StringView&, const Gfx::IntPoint& screen_location, const Widget* tooltip_source_widget);
+    void show_tooltip(String, const Widget* tooltip_source_widget);
     void hide_tooltip();
     Widget* tooltip_source_widget() { return m_tooltip_source_widget; };
 
@@ -79,12 +79,17 @@ public:
 private:
     Application(int argc, char** argv);
 
+    void tooltip_show_timer_did_fire();
+    void tooltip_hide_timer_did_fire();
+
     OwnPtr<Core::EventLoop> m_event_loop;
     RefPtr<MenuBar> m_menubar;
     RefPtr<Gfx::PaletteImpl> m_palette;
     RefPtr<Gfx::PaletteImpl> m_system_palette;
     HashMap<Shortcut, Action*> m_global_shortcut_actions;
     class TooltipWindow;
+    RefPtr<Core::Timer> m_tooltip_show_timer;
+    RefPtr<Core::Timer> m_tooltip_hide_timer;
     RefPtr<TooltipWindow> m_tooltip_window;
     RefPtr<Widget> m_tooltip_source_widget;
     bool m_quit_when_last_window_deleted { true };
diff --git a/Libraries/LibGUI/Widget.cpp b/Libraries/LibGUI/Widget.cpp
index 47aaf29646..3f68cc22c2 100644
--- a/Libraries/LibGUI/Widget.cpp
+++ b/Libraries/LibGUI/Widget.cpp
@@ -919,7 +919,7 @@ void Widget::set_tooltip(const StringView& tooltip)
 void Widget::show_tooltip()
 {
     if (has_tooltip())
-        Application::the()->show_tooltip(m_tooltip, screen_relative_rect().center().translated(0, height() / 2), this);
+        Application::the()->show_tooltip(m_tooltip, this);
 }
 
 Gfx::IntRect Widget::children_clip_rect() const
diff --git a/Libraries/LibWeb/InProcessWebView.cpp b/Libraries/LibWeb/InProcessWebView.cpp
index 8701583145..1fa94ec3de 100644
--- a/Libraries/LibWeb/InProcessWebView.cpp
+++ b/Libraries/LibWeb/InProcessWebView.cpp
@@ -201,9 +201,9 @@ void InProcessWebView::page_did_middle_click_link(const URL& url, const String&
         on_link_middle_click(url, target, modifiers);
 }
 
-void InProcessWebView::page_did_enter_tooltip_area(const Gfx::IntPoint& content_position, const String& title)
+void InProcessWebView::page_did_enter_tooltip_area([[maybe_unused]] const Gfx::IntPoint& content_position, const String& title)
 {
-    GUI::Application::the()->show_tooltip(title, screen_relative_rect().location().translated(to_widget_position(content_position)), nullptr);
+    GUI::Application::the()->show_tooltip(title, nullptr);
 }
 
 void InProcessWebView::page_did_leave_tooltip_area()