mirror/Libation
1
0
Fork 0
mirror of https://github.com/rmcrackan/Libation.git synced 2026-07-29 16:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Shared walkthrough helpers and constants

Browse Source
This commit is contained in:
Robert McRackan
2026-07-25 12:35:22 -04:00
parent e1bede5a6a
commit b4f7cf4288
3 changed files with 75 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
Source/LibationAvalonia/Walkthrough.cs
View File

@@ -1,5 +1,4 @@
using ApplicationServices;
using AudibleUtilities;
using Avalonia.Controls;
using Avalonia.Controls.Presenters;
using Avalonia.Controls.Primitives;
@@ -51,7 +50,7 @@ internal class Walkthrough
if (!await ProceedMessageBox(proceed.Message, proceed.Title))
return false;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.settingsToolStripMenuItem);
await displayControlAsync(MainForm.accountsToolStripMenuItem);
@@ -68,7 +67,7 @@ internal class Walkthrough
if (!await ProceedMessageBox(proceed.Message, proceed.Title))
return false;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.settingsToolStripMenuItem);
await displayControlAsync(MainForm.basicSettingsToolStripMenuItem);
@@ -133,9 +132,7 @@ internal class Walkthrough
private async Task<bool> ShowAccountScanning()
{
var persister = AudibleApiStorage.GetAccountsSettingsPersister();
var count = persister.AccountsSettings.Accounts.Count;
persister.Dispose();
var count = WalkthroughHelpers.GetConfiguredAccountCount();
if (count < 1)
{
@@ -150,7 +147,7 @@ internal class Walkthrough
var scanItem = count > 1 ? MainForm.scanLibraryOfAllAccountsToolStripMenuItem : MainForm.scanLibraryToolStripMenuItem;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.importToolStripMenuItem);
await displayControlAsync(scanItem);
@@ -180,10 +177,12 @@ internal class Walkthrough
private async Task<bool> ShowSearching()
{
var books = DbContexts.GetLibrary_Flat_NoTracking();
if (books.Count == 0) return true;
if (books.Count == 0)
return true;
var firstAuthor = getFirstAuthor()?.SurroundWithQuotes();
if (firstAuthor == null) return true;
var firstAuthor = WalkthroughHelpers.GetFirstAuthorName()?.SurroundWithQuotes();
if (firstAuthor is null)
return true;
var proceed = WalkthroughMessages.SearchingProceed;
if (!await ProceedMessageBox(proceed.Message, proceed.Title))
@@ -195,14 +194,14 @@ internal class Walkthrough
foreach (var c in firstAuthor)
{
MainForm.filterSearchTb.Text += c;
await Task.Delay(150);
await Task.Delay(WalkthroughHelpers.Timing.TypeCharDelayMs);
}
await displayControlAsync(MainForm.filterBtn);
MainForm.filterBtn.Command?.Execute(firstAuthor);
await Task.Delay(1000);
await Task.Delay(WalkthroughHelpers.Timing.AfterFilterMs);
var cheatSheet = WalkthroughMessages.SearchCheatSheet;
await MessageBox.Show(MainForm, cheatSheet.Message, cheatSheet.Title);
@@ -218,8 +217,9 @@ internal class Walkthrough
private async Task<bool> ShowQuickFilters()
{
var firstAuthor = getFirstAuthor()?.SurroundWithQuotes();
if (firstAuthor == null) return true;
var firstAuthor = WalkthroughHelpers.GetFirstAuthorName()?.SurroundWithQuotes();
if (firstAuthor is null)
return true;
var proceed = WalkthroughMessages.QuickFiltersProceed;
if (!await ProceedMessageBox(proceed.Message, proceed.Title))
@@ -229,7 +229,7 @@ internal class Walkthrough
var editQuickFiltersToolStripMenuItem = MainForm.quickFiltersToolStripMenuItem.ItemsSource?.OfType<MenuItem>().ElementAt(1);
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.addQuickFilterBtn);
MainForm.addQuickFilterBtn.Command?.Execute(firstAuthor);
await displayControlAsync(MainForm.quickFiltersToolStripMenuItem);
@@ -250,12 +250,6 @@ internal class Walkthrough
return true;
}
private string? getFirstAuthor()
{
var books = DbContexts.GetLibrary_Flat_NoTracking();
return books.SelectMany(lb => lb.Book.Authors).FirstOrDefault(a => !string.IsNullOrWhiteSpace(a.Name))?.Name;
}
private async Task displayControlAsync(TemplatedControl? control)
{
if (control is null)
@@ -264,23 +258,23 @@ internal class Walkthrough
MainForm.productsDisplay.Focus();
await flashControlAsync(control);
if (control is MenuItem menuItem) menuItem.Open();
await Task.Delay(500);
await Task.Delay(WalkthroughHelpers.Timing.AfterHighlightMs);
control.IsEnabled = true;
}
private static async Task flashControlAsync(TemplatedControl control, int flashCount = 3)
private static async Task flashControlAsync(TemplatedControl control, int flashCount = WalkthroughHelpers.Timing.FlashCount)
{
for (int i = 0; i < flashCount; i++)
{
control.Styles.Add(disabledStyle);
control.Styles.Add(disabledStyle2);
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
control.Styles.Remove(disabledStyle);
control.Styles.Remove(disabledStyle2);
control.Styles.Add(enabedStyle);
control.Styles.Add(enabedStyle2);
control.InvalidateVisual();
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
control.Styles.Remove(enabedStyle);
control.Styles.Remove(enabedStyle2);
}

31
Source/LibationUiBase/WalkthroughHelpers.cs Normal file
View File

@@ -0,0 +1,31 @@
using ApplicationServices;
using AudibleUtilities;
using System.Linq;
namespace LibationUiBase;
/// <summary>Shared non-UI helpers and timing for the Classic and Chardonnay guided tours.</summary>
public static class WalkthroughHelpers
{
public static class Timing
{
public const int BeforeHighlightMs = 750;
public const int AfterHighlightMs = 500;
public const int FlashIntervalMs = 200;
public const int TypeCharDelayMs = 150;
public const int AfterFilterMs = 1000;
public const int FlashCount = 3;
}
public static string? GetFirstAuthorName()
{
var books = DbContexts.GetLibrary_Flat_NoTracking();
return books.SelectMany(lb => lb.Book.Authors).FirstOrDefault(a => !string.IsNullOrWhiteSpace(a.Name))?.Name;
}
public static int GetConfiguredAccountCount()
{
using var persister = AudibleApiStorage.GetAccountsSettingsPersister();
return persister.AccountsSettings.Accounts.Count;
}
}

55
Source/LibationWinForms/Walkthrough.cs
View File

@@ -1,5 +1,4 @@
using ApplicationServices;
using AudibleUtilities;
using Dinah.Core;
using Dinah.Core.StepRunner;
using LibationFileManager;
@@ -46,7 +45,7 @@ internal class Walkthrough
if (!ProceedMessageBox(proceed.Message, proceed.Title))
return false;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.settingsToolStripMenuItem);
await displayControlAsync(MainForm.accountsToolStripMenuItem);
@@ -64,7 +63,7 @@ internal class Walkthrough
if (!ProceedMessageBox(proceed.Message, proceed.Title))
return false;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.settingsToolStripMenuItem);
await displayControlAsync(MainForm.basicSettingsToolStripMenuItem);
@@ -86,7 +85,8 @@ internal class Walkthrough
void TabControl_TabIndexChanged(object? sender, EventArgs e)
{
var selectedTab = settingsDialog.tabControl.SelectedTab;
if (selectedTab == null) return;
if (selectedTab is null)
return;
tabsToVisit.Remove(selectedTab);
@@ -116,9 +116,7 @@ internal class Walkthrough
private async Task<bool> ShowAccountScanning()
{
var persister = AudibleApiStorage.GetAccountsSettingsPersister();
var count = persister.AccountsSettings.Accounts.Count;
persister.Dispose();
var count = WalkthroughHelpers.GetConfiguredAccountCount();
if (count < 1)
{
@@ -133,7 +131,7 @@ internal class Walkthrough
var scanItem = count > 1 ? MainForm.scanLibraryOfAllAccountsToolStripMenuItem : MainForm.scanLibraryToolStripMenuItem;
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.importToolStripMenuItem);
await displayControlAsync(scanItem);
@@ -152,10 +150,12 @@ internal class Walkthrough
private async Task<bool> ShowSearching()
{
var books = DbContexts.GetLibrary_Flat_NoTracking();
if (books.Count == 0) return true;
if (books.Count == 0)
return true;
var firstAuthor = getFirstAuthor()?.SurroundWithQuotes();
if (firstAuthor == null) return true;
var firstAuthor = WalkthroughHelpers.GetFirstAuthorName()?.SurroundWithQuotes();
if (firstAuthor is null)
return true;
var proceed = WalkthroughMessages.SearchingProceed;
if (!ProceedMessageBox(proceed.Message, proceed.Title))
@@ -167,14 +167,14 @@ internal class Walkthrough
foreach (var c in firstAuthor)
{
MainForm.Invoke(() => MainForm.filterSearchTb.Text += c);
await Task.Delay(150);
await Task.Delay(WalkthroughHelpers.Timing.TypeCharDelayMs);
}
await displayControlAsync(MainForm.filterBtn);
MainForm.Invoke(MainForm.filterBtn.PerformClick);
await Task.Delay(1000);
await Task.Delay(WalkthroughHelpers.Timing.AfterFilterMs);
var cheatSheet = WalkthroughMessages.SearchCheatSheet;
MessageBox.Show(MainForm, cheatSheet.Message, cheatSheet.Title);
@@ -190,8 +190,9 @@ internal class Walkthrough
private async Task<bool> ShowQuickFilters()
{
var firstAuthor = getFirstAuthor()?.SurroundWithQuotes();
if (firstAuthor == null) return true;
var firstAuthor = WalkthroughHelpers.GetFirstAuthorName()?.SurroundWithQuotes();
if (firstAuthor is null)
return true;
var proceed = WalkthroughMessages.QuickFiltersProceed;
if (!ProceedMessageBox(proceed.Message, proceed.Title))
@@ -199,7 +200,7 @@ internal class Walkthrough
MainForm.Invoke(() => MainForm.filterSearchTb.Text = firstAuthor);
await Task.Delay(750);
await Task.Delay(WalkthroughHelpers.Timing.BeforeHighlightMs);
await displayControlAsync(MainForm.addQuickFilterBtn);
MainForm.Invoke(MainForm.addQuickFilterBtn.PerformClick);
await displayControlAsync(MainForm.quickFiltersToolStripMenuItem);
@@ -220,19 +221,13 @@ internal class Walkthrough
return Task.FromResult(true);
}
private string? getFirstAuthor()
{
var books = DbContexts.GetLibrary_Flat_NoTracking();
return books.SelectMany(lb => lb.Book.Authors).FirstOrDefault(a => !string.IsNullOrWhiteSpace(a.Name))?.Name;
}
private async Task displayControlAsync(ToolStripMenuItem menuItem)
{
MainForm.Invoke(() => menuItem.Enabled = false);
MainForm.Invoke(MainForm.productsDisplay.Focus);
await flashControlAsync(menuItem);
MainForm.Invoke(menuItem.ShowDropDown);
await Task.Delay(500);
await Task.Delay(WalkthroughHelpers.Timing.AfterHighlightMs);
MainForm.Invoke(() => menuItem.Enabled = true);
}
@@ -241,31 +236,31 @@ internal class Walkthrough
MainForm.Invoke(() => button.Enabled = false);
MainForm.Invoke(MainForm.productsDisplay.Focus);
await flashControlAsync(button);
await Task.Delay(500);
await Task.Delay(WalkthroughHelpers.Timing.AfterHighlightMs);
MainForm.Invoke(() => button.Enabled = true);
}
private async Task flashControlAsync(Control control, int flashCount = 3)
private async Task flashControlAsync(Control control, int flashCount = WalkthroughHelpers.Timing.FlashCount)
{
var backColor = MainForm.Invoke(() => control.BackColor);
for (int i = 0; i < flashCount; i++)
{
MainForm.Invoke(() => control.BackColor = FlashColor);
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
MainForm.Invoke(() => control.BackColor = backColor);
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
}
}
private async Task flashControlAsync(ToolStripItem control, int flashCount = 3)
private async Task flashControlAsync(ToolStripItem control, int flashCount = WalkthroughHelpers.Timing.FlashCount)
{
var backColor = MainForm.Invoke(() => control.BackColor);
for (int i = 0; i < flashCount; i++)
{
MainForm.Invoke(() => control.BackColor = FlashColor);
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
MainForm.Invoke(() => control.BackColor = backColor);
await Task.Delay(200);
await Task.Delay(WalkthroughHelpers.Timing.FlashIntervalMs);
}
}