qt: add qt.style option (#1839)

This allows you to set a theme for Qt applications. For example, if you want to use `adwaita-qt` theme to have uniform look between Gtk and Qt applications, you can use it like this: ```nix { qt = { enable = true; platformTheme = "gnome"; style = { name = "adwaita"; package = pkgs.adwaita-qt; }; }; } ```
nix-community · Mar 4, 2021 · 0e2dc4b · 0e2dc4b
1 parent 39e4991
commit 0e2dc4b
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 3 deletions.
diff --git a/modules/misc/qt.nix b/modules/misc/qt.nix
@@ -44,19 +44,72 @@ in {
           </variablelist>
         '';
       };
+
+      style = {
+        name = mkOption {
+          type = types.nullOr types.str;
+          default = null;
+          example = "adwaita-dark";
+          relatedPackages = [ "adwaita-qt" [ "libsForQt5" "qtstyleplugins" ] ];
+          description = ''
+            Selects the style to use for Qt5 applications.</para>
+            <para>The options are
+            <variablelist>
+              <varlistentry>
+                <term><literal>adwaita</literal></term>
+                <term><literal>adwaita-dark</literal></term>
+                <listitem><para>Use Adwaita Qt style with
+                  <link xlink:href="https://github.com/FedoraQt/adwaita-qt">adwaita</link>
+                </para></listitem>
+              </varlistentry>
+              <varlistentry>
+                <term><literal>cleanlooks</literal></term>
+                <term><literal>gtk2</literal></term>
+                <term><literal>motif</literal></term>
+                <term><literal>plastique</literal></term>
+                <listitem><para>Use styles from
+                  <link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link>
+                </para></listitem>
+              </varlistentry>
+            </variablelist>
+          '';
+        };
+
+        package = mkOption {
+          type = types.nullOr types.package;
+          default = null;
+          example = literalExample "pkgs.adwaita-qt";
+          description = "Theme package to be used in Qt5 applications.";
+        };
+      };
     };
   };
 
   config = mkIf (cfg.enable && cfg.platformTheme != null) {
-    home.sessionVariables.QT_QPA_PLATFORMTHEME =
-      if cfg.platformTheme == "gnome" then "gnome" else "gtk2";
+    assertions = [{
+      assertion = (cfg.platformTheme == "gnome")
+        -> ((cfg.style.name != null) && (cfg.style.package != null));
+      message = ''
+        `qt.platformTheme` "gnome" must have `qt.style` set to a theme that
+        supports both Qt and Gtk, for example "adwaita" or "adwaita-dark".
+      '';
+    }];
+
+    # Necessary because home.sessionVariables is of types.attrs
+    home.sessionVariables = (filterAttrs (n: v: v != null) {
+      QT_QPA_PLATFORMTHEME =
+        if cfg.platformTheme == "gnome" then "gnome" else "gtk2";
+      QT_STYLE_OVERRIDE = cfg.style.name;
+    });
 
     home.packages = if cfg.platformTheme == "gnome" then
       [ pkgs.qgnomeplatform ]
+      ++ lib.optionals (cfg.style.package != null) [ cfg.style.package ]
     else
       [ pkgs.libsForQt5.qtstyleplugins ];
 
-    xsession.importedVariables = [ "QT_QPA_PLATFORMTHEME" ];
+    xsession.importedVariables = [ "QT_QPA_PLATFORMTHEME" ]
+      ++ lib.optionals (cfg.style != null) [ "QT_STYLE_OVERRIDE" ];
 
     # Enable GTK+ style for Qt4 in either case.
     # It doesn’t support the platform theme packages.

diff --git a/tests/default.nix b/tests/default.nix
@@ -84,6 +84,7 @@ import nmt {
     ./modules/misc/debug
     ./modules/misc/numlock
     ./modules/misc/pam
+    ./modules/misc/qt
     ./modules/misc/xdg
     ./modules/misc/xsession
     ./modules/programs/abook

diff --git a/tests/modules/misc/qt/default.nix b/tests/modules/misc/qt/default.nix
@@ -0,0 +1,4 @@
+{
+  qt-platform-theme-gtk = ./qt-platform-theme-gtk.nix;
+  qt-platform-theme-gnome = ./qt-platform-theme-gnome.nix;
+}
diff --git a/tests/modules/misc/qt/qt-platform-theme-gnome.nix b/tests/modules/misc/qt/qt-platform-theme-gnome.nix
@@ -0,0 +1,27 @@
+{ config, lib, pkgs, ... }:
+
+{
+  config = {
+    qt = {
+      enable = true;
+      platformTheme = "gnome";
+      style = {
+        name = "adwaita";
+        package = pkgs.dummyTheme;
+      };
+    };
+
+    nixpkgs.overlays = [
+      (self: super: {
+        dummyTheme = pkgs.runCommandLocal "theme" { } "mkdir $out";
+      })
+    ];
+
+    nmt.script = ''
+      assertFileRegex home-path/etc/profile.d/hm-session-vars.sh \
+        'QT_QPA_PLATFORMTHEME="gnome"'
+      assertFileRegex home-path/etc/profile.d/hm-session-vars.sh \
+        'QT_STYLE_OVERRIDE="adwaita"'
+    '';
+  };
+}
diff --git a/tests/modules/misc/qt/qt-platform-theme-gtk.nix b/tests/modules/misc/qt/qt-platform-theme-gtk.nix
@@ -0,0 +1,15 @@
+{ config, lib, pkgs, ... }:
+
+{
+  config = {
+    qt = {
+      enable = true;
+      platformTheme = "gtk";
+    };
+
+    nmt.script = ''
+      assertFileRegex home-path/etc/profile.d/hm-session-vars.sh \
+        'QT_QPA_PLATFORMTHEME="gtk2"'
+    '';
+  };
+}