Add wallpaperFillMode configuration option (#338)

Co-authored-by: Heitor Augusto <[email protected]>
nix-community · Aug 22, 2024 · 0b7f9b5 · 0b7f9b5
1 parent df4d1d3
commit 0b7f9b5
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/lib/wallpapers.nix b/lib/wallpapers.nix
@@ -27,4 +27,16 @@
       };
     };
   };
+
+  # Values are taken from
+  #  https://invent.kde.org/plasma/kdeplasma-addons/-/blob/bc53d651cf60709396c9229f8c582ec8a9d2ee53/applets/mediaframe/package/contents/ui/ConfigGeneral.qml#L148-170
+  wallpaperFillModeTypes = {
+    "stretch" = 0; # a.k.a. Scaled
+    "preserveAspectFit" = 1; # a.k.a. Scaled Keep Proportions
+    "preserveAspectCrop" = 2; # a.k.a. Scaled And Cropped
+    "tile" = 3;
+    "tileVertically" = 4;
+    "tileHorizontally" = 5;
+    "pad" = 6; # a.k.a. Centered
+  };
 }
diff --git a/modules/panels.nix b/modules/panels.nix
@@ -5,6 +5,8 @@
 } @ args:
 let
   cfg = config.programs.plasma;
+  inherit (import ../lib/wallpapers.nix { inherit lib; }) wallpaperFillModeTypes;
+
   hasWidget = widgetName: builtins.any (panel: builtins.any (widget: widget.name == widgetName) panel.widgets) cfg.panels;
 
   # An attrset keeping track of the packages which should be added when a
@@ -211,6 +213,7 @@ in
                   "\"" + (builtins.toString path) + "\"" else
                   "[" + (builtins.concatStringsSep "," (map (s: "\"" + s + "\"") path)) + "]"});
                 desktop.writeConfig("SlideInterval", "${builtins.toString cfg.workspace.wallpaperSlideShow.interval}");
+                ${lib.optionalString (cfg.workspace.wallpaperFillMode != null) ''desktop.writeConfig("FillMode", "${cfg.workspace.wallpaperFillMode}");''}
             }
           '' else "");
           wallpaperPOTD = (if (cfg.workspace.wallpaperPictureOfTheDay != null) then ''
@@ -221,6 +224,7 @@ in
                 desktop.currentConfigGroup = ["Wallpaper", "org.kde.potd", "General"];
                 desktop.writeConfig("Provider", "${cfg.workspace.wallpaperPictureOfTheDay.provider}");
                 desktop.writeConfig("UpdateOverMeteredConnection", "${if (cfg.workspace.wallpaperPictureOfTheDay.updateOverMeteredConnection) then "1" else "0"}");
+                ${lib.optionalString (cfg.workspace.wallpaperFillMode != null) ''desktop.writeConfig("FillMode", "${cfg.workspace.wallpaperFillMode}");''}
               }
           '' else "");
           wallpaperPlainColor = (if (cfg.workspace.wallpaperPlainColor != null) then ''

diff --git a/modules/workspace.nix b/modules/workspace.nix
@@ -3,7 +3,7 @@
 
 let
   cfg = config.programs.plasma;
-  inherit (import ../lib/wallpapers.nix { inherit lib; }) wallpaperPictureOfTheDayType wallpaperSlideShowType;
+  inherit (import ../lib/wallpapers.nix { inherit lib; }) wallpaperPictureOfTheDayType wallpaperSlideShowType wallpaperFillModeTypes;
   inherit (import ./widgets/lib.nix { inherit lib; }) stringIfNotNull;
 
   cursorType = with lib.types; submodule {
@@ -164,6 +164,17 @@ in
       '';
     };
 
+    wallpaperFillMode = lib.mkOption {
+      type = with lib.types; nullOr (enum (builtins.attrNames wallpaperFillModeTypes));
+      default = null;
+      example = "stretch";
+      description = ''
+        Defines how the wallpaper should be displayed on the screen.
+        Applies only to wallpaperPictureOfTheDay or wallpaperSlideShow.
+      '';
+      apply = value: if value == null then null else (builtins.toString wallpaperFillModeTypes.${value});
+    };
+
     soundTheme = lib.mkOption {
       type = with lib.types; nullOr str;
       default = null;