Add tray icon when quake window is minimized

.github/actions/spelling/allow/apis.txt

@@ -64,6 +64,7 @@ ITab
 ITaskbar
 IUri
 IVirtual
+KEYSELECT
 LCID
 llabs
 llu
@@ -75,12 +76,16 @@ MULTIPLEUSE
 NCHITTEST
 NCLBUTTONDBLCLK
 NCRBUTTONDBLCLK
+NIF
+NIN
 NOAGGREGATION
 NOASYNC
 NOCHANGEDIR
 NOPROGRESS
 NOREDIRECTIONBITMAP
 NOREPEAT
+NOTIFYICON
+NOTIFYICONDATA
 ntprivapi
 oaidl
 ocidl
@@ -100,9 +105,11 @@ RSHIFT
 schandle
 semver
 serializer
+SETVERSION
 SHELLEXECUTEINFOW
 shobjidl
 SHOWMINIMIZED
+SHOWTIP
 SINGLEUSE
 SIZENS
 smoothstep

src/cascadia/WindowsTerminal/AppHost.cpp

@@ -9,6 +9,7 @@
 #include "../WinRTUtils/inc/WtExeUtils.h"
 #include "resource.h"
 #include "VirtualDesktopUtils.h"
+#include "icon.h"
 
 using namespace winrt::Windows::UI;
 using namespace winrt::Windows::UI::Composition;
@@ -59,9 +60,6 @@ AppHost::AppHost() noexcept :
         _window = std::make_unique<IslandWindow>();
     }
 
-    // Update our own internal state tracking if we're in quake mode or not.
-    _IsQuakeWindowChanged(nullptr, nullptr);
-
     // Tell the window to callback to us when it's about to handle a WM_CREATE
     auto pfn = std::bind(&AppHost::_HandleCreateWindow,
                          this,
@@ -77,9 +75,13 @@ AppHost::AppHost() noexcept :
     _window->MouseScrolled({ this, &AppHost::_WindowMouseWheeled });
     _window->WindowActivated({ this, &AppHost::_WindowActivated });
     _window->HotkeyPressed({ this, &AppHost::_GlobalHotkeyPressed });
+    _window->NotifyTrayIconPressed({ this, &AppHost::_HandleTrayIconPressed });
     _window->SetAlwaysOnTop(_logic.GetInitialAlwaysOnTop());
     _window->MakeWindow();
 
+    // Update our own internal state tracking if we're in quake mode or not.
+    _IsQuakeWindowChanged(nullptr, nullptr);
+
     _windowManager.BecameMonarch({ this, &AppHost::_BecomeMonarch });
     if (_windowManager.IsMonarch())
     {
@@ -915,5 +917,71 @@ void AppHost::_HandleSettingsChanged(const winrt::Windows::Foundation::IInspecta
 void AppHost::_IsQuakeWindowChanged(const winrt::Windows::Foundation::IInspectable&,
                                     const winrt::Windows::Foundation::IInspectable&)
 {
+    if (_window->IsQuakeWindow() && !_logic.IsQuakeWindow())
+    {
+        // If we're exiting quake mode, we should make our
+        // tray icon disappear.
+        if (_trayIconData)
+        {
+            Shell_NotifyIcon(NIM_DELETE, &_trayIconData.value());
+            _trayIconData.reset();
+        }
+    }
+    else if (!_window->IsQuakeWindow() && _logic.IsQuakeWindow())
+    {
+        _UpdateTrayIcon();
+    }
+
     _window->IsQuakeWindow(_logic.IsQuakeWindow());
 }
+
+void AppHost::_HandleTrayIconPressed()
+{
+    // Currently scoping "minimize to tray" to only
+    // the quake window.
+    if (_logic.IsQuakeWindow())
+    {
+        const Remoting::SummonWindowBehavior summonArgs{};
+        summonArgs.DropdownDuration(200);
+        _window->SummonWindow(summonArgs);
+    }
+}
+
+// Method Description:
+// - Creates and adds an icon to the notification tray.
+// Arguments:
+// - <unused>
+// Return Value:
+// - <none>
+void AppHost::_UpdateTrayIcon()
+{
+    if (!_trayIconData)
+    {
+        NOTIFYICONDATA nid{};
+
+        // This HWND will receive the callbacks sent by the tray icon.
+        nid.hWnd = _window->GetHandle();
+
+        // App-defined identifier of the icon. The HWND and ID are used
+        // to identify which icon to operate on when calling Shell_NotifyIcon.
+        // Multiple icons can be associated with one HWND, but here we're only
+        // going to be showing one so the ID doesn't really matter.
+        nid.uID = 1;
+
+        nid.uCallbackMessage = CM_NOTIFY_FROM_TRAY;
+
+        nid.hIcon = static_cast<HICON>(GetActiveAppIconHandle(ICON_SMALL));
+        StringCchCopy(nid.szTip, ARRAYSIZE(nid.szTip), L"Windows Terminal");
+        nid.uFlags = NIF_MESSAGE | NIF_SHOWTIP | NIF_TIP | NIF_ICON;
+        Shell_NotifyIcon(NIM_ADD, &nid);
+
+        // For whatever reason, the NIM_ADD call doesn't seem to set the version
+        // properly, resulting in us being unable to receive the expected notification
+        // events. We actually have to make a separate NIM_SETVERSION call for it to
+        // work properly.
+        nid.uVersion = NOTIFYICON_VERSION_4;
+        Shell_NotifyIcon(NIM_SETVERSION, &nid);
+
+        _trayIconData = nid;
+    }
+}

src/cascadia/WindowsTerminal/AppHost.h

@@ -81,4 +81,9 @@ class AppHost
 
     void _IsQuakeWindowChanged(const winrt::Windows::Foundation::IInspectable& sender,
                                const winrt::Windows::Foundation::IInspectable& args);
+
+    void _UpdateTrayIcon();
+    void _HandleTrayIconPressed();
+
+    std::optional<NOTIFYICONDATA> _trayIconData;
 };

src/cascadia/WindowsTerminal/IslandWindow.cpp

@@ -452,6 +452,7 @@ long IslandWindow::_calculateTotalSize(const bool isWidth, const long clientSize
     {
         if (wparam == SIZE_MINIMIZED && _isQuakeWindow)
         {
+            _NotifyWindowHiddenHandlers();
             ShowWindow(GetHandle(), SW_HIDE);
             return 0;
         }
@@ -506,6 +507,19 @@ long IslandWindow::_calculateTotalSize(const bool isWidth, const long clientSize
     case WM_THEMECHANGED:
         UpdateWindowIconForActiveMetrics(_window.get());
         return 0;
+    case CM_NOTIFY_FROM_TRAY:
+    {
+        switch (LOWORD(lparam))
+        {
+        case NIN_SELECT:
+        case NIN_KEYSELECT:
+        {
+            _NotifyTrayIconPressedHandlers();
+            return 0;
+        }
+        }
+        break;
+    }
     }
 
     // TODO: handle messages here...

src/cascadia/WindowsTerminal/IslandWindow.h

@@ -6,6 +6,8 @@
 #include <winrt/TerminalApp.h>
 #include "../../cascadia/inc/cppwinrt_utils.h"
 
+#define CM_NOTIFY_FROM_TRAY (WM_APP + 1)
+
 class IslandWindow :
     public BaseWindow<IslandWindow>
 {
@@ -51,6 +53,8 @@ class IslandWindow :
     WINRT_CALLBACK(MouseScrolled, winrt::delegate<void(til::point, int32_t)>);
     WINRT_CALLBACK(WindowActivated, winrt::delegate<void()>);
     WINRT_CALLBACK(HotkeyPressed, winrt::delegate<void(long)>);
+    WINRT_CALLBACK(NotifyTrayIconPressed, winrt::delegate<void()>);
+    WINRT_CALLBACK(NotifyWindowHidden, winrt::delegate<void()>);
 
 protected:
     void ForceResize()

src/cascadia/WindowsTerminal/icon.cpp

@@ -27,22 +27,27 @@ static int _GetActiveAppIconResource()
     return iconResource;
 }
 
-void UpdateWindowIconForActiveMetrics(HWND window)
+HANDLE GetActiveAppIconHandle(int size)
 {
     auto iconResource{ MAKEINTRESOURCEW(_GetActiveAppIconResource()) };
 
+    auto smXIcon = size == ICON_SMALL ? SM_CXSMICON : SM_CXICON;
+    auto smYIcon = size == ICON_SMALL ? SM_CYSMICON : SM_CYICON;
+
     // These handles are loaded with LR_SHARED, so they are safe to "leak".
-    HANDLE smallIcon{ LoadImageW(wil::GetModuleInstanceHandle(), iconResource, IMAGE_ICON, GetSystemMetrics(SM_CXSMICON), GetSystemMetrics(SM_CYSMICON), LR_SHARED) };
-    LOG_LAST_ERROR_IF_NULL(smallIcon);
+    HANDLE hIcon{ LoadImageW(wil::GetModuleInstanceHandle(), iconResource, IMAGE_ICON, GetSystemMetrics(smXIcon), GetSystemMetrics(smYIcon), LR_SHARED) };
+    LOG_LAST_ERROR_IF_NULL(hIcon);
 
-    HANDLE largeIcon{ LoadImageW(wil::GetModuleInstanceHandle(), iconResource, IMAGE_ICON, GetSystemMetrics(SM_CXICON), GetSystemMetrics(SM_CYICON), LR_SHARED) };
-    LOG_LAST_ERROR_IF_NULL(largeIcon);
+    return hIcon;
+}
 
-    if (smallIcon)
+void UpdateWindowIconForActiveMetrics(HWND window)
+{
+    if (auto smallIcon = GetActiveAppIconHandle(ICON_SMALL))
     {
         SendMessageW(window, WM_SETICON, ICON_SMALL, reinterpret_cast<LPARAM>(smallIcon));
     }
-    if (largeIcon)
+    else if (auto largeIcon = GetActiveAppIconHandle(ICON_BIG))
     {
         SendMessageW(window, WM_SETICON, ICON_BIG, reinterpret_cast<LPARAM>(largeIcon));
     }

src/cascadia/WindowsTerminal/icon.h

@@ -3,4 +3,5 @@
 
 #pragma once
 
+HANDLE GetActiveAppIconHandle(const int size);
 void UpdateWindowIconForActiveMetrics(HWND window);