qt: generate tray icons for macOS, update script, set at runtime

Author: kwvg

contrib/devtools/gen_macos_icons.py

@@ -25,6 +25,7 @@
     ("macos_regtest.png", "dash_macos_regtest.png"),
     ("macos_testnet.png", "dash_macos_testnet.png"),
 ]
+TRAY = os.path.join(DIR_SRC, "tray.svg")
 
 # Canvas to filename mapping for bundle icon
 ICNS_MAP = [
@@ -40,6 +41,14 @@
     (1024, "icon_512x512@2x.png"),
 ]
 
+# Maximum height of canvas is 22pt, we use max height instead of recommended
+# 16pt canvas to prevent the icon from looking undersized due to icon width.
+# See https://bjango.com/articles/designingmenubarextras/
+TRAY_MAP = [
+    (22, "dash_macos_tray.png"),
+    (44, "dash_macos_tray@2x.png")
+]
+
 
 def sips_resample_padded(src, dst, canvas_size):
     content_size = max(round(canvas_size * CONTENT_RATIO), 1)
@@ -49,6 +58,13 @@ def sips_resample_padded(src, dst, canvas_size):
     )
 
 
+def sips_svg_to_png(svg_path, png_path, height):
+    subprocess.check_call(
+        ["sips", "-s", "format", "png", "--resampleHeight", str(height), svg_path, "--out", png_path],
+        stdout=subprocess.DEVNULL,
+    )
+
+
 def generate_icns(tmpdir):
     iconset = os.path.join(tmpdir, "dash.iconset")
     os.makedirs(iconset)
@@ -62,16 +78,22 @@ def generate_icns(tmpdir):
     print(f"Created: {icns_out}")
 
 
+def check_source(path):
+    if not os.path.isfile(path):
+        sys.exit(f"Error: Source image not found: {path}")
+
+
 def main():
     if platform.system() != "Darwin":
         sys.exit("Error: This script requires macOS (needs sips, iconutil).")
+
     for tool in ("sips", "iconutil"):
         if shutil.which(tool) is None:
             sys.exit(f"Error: '{tool}' not found. Install Xcode command-line tools.")
+
+    check_source(TRAY)
     for src_name, _ in ICONS:
-        src = os.path.join(DIR_SRC, src_name)
-        if not os.path.isfile(src):
-            sys.exit(f"Error: Source image not found: {src}")
+        check_source(os.path.join(DIR_SRC, src_name))
 
     os.makedirs(DIR_OUT, exist_ok=True)
 
@@ -86,6 +108,11 @@ def main():
         sips_resample_padded(src, dst, 256)
         print(f"Created: {dst}")
 
+    # Generate tray icons
+    for canvas_px, filename in TRAY_MAP:
+        dst = os.path.join(DIR_OUT, filename)
+        sips_svg_to_png(TRAY, dst, canvas_px)
+        print(f"Created: {dst}")
 
 if __name__ == "__main__":
     main()

src/Makefile.qt.include

@@ -220,6 +220,8 @@ QT_RES_ICONS = \
   qt/res/icons/dash_macos_mainnet.png \
   qt/res/icons/dash_macos_regtest.png \
   qt/res/icons/dash_macos_testnet.png \
+  qt/res/icons/dash_macos_tray.png \
+  qt/res/icons/dash_macos_tray@2x.png \
   qt/res/icons/dash_testnet.ico \
   qt/res/icons/editcopy.png \
   qt/res/icons/editpaste.png \

src/qt/bitcoingui.cpp

@@ -1121,7 +1121,13 @@ void BitcoinGUI::createTrayIcon()
     assert(QSystemTrayIcon::isSystemTrayAvailable());
 
     if (QSystemTrayIcon::isSystemTrayAvailable()) {
-        trayIcon = new QSystemTrayIcon(m_network_style->getTrayAndWindowIcon(), this);
+        QIcon icon{m_network_style->getTrayAndWindowIcon()};
+#ifdef Q_OS_MACOS
+        if (auto macos_tray{m_network_style->getMacTray()}) {
+            icon = macos_tray.value();
+        }
+#endif // Q_OS_MACOS
+        trayIcon = new QSystemTrayIcon(icon, this);
         QString toolTip = tr("%1 client").arg(PACKAGE_NAME) + " " + m_network_style->getTitleAddText();
         trayIcon->setToolTip(toolTip);
     }

src/qt/dash.qrc

@@ -5,6 +5,8 @@
         <file alias="dash_macos_mainnet">res/icons/dash_macos_mainnet.png</file>
         <file alias="dash_macos_regtest">res/icons/dash_macos_regtest.png</file>
         <file alias="dash_macos_testnet">res/icons/dash_macos_testnet.png</file>
+        <file alias="dash_macos_tray">res/icons/dash_macos_tray.png</file>
+        <file alias="dash_macos_tray@2x">res/icons/dash_macos_tray@2x.png</file>
         <file alias="warning">res/icons/warning.png</file>
         <file alias="address-book">res/icons/address-book.png</file>
         <file alias="connect_1">res/icons/connect1_16.png</file>

src/qt/networkstyle.cpp

@@ -93,6 +93,8 @@ NetworkStyle::NetworkStyle(const QString &_appName, const int iconColorHueShift,
     if (_macIconPath) {
         m_macos_icon = QIcon(QPixmap(_macIconPath));
     }
+    m_macos_tray = QIcon(QPixmap(":/icons/dash_macos_tray"));
+    m_macos_tray->setIsMask(true);
 #endif // Q_OS_MACOS
 }
 

src/qt/networkstyle.h

@@ -27,6 +27,7 @@ class NetworkStyle
     const QColor &getBadgeColor() const { return badgeColor; }
 #ifdef Q_OS_MACOS
     std::optional<QIcon> getMacIcon() const { return m_macos_icon; }
+    std::optional<QIcon> getMacTray() const { return m_macos_tray; }
 #endif // Q_OS_MACOS
 
 private:
@@ -41,6 +42,7 @@ class NetworkStyle
     QColor badgeColor;
 #ifdef Q_OS_MACOS
     std::optional<QIcon> m_macos_icon;
+    std::optional<QIcon> m_macos_tray;
 #endif // Q_OS_MACOS
 
     void rotateColor(QColor& col, const int iconColorHueShift, const int iconColorSaturationReduction);