settings_re4

LanMountainDesktop.PluginSdk/ISettingsPageHostContext.cs

@@ -0,0 +1,12 @@
+using Avalonia.Controls;
+
+namespace LanMountainDesktop.PluginSdk;
+
+public interface ISettingsPageHostContext
+{
+    void OpenDrawer(Control content, string? title = null);
+
+    void CloseDrawer();
+
+    void RequestRestart(string? reason = null);
+}

LanMountainDesktop.PluginSdk/PluginManifest.cs

@@ -85,7 +85,10 @@ public sealed record PluginManifest(
         if (requestedVersion.Major != currentVersion.Major)
         {
             throw new InvalidOperationException(
-                $"Plugin '{normalized.Id}' targets API version '{normalized.ApiVersion}', but the host provides '{PluginSdkInfo.ApiVersion}'. Upgrade the plugin to API {PluginSdkInfo.ApiVersion}.");
+                $"Plugin '{normalized.Id}' targets API version '{normalized.ApiVersion}' (major {requestedVersion.Major}), " +
+                $"but the host provides '{PluginSdkInfo.ApiVersion}' (major {currentVersion.Major}). " +
+                $"This host only supports v{currentVersion.Major}.x plugins. " +
+                $"Migrate the plugin to API {PluginSdkInfo.ApiVersion} and rebuild the package.");
         }
 
         return normalized;

LanMountainDesktop.PluginSdk/PluginSdkInfo.cs

@@ -2,7 +2,7 @@ namespace LanMountainDesktop.PluginSdk;
 
 public static class PluginSdkInfo
 {
-    public const string ApiVersion = "2.0.0";
+    public const string ApiVersion = "3.0.0";
     public const string ManifestFileName = "plugin.json";
     public const string PackageFileExtension = ".laapp";
     public const string DataDirectoryName = "Data";

LanMountainDesktop.PluginSdk/SettingsPageBase.cs

@@ -0,0 +1,54 @@
+using System;
+using Avalonia.Controls;
+
+namespace LanMountainDesktop.PluginSdk;
+
+public abstract class SettingsPageBase : UserControl
+{
+    public static readonly string DialogHostIdentifier = "LanMountainDesktop.SettingsWindow";
+
+    private ISettingsPageHostContext? _hostContext;
+
+    public ISettingsPageHostContext? HostContext => _hostContext;
+
+    public Uri? NavigationUri { get; set; }
+
+    public void InitializeHostContext(ISettingsPageHostContext hostContext)
+    {
+        _hostContext = hostContext;
+    }
+
+    public virtual void OnNavigatedTo(object? parameter)
+    {
+    }
+
+    protected void OpenDrawer(Control content, string? title = null)
+    {
+        _hostContext?.OpenDrawer(content, title);
+    }
+
+    protected void OpenDrawer(object content, bool usePageDataContext = false, object? dataContext = null, string? title = null)
+    {
+        if (content is Control control && !usePageDataContext)
+        {
+            control.DataContext = dataContext ?? DataContext ?? this;
+            OpenDrawer(control, title);
+            return;
+        }
+
+        if (content is Control drawerControl)
+        {
+            OpenDrawer(drawerControl, title);
+        }
+    }
+
+    protected void CloseDrawer()
+    {
+        _hostContext?.CloseDrawer();
+    }
+
+    protected void RequestRestart(string? reason = null)
+    {
+        _hostContext?.RequestRestart(reason);
+    }
+}

LanMountainDesktop.PluginSdk/SettingsPageCategory.cs

@@ -0,0 +1,10 @@
+namespace LanMountainDesktop.PluginSdk;
+
+public enum SettingsPageCategory
+{
+    General = 0,
+    Appearance = 10,
+    Components = 20,
+    Plugins = 30,
+    About = 40
+}

LanMountainDesktop.PluginSdk/SettingsPageInfoAttribute.cs

@@ -0,0 +1,46 @@
+using System;
+
+namespace LanMountainDesktop.PluginSdk;
+
+[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
+public sealed class SettingsPageInfoAttribute : Attribute
+{
+    public SettingsPageInfoAttribute(
+        string id,
+        string name,
+        SettingsPageCategory category)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(id);
+        ArgumentException.ThrowIfNullOrWhiteSpace(name);
+
+        Id = id.Trim();
+        Name = name.Trim();
+        Category = category;
+    }
+
+    public string Id { get; }
+
+    public string Name { get; }
+
+    public SettingsPageCategory Category { get; }
+
+    public string? TitleLocalizationKey { get; init; }
+
+    public string? DescriptionLocalizationKey { get; init; }
+
+    public string IconKey { get; init; } = "Settings";
+
+    public string? SelectedIconKey { get; init; }
+
+    public int SortOrder { get; init; }
+
+    public bool HideDefault { get; init; }
+
+    public bool HidePageTitle { get; init; }
+
+    public bool UseFullWidth { get; init; }
+
+    public string? GroupId { get; init; }
+
+    public SettingsScope Scope { get; init; } = SettingsScope.App;
+}