Option to hide header items with no children in the overlay

Author: jltaylor-us

ReleaseNotes.md

@@ -1,6 +1,15 @@
 
 # Release Notes
 
+## Version 2.3.0
+
+* Configuration changes now refresh the overlay list when the
+  configuration is saved rather than being delayed until the next
+  list refresh.
+* Added a overlay configuration option to hide items marked as
+  "header" if they have no children (i.e., if the next visible
+  item is also a header).
+
 ## Version 2.2.1
 
 * Added Polish translation from github user marcix99942

ToDew/ModEntry.cs

@@ -48,7 +48,7 @@ public ModEntry() {
                     // this really shouldn't happen
                     api = new ToDoApiImpl(this, ModManifest);
                 }
-                ToDoListOverlayDataSource source = new(() => api.RefreshOverlay());
+                ToDoListOverlayDataSource source = new(this, () => api.RefreshOverlay());
                 api.AddOverlayDataSource(source);
                 return source;
             });

ToDew/ToDoListOverlayDataSource.cs

@@ -1,10 +1,13 @@
 // Copyright 2023 Jamie Taylor
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace ToDew {
     public class ToDoListOverlayDataSource : IToDewOverlayDataSource {
+        private readonly ModEntry theMod;
         private ToDoList? _theList;
+        private OverlayConfig config { get => theMod.config.overlay; }
         public ToDoList? theList {
             get => _theList;
             set {
@@ -18,7 +21,8 @@ public ToDoList? theList {
             }
         }
         private readonly Action refreshOverlay;
-        public ToDoListOverlayDataSource(Action refreshOverlay) {
+        public ToDoListOverlayDataSource(ModEntry theMod, Action refreshOverlay) {
+            this.theMod = theMod;
             this.refreshOverlay = refreshOverlay;
         }
 
@@ -29,11 +33,23 @@ public string GetSectionTitle() {
         public List<(string text, bool isBold, Action? onDone)> GetItems(int limit) {
             List<(string text, bool isBold, Action? onDone)> result = new();
             if (theList is null) return result;
+            bool lastIsHeader = false;
             foreach (var item in theList.Items) {
                 if (item.IsDone || item.HideInOverlay || !item.IsVisibleToday) continue;
-                string itemText = item.IsHeader ? item.Text : ("  " + item.Text);
-                result.Add((itemText, item.IsBold, item.IsHeader ? null : () => theList.SetItemDone(item, true)));
-                if (result.Count == limit) break;
+                if (item.IsHeader) {
+                    if (lastIsHeader && config.hideHeaderWithNoChildren) {
+                        result.RemoveAt(result.Count - 1);
+                    }
+                    lastIsHeader = true;
+                    result.Add(("  " + item.Text, item.IsBold, null));
+                } else {
+                    lastIsHeader = false;
+                    result.Add((item.Text, item.IsBold, () => theList.SetItemDone(item, true)));
+                    if (result.Count >= limit) break;
+                }
+            }
+            if (config.hideHeaderWithNoChildren && lastIsHeader) {
+                result.RemoveAt(result.Count - 1);
             }
             return result;
         }

ToDew/ToDoOverlay.cs

@@ -16,6 +16,7 @@ namespace ToDew {
     public class OverlayConfig {
         public bool enabled = true;
         public bool clickToMarkDone = true;
+        public bool hideHeaderWithNoChildren = false;
         public SButton hotkey = SButton.None;
         public KeybindList hotkeyList = new KeybindList();
         public bool hideAtFestivals = false;
@@ -40,6 +41,12 @@ public static void RegisterConfigMenuOptions(Func<OverlayConfig> getThis, Generi
                 tooltip: I18n.Config_Overlay_ClickToMarkDone_Desc,
                 getValue: () => getThis().clickToMarkDone,
                 setValue: (bool val) => getThis().clickToMarkDone = val);
+            api.AddBoolOption(
+                mod: modManifest,
+                name: I18n.Config_Overlay_HideHeaderWithNoChildren,
+                tooltip: I18n.Config_Overlay_HideHeaderWithNoChildren_Desc,
+                getValue: () => getThis().hideHeaderWithNoChildren,
+                setValue: (bool val) => getThis().hideHeaderWithNoChildren = val);
             api.AddKeybind(
                 mod: modManifest,
                 name: I18n.Config_Overlay_Hotkey,

ToDew/i18n/default.json

@@ -18,6 +18,8 @@
     "config.overlay.enabled.desc": "Is the overlay enabled?",
     "config.overlay.click-to-mark-done": "Click items to mark done",
     "config.overlay.click-to-mark-done.desc": "Enable clicking in the overlay to mark items done",
+    "config.overlay.hide-header-with-no-children": "Hide headers with no children",
+    "config.overlay.hide-header-with-no-children.desc": "Do not show a header item if the next visible item is also a header",
     "config.overlay.hotkey": "Hotkey",
     "config.overlay.hotkey.desc": "Hotkey to show or hide",
     "config.overlay.hide-at-festivals": "Hide at festivals",