A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
Updated settings GUI
Etienne Baudouxab0200bd44b1
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.propsindex f30da2493..2a1d03a2e 100644--- a/src/Directory.Packages.props+++ b/src/Directory.Packages.props@@ -29,7 +29,6 @@<PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" /><PackageVersion Include="System.ComponentModel.Composition" Version="$(DotNetVersion)" /><PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.5.4" />- <PackageVersion Include="ThisAssembly.Git" Version="1.3.1"/><PackageVersion Include="Uno.Core.Extensions.Logging" Version="4.0.1" /><PackageVersion Include="Uno.Core.Extensions.Logging.Singleton" Version="4.0.1" /><PackageVersion Include="xunit" Version="$(XUnit)" />diff --git a/src/app/dev/DevToys.Api/Tool/GUI/Components/IUISetting.cs b/src/app/dev/DevToys.Api/Tool/GUI/Components/IUISetting.csindex 1e5dd0f47..3c367e5fb 100644--- a/src/app/dev/DevToys.Api/Tool/GUI/Components/IUISetting.cs+++ b/src/app/dev/DevToys.Api/Tool/GUI/Components/IUISetting.cs@@ -10,6 +10,11 @@ public interface IUISetting : IUITitledElement/// </summary>string? Description { get; }+ /// <summary>+ /// Gets the description of the state of the setting.+ /// </summary>+ string? StateDescription { get; }+/// <summary>/// Gets the icon of the setting./// </summary>@@ -25,6 +30,11 @@ public interface IUISetting : IUITitledElement/// </summary>event EventHandler? DescriptionChanged;+ /// <summary>+ /// Raised when <see cref="StateDescription"/> is changed.+ /// </summary>+ event EventHandler? StateDescriptionChanged;+/// <summary>/// Raised when <see cref="Icon"/> is changed./// </summary>@@ -40,6 +50,7 @@ public interface IUISetting : IUITitledElementinternal class UISetting : UITitledElement, IUISetting{private string? _description;+ private string? _stateDescription;private IUIIcon? _icon;private IUIElement? _interactiveElement;@@ -54,6 +65,12 @@ internal class UISetting : UITitledElement, IUISettinginternal set => SetPropertyValue(ref _description, value, DescriptionChanged);}+ public string? StateDescription+ {+ get => _stateDescription;+ internal set => SetPropertyValue(ref _stateDescription, value, StateDescriptionChanged);+ }+public IUIIcon? Icon{get => _icon;@@ -67,6 +84,7 @@ internal class UISetting : UITitledElement, IUISetting}public event EventHandler? DescriptionChanged;+ public event EventHandler? StateDescriptionChanged;public event EventHandler? IconChanged;public event EventHandler? InteractiveElementChanged;}@@ -99,6 +117,15 @@ public static partial class GUIreturn element;}+ /// <summary>+ /// Sets the <see cref="IUISetting.StateDescription"/> of the setting.+ /// </summary>+ public static IUISetting StateDescription(this IUISetting element, string? text)+ {+ ((UISetting)element).StateDescription = text;+ return element;+ }+/// <summary>/// Sets the <see cref="IUISetting.Icon"/> of the setting./// </summary>@@ -124,32 +151,47 @@ public static partial class GUI/// <param name="settingsProvider">The settings provider used for handling the given <paramref name="settingDefinition"/>.</param>/// <param name="settingDefinition">The definition of the setting to associate to this <see cref="IUISetting"/>.</param>/// <param name="onToggled">(optional) A method to invoke when the setting value changed.</param>- public static IUISetting Handle(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<bool> settingDefinition, Func<bool, ValueTask>? onToggled = null)+ public static IUISetting Handle(+ this IUISetting element,+ ISettingsProvider settingsProvider,+ SettingDefinition<bool> settingDefinition,+ Func<bool, ValueTask>? onToggled = null){- var settingElement = (UISetting)element;-- IUISwitch toggleSwitch = Switch();- if (settingsProvider.GetSetting(settingDefinition))- {- toggleSwitch.On();- }- else- {- toggleSwitch.Off();- }-- toggleSwitch.OnToggle((bool state) =>- {- settingsProvider.SetSetting(settingDefinition, state);- if (onToggled is not null)- {- return onToggled.Invoke(state);- }- return ValueTask.CompletedTask;- });+ return Handle(+ element,+ settingsProvider,+ settingDefinition,+ stateDescriptionWhenOn: null,+ stateDescriptionWhenOff: null,+ ignoreStateDescription: true,+ onToggled);+ }- settingElement.InteractiveElement(toggleSwitch);- return element;+ /// <summary>+ /// Sets a <see cref="IUISwitch"/> to <see cref="IUISetting.InteractiveElement"/> and automatically associate the+ /// given <paramref name="settingDefinition"/> to the switch state.+ /// </summary>+ /// <param name="settingsProvider">The settings provider used for handling the given <paramref name="settingDefinition"/>.</param>+ /// <param name="settingDefinition">The definition of the setting to associate to this <see cref="IUISetting"/>.</param>+ /// <param name="stateDescriptionWhenOn">The <see cref="IUISetting.StateDescription"/> to use when the option is On.</param>+ /// <param name="stateDescriptionWhenOff">The <see cref="IUISetting.StateDescription"/> to use when the option is Off.</param>+ /// <param name="onToggled">(optional) A method to invoke when the setting value changed.</param>+ public static IUISetting Handle(+ this IUISetting element,+ ISettingsProvider settingsProvider,+ SettingDefinition<bool> settingDefinition,+ string? stateDescriptionWhenOn,+ string? stateDescriptionWhenOff,+ Func<bool, ValueTask>? onToggled = null)+ {+ return Handle(+ element,+ settingsProvider,+ settingDefinition,+ stateDescriptionWhenOn,+ stateDescriptionWhenOff,+ ignoreStateDescription: false,+ onToggled);}/// <summary>@@ -160,7 +202,12 @@ public static partial class GUI/// <param name="settingDefinition">The definition of the setting to associate to this <see cref="IUISetting"/>.</param>/// <param name="onOptionSelected">(optional) A method to invoke when the setting value changed.</param>/// <param name="dropDownListItems">(optional) A list of items to be displayed in the drop down list. <see cref="IUIDropDownListItem.Value"/> should be of type <typeparamref name="T"/>.</param>- public static IUISetting Handle<T>(this IUISetting element, ISettingsProvider settingsProvider, SettingDefinition<T> settingDefinition, Func<T, ValueTask>? onOptionSelected, params IUIDropDownListItem[] dropDownListItems)+ public static IUISetting Handle<T>(+ this IUISetting element,+ ISettingsProvider settingsProvider,+ SettingDefinition<T> settingDefinition,+ Func<T, ValueTask>? onOptionSelected,+ params IUIDropDownListItem[] dropDownListItems){bool typeIsEnum = typeof(T).IsEnum;@@ -207,4 +254,60 @@ public static partial class GUIsettingElement.InteractiveElement(dropDownList);return element;}++ private static IUISetting Handle(+ this IUISetting element,+ ISettingsProvider settingsProvider,+ SettingDefinition<bool> settingDefinition,+ string? stateDescriptionWhenOn,+ string? stateDescriptionWhenOff,+ bool ignoreStateDescription,+ Func<bool, ValueTask>? onToggled)+ {+ var settingElement = (UISetting)element;++ IUISwitch toggleSwitch = Switch();+ if (settingsProvider.GetSetting(settingDefinition))+ {+ toggleSwitch.On();+ if (!ignoreStateDescription)+ {+ settingElement.StateDescription = stateDescriptionWhenOn;+ }+ }+ else+ {+ toggleSwitch.Off();+ if (!ignoreStateDescription)+ {+ settingElement.StateDescription = stateDescriptionWhenOff;+ }+ }++ toggleSwitch.OnToggle((bool state) =>+ {+ settingsProvider.SetSetting(settingDefinition, state);++ if (!ignoreStateDescription)+ {+ if (state)+ {+ settingElement.StateDescription = stateDescriptionWhenOn;+ }+ else+ {+ settingElement.StateDescription = stateDescriptionWhenOff;+ }+ }++ if (onToggled is not null)+ {+ return onToggled.Invoke(state);+ }+ return ValueTask.CompletedTask;+ });++ settingElement.InteractiveElement(toggleSwitch);+ return element;+ }}diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.Designer.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.Designer.csindex 2a6ceecfd..4575798ae 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.Designer.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.Designer.cs@@ -195,6 +195,15 @@ namespace DevToys.Blazor.BuiltInTools.Settings {}}+ /// <summary>+ /// Looks up a localized string similar to Higlight the current line.+ /// </summary>+ internal static string HighlightCurrentLineStateDescriptionWhenOn {+ get {+ return ResourceManager.GetString("HighlightCurrentLineStateDescriptionWhenOn", resourceCulture);+ }+ }+/// <summary>/// Looks up a localized string similar to Language./// </summary>@@ -240,6 +249,15 @@ namespace DevToys.Blazor.BuiltInTools.Settings {}}+ /// <summary>+ /// Looks up a localized string similar to Show line numbers.+ /// </summary>+ internal static string LineNumbersStateDescriptionWhenOn {+ get {+ return ResourceManager.GetString("LineNumbersStateDescriptionWhenOn", resourceCulture);+ }+ }+/// <summary>/// Looks up a localized string similar to Render white space./// </summary>@@ -249,6 +267,15 @@ namespace DevToys.Blazor.BuiltInTools.Settings {}}+ /// <summary>+ /// Looks up a localized string similar to Show whitespace.+ /// </summary>+ internal static string RenderWhitespaceStateDescriptionWhenOn {+ get {+ return ResourceManager.GetString("RenderWhitespaceStateDescriptionWhenOn", resourceCulture);+ }+ }+/// <summary>/// Looks up a localized string similar to Settings./// </summary>@@ -329,5 +356,14 @@ namespace DevToys.Blazor.BuiltInTools.Settings {return ResourceManager.GetString("WordWrap", resourceCulture);}}++ /// <summary>+ /// Looks up a localized string similar to Word wrap.+ /// </summary>+ internal static string WordWrapStateDescriptionWhenOn {+ get {+ return ResourceManager.GetString("WordWrapStateDescriptionWhenOn", resourceCulture);+ }+ }}}diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.resx b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.resxindex 9fc841fdf..899cb03b5 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.resx+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/Settings.resx@@ -162,6 +162,9 @@<data name="HighlightCurrentLineDescription" xml:space="preserve"><value>Change the background color of the current line so it's more visible</value></data>+ <data name="HighlightCurrentLineStateDescriptionWhenOn" xml:space="preserve">+ <value>Higlight the current line</value>+ </data><data name="Language" xml:space="preserve"><value>Language</value></data>@@ -177,9 +180,15 @@<data name="LineNumbersDescription" xml:space="preserve"><value>Display line numbers in the text editor</value></data>+ <data name="LineNumbersStateDescriptionWhenOn" xml:space="preserve">+ <value>Show line numbers</value>+ </data><data name="RenderWhitespace" xml:space="preserve"><value>Render white space</value></data>+ <data name="RenderWhitespaceStateDescriptionWhenOn" xml:space="preserve">+ <value>Show whitespace</value>+ </data><data name="ShortDisplayTitle" xml:space="preserve"><value>Settings</value></data>@@ -207,4 +216,7 @@<data name="WordWrap" xml:space="preserve"><value>Wrap word</value></data>+ <data name="WordWrapStateDescriptionWhenOn" xml:space="preserve">+ <value>Word wrap</value>+ </data></root>\ No newline at end of filediff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/SettingsGuiTool.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/SettingsGuiTool.csindex c6b36a2bc..d0891d7b4 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/SettingsGuiTool.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/Settings/SettingsGuiTool.cs@@ -1,10 +1,7 @@using System.Reflection;using DevToys.Api;using DevToys.Blazor.Core.Languages;-using DevToys.Core;using DevToys.Core.Settings;-using Microsoft.VisualBasic;-using static System.Net.Mime.MediaTypeNames;namespace DevToys.Blazor.BuiltInTools.Settings;@@ -31,6 +28,7 @@ internal sealed class SettingsGuiTool : IGuiToolprivate readonly IUIDropDownListItem _currentLanguage;private readonly IUIDropDownListItem[] _availableFonts;private readonly IUISetting _smartDetectionAutomaticallyPasteSetting = Setting("smart-detection-automatically-paste-setting");+ private readonly IUISetting _textEditorFontSetting = Setting("text-editor-font-setting");private readonly string _previewJsonText;[ImportingConstructor]@@ -128,50 +126,59 @@ internal sealed class SettingsGuiTool : IGuiTool.WithChildren(Label().Text(Settings.TextEditor),- Setting("text-editor-font-settings")- .Icon("FluentSystemIcons", '\uF7E3')- .Title(Settings.Font)- .Handle(- _settingsProvider,- PredefinedSettings.TextEditorFont,- onOptionSelected: null,- dropDownListItems: _availableFonts),-- Setting("text-editor-word-wrap-settings")- .Icon("FluentSystemIcons", '\uEF28')- .Title(Settings.WordWrap)- .Handle(- _settingsProvider,- PredefinedSettings.TextEditorTextWrapping),-- Setting("text-editor-line-number-settings")- .Icon("FluentSystemIcons", '\uED3A')- .Title(Settings.LineNumbers)- .Description(Settings.LineNumbersDescription)- .Handle(- _settingsProvider,- PredefinedSettings.TextEditorLineNumbers),-- Setting("text-editor-line-highlight-settings")- .Icon("FluentSystemIcons", '\uE3C5')- .Title(Settings.HighlightCurrentLine)- .Description(Settings.HighlightCurrentLineDescription)- .Handle(- _settingsProvider,- PredefinedSettings.TextEditorHighlightCurrentLine),-- Setting("text-editor-white-spaces-settings")- .Icon("FluentSystemIcons", '\uEB31')- .Title(Settings.RenderWhitespace)- .Handle(- _settingsProvider,- PredefinedSettings.TextEditorRenderWhitespace),-- MultilineTextInput("text-editor-render-preview")- .Title(Settings.TextEditorPreview)- .AlignVertically(UIVerticalAlignment.Top)- .Language("json")- .Text(_previewJsonText)),+ SettingGroup()+ .Icon("FluentSystemIcons", '\uE3BB')+ .Title(Settings.TextEditor)+ .WithChildren(++ _textEditorFontSetting+ .Title(Settings.Font)+ .StateDescription(_settingsProvider.GetSetting(PredefinedSettings.TextEditorFont))+ .Handle(+ _settingsProvider,+ PredefinedSettings.TextEditorFont,+ OnTextEditorFontChangedAsync,+ dropDownListItems: _availableFonts),++ Setting("text-editor-word-wrap-settings")+ .Title(Settings.WordWrap)+ .Handle(+ _settingsProvider,+ PredefinedSettings.TextEditorTextWrapping,+ stateDescriptionWhenOn: Settings.WordWrapStateDescriptionWhenOn,+ stateDescriptionWhenOff: null),++ Setting("text-editor-line-number-settings")+ .Title(Settings.LineNumbers)+ .Description(Settings.LineNumbersDescription)+ .Handle(+ _settingsProvider,+ PredefinedSettings.TextEditorLineNumbers,+ stateDescriptionWhenOn: Settings.LineNumbersStateDescriptionWhenOn,+ stateDescriptionWhenOff: null),++ Setting("text-editor-line-highlight-settings")+ .Title(Settings.HighlightCurrentLine)+ .Description(Settings.HighlightCurrentLineDescription)+ .Handle(+ _settingsProvider,+ PredefinedSettings.TextEditorHighlightCurrentLine,+ stateDescriptionWhenOn: Settings.HighlightCurrentLineStateDescriptionWhenOn,+ stateDescriptionWhenOff: null),++ Setting("text-editor-white-spaces-settings")+ .Title(Settings.RenderWhitespace)+ .Handle(+ _settingsProvider,+ PredefinedSettings.TextEditorRenderWhitespace,+ stateDescriptionWhenOn: Settings.RenderWhitespaceStateDescriptionWhenOn,+ stateDescriptionWhenOff: null),++ MultilineTextInput("text-editor-render-preview")+ .Title(Settings.TextEditorPreview)+ .AlignVertically(UIVerticalAlignment.Top)+ .Language("json")+ .Text(_previewJsonText))),// AboutStack()@@ -227,6 +234,12 @@ internal sealed class SettingsGuiTool : IGuiToolreturn ValueTask.CompletedTask;}+ private ValueTask OnTextEditorFontChangedAsync(string fontName)+ {+ _textEditorFontSetting.StateDescription(fontName);+ return ValueTask.CompletedTask;+ }+private IUIDropDownListItem[] LoadAvailableFonts(){string[] systemFontFamilies = _fontProvider.GetFontFamilies();@@ -280,16 +293,7 @@ internal sealed class SettingsGuiTool : IGuiToolprivate static string GetAppVersionDescription(){-#if DEBUG- string? buildConfiguration = "DEBUG";-#else- string buildConfiguration = "RELEASE";-#endif-- string? gitBranch = ThisAssembly.Git.Branch;- string? gitCommit = ThisAssembly.Git.Commit;string? version = Assembly.GetExecutingAssembly().GetName().Version?.ToString();-- return string.Format(Settings.Version, $"{version} | {buildConfiguration} | {gitBranch} | {gitCommit}");+ return string.Format(Settings.Version, version);}}diff --git a/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor b/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razorindex a947ed72e..f412f2f23 100644--- a/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor+++ b/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor@@ -9,7 +9,7 @@HorizontalAlignment="@UISettingGroup.HorizontalAlignment"VerticalAlignment="@UISettingGroup.VerticalAlignment"Title="@UISettingGroup.Title"- Description="@UISettingGroup.Description"+ Description="@Description"IconGlyph="@(UISettingGroup.Icon?.Glyph ?? '\0')"IconFontFamily="@UISettingGroup.Icon?.FontName"><Control>@@ -21,14 +21,29 @@<ChildContent><StackPanel Orientation="UIOrientation.Vertical"HorizontalAlignment="UIHorizontalAlignment.Stretch"- Spacing="@(UISettingGroup.ChildrenAreAllSettings ? 0 : 4)">+ Spacing="0">@if (UISettingGroup.Children is not null){for (int i = 0; i < UISettingGroup.Children.Length; i++){- if (UISettingGroup.Children[i] is not null)+ IUIElement element = UISettingGroup.Children[i];+ if (element is not null){- <UIElementPresenter UIElement="@UISettingGroup.Children[i]" />+ if (element is IUISetting)+ {+ <UIElementPresenter UIElement="element" />+ }+ else+ {+ <Container HorizontalAlignment="@element.HorizontalAlignment"+ VerticalAlignment="@element.VerticalAlignment"+ MarginLeft="55"+ MarginRight="45"+ MarginBottom="2"+ MarginTop="2">+ <UIElementPresenter UIElement="element" />+ </Container>+ }}}}diff --git a/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor.cs b/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor.csindex 939c53ab9..24988565c 100644--- a/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor.cs+++ b/src/app/dev/DevToys.Blazor/Components/UIElements/UISettingGroupPresenter.razor.cs@@ -1,7 +1,97 @@namespace DevToys.Blazor.Components.UIElements;-public partial class UISettingGroupPresenter : ComponentBase+public partial class UISettingGroupPresenter : ComponentBase, IDisposable{+ private readonly List<IUISetting> _settings = new();+[Parameter]public IUISettingGroup UISettingGroup { get; set; } = default!;++ [Parameter]+ public string? Description { get; set; }++ protected override void OnInitialized()+ {+ base.OnInitialized();++ UpdateDescription();+ UpdateSettingStateDescriptionSubscription();+ UISettingGroup.ChildrenChanged += UISettingGroup_ChildrenChanged;+ UISettingGroup.DescriptionChanged += UISettingGroup_DescriptionChanged;+ }++ public void Dispose()+ {+ UISettingGroup.ChildrenChanged -= UISettingGroup_ChildrenChanged;+ UISettingGroup.DescriptionChanged -= UISettingGroup_DescriptionChanged;++ for (int i = 0; i < _settings.Count; i++)+ {+ _settings[i].StateDescriptionChanged -= Setting_StateDescriptionChanged;+ }+ }++ private void UpdateDescription()+ {+ if (!string.IsNullOrEmpty(UISettingGroup.Description))+ {+ Description = UISettingGroup.Description;+ }+ else if (UISettingGroup.Children is not null)+ {+ var stateDescriptions = new List<string>();+ for (int i = 0; i < UISettingGroup.Children.Length; i++)+ {+ IUIElement element = UISettingGroup.Children[i];+ if (element is IUISetting setting && !string.IsNullOrWhiteSpace(setting.StateDescription))+ {+ stateDescriptions.Add(setting.StateDescription);+ }+ }++ string stateDescription = string.Join(", ", stateDescriptions);+ Description = stateDescription;+ }++ StateHasChanged();+ }++ private void UpdateSettingStateDescriptionSubscription()+ {+ for (int i = 0; i < _settings.Count; i++)+ {+ _settings[i].StateDescriptionChanged -= Setting_StateDescriptionChanged;+ }++ _settings.Clear();++ if (UISettingGroup.Children is not null)+ {+ for (int i = 0; i < UISettingGroup.Children.Length; i++)+ {+ IUIElement element = UISettingGroup.Children[i];+ if (element is IUISetting setting)+ {+ _settings.Add(setting);+ setting.StateDescriptionChanged -= Setting_StateDescriptionChanged;+ setting.StateDescriptionChanged += Setting_StateDescriptionChanged;+ }+ }+ }+ }++ private void UISettingGroup_ChildrenChanged(object? sender, EventArgs e)+ {+ UpdateSettingStateDescriptionSubscription();+ }++ private void UISettingGroup_DescriptionChanged(object? sender, EventArgs e)+ {+ UpdateDescription();+ }++ private void Setting_StateDescriptionChanged(object? sender, EventArgs e)+ {+ UpdateDescription();+ }}diff --git a/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj b/src/app/dev/DevToys.Blazor/DevToys.Blazor.csprojindex 8ae91c1ee..bb5a5a460 100644--- a/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj+++ b/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj@@ -17,7 +17,6 @@<PrivateAssets>all</PrivateAssets><IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets></PackageReference>- <PackageReference Include="ThisAssembly.Git" /></ItemGroup><ItemGroup>