nuclex-shared-dotnet/Nuclex.Avalonia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Initial porting attempt of my WinForms MVVM library to Avalonia; added IWindowScope as a new reature because this library should support Microsoft's dependency injector

Browse source
This commit is contained in:
Markus Ewald 2025-02-12 19:16:24 +01:00
commit 225da0d7e9
16 changed files with 1512 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

188
Source/Messages/AvaloniaMessagePresenter.cs Normal file
View file

@ -0,0 +1,188 @@
#region Apache License 2.0
/*
Nuclex Foundation libraries for .NET
Copyright (C) 2002-2025 Markus Ewald / Nuclex Development Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0
using System;
using System.Threading.Tasks;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Runtime.Versioning;
#if NET6_0_OR_GREATER
using System.Runtime.Versioning;
#endif
using Avalonia.Controls;
using MessageBoxIcon = MsBox.Avalonia.Enums.Icon;
using MessageBoxButtons = MsBox.Avalonia.Enums.ButtonEnum;
using MessageDialogResult = MsBox.Avalonia.Enums.ButtonResult;
namespace Nuclex.Avalonia.Messages {
/// <summary>Uses Avalonia to display message boxes</summary>
public class AvaloniaMessagePresenter : IMessageService {
#region class MessageScope
/// <summary>Triggers the message displayed and acknowledged events</summary>
private class MessageScope : IDisposable {
/// <summary>
/// Initializes a new message scope, triggering the message displayed event
/// </summary>
/// <param name="self">Message service the scope belongs to</param>
/// <param name="image">Image of the message being displayed</param>
/// <param name="text">Text contained in the message being displayed</param>
public MessageScope(
AvaloniaMessagePresenter self, MessageBoxIcon image, MessageText text
) {
EventHandler<MessageEventArgs>? messageDisplayed = self.MessageDisplaying;
if(messageDisplayed != null) {
messageDisplayed(this, new MessageEventArgs(image, text));
}
this.self = self;
}
/// <summary>Triggers the message acknowledged event</summary>
public void Dispose() {
EventHandler? messageAcknowledged = self.MessageAcknowledged;
if(messageAcknowledged != null) {
messageAcknowledged(this, EventArgs.Empty);
}
}
/// <summary>Message service the scope belongs to</summary>
private AvaloniaMessagePresenter self;
}
#endregion // class MessageScope
/// <summary>Triggered when a message is displayed to the user</summary>
public event EventHandler<MessageEventArgs>? MessageDisplaying;
/// <summary>Triggered when the user has acknowledged the current message</summary>
public event EventHandler? MessageAcknowledged;
/// <summary>Initializes a new Avalonia message service</summary>
/// <param name="tracker">Used to determine the current top-level window</param>
public AvaloniaMessagePresenter(IActiveWindowTracker tracker) {
this.tracker = tracker;
}
/// <summary>Asks the user a question that can be answered via several buttons</summary>
/// <param name="image">Image that will be shown on the message box</param>
/// <param name="text">Text that will be shown to the user</param>
/// <param name="buttons">Buttons available for the user to click on</param>
/// <returns>The button the user has clicked on</returns>
public Task<MessageDialogResult> ShowQuestionAsync(
MessageBoxIcon image, MessageText text, MessageBoxButtons buttons
) {
using(var scope = new MessageScope(this, image, text)) {
MsBox.Avalonia.Base.IMsBox<MessageDialogResult> messageBox = (
MsBox.Avalonia.MessageBoxManager.GetMessageBoxStandard(
new MsBox.Avalonia.Dto.MessageBoxStandardParams() {
ContentTitle = text.Caption,
ContentHeader = text.Message,
ContentMessage = text.Details ?? string.Empty,
ButtonDefinitions = buttons,
Icon = image,
WindowStartupLocation = WindowStartupLocation.CenterOwner
}
)
);
return messageBox.ShowAsync(); // TODO: Make modal to current or main window
}
}
/// <summary>Displays a notification to the user</summary>
/// <param name="image">Image that will be shown on the message bx</param>
/// <param name="text">Text that will be shown to the user</param>
public Task ShowNotificationAsync(MessageBoxIcon image, MessageText text) {
using(var scope = new MessageScope(this, image, text)) {
MsBox.Avalonia.Base.IMsBox<MessageDialogResult> messageBox = (
MsBox.Avalonia.MessageBoxManager.GetMessageBoxStandard(
new MsBox.Avalonia.Dto.MessageBoxStandardParams() {
ContentTitle = text.Caption,
ContentHeader = text.Message,
ContentMessage = text.Details ?? string.Empty,
ButtonDefinitions = MessageBoxButtons.Ok,
Icon = image,
WindowStartupLocation = WindowStartupLocation.CenterOwner
}
)
);
Window? activeWindow = this.tracker.ActiveWindow;
if(activeWindow == null) {
return messageBox.ShowAsync();
} else {
//return messageBox.ShowAsPopupAsync(activeWindow);
return messageBox.ShowWindowDialogAsync(activeWindow);
}
}
}
/// <summary>Reports an error using the system's message box functions</summary>
/// <param name="title">Title of the message box</param>
/// <param name="message">Message text that will be displayed</param>
public static void FallbackReportError(string title, string message) {
// TODO: Escape quotes for the command-line tools
// TODO: Wait for the child process to exit so display is certain
if(RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) {
MessageBoxW(IntPtr.Zero, message, title, MB_OK | MB_ICONEXCLAMATION);
} else if(RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) {
Process.Start("zenity", $"--error --title=\"{title}\" --text=\"{message}\"");
} else if(RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) {
Process.Start("osascript", $"-e 'display dialog \"{message}\" with title \"{title}\" with icon stop'");
}
}
/// <summary>Windows only: display a message box with an OK button</summary>
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
private const uint MB_OK = 0x00000000;
/// <summary>Windows only: display a message box with an Exclamation icon</summary>
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
private const uint MB_ICONEXCLAMATION = 0x00000030;
/// <summary>Windows only: displays a native Windows message box</summary>
/// <param name="parentWindowHandle">Handle of the window that owns the message box</param>
/// <param name="text">Text that should be in the message box</param>
/// <param name="caption">Caption or window title of the message box</param>
/// <param name="type">Which icons and buttons that message box should have</param>
/// <returns>How the user closed the message box and which button they clicked</returns>
[DllImport("user32.dll", CharSet = CharSet.Unicode)]
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
private static extern int MessageBoxW(IntPtr parentWindowHandle, string text, string caption, uint type);
// <summary>Provides the currently active top-level window</summary>
private IActiveWindowTracker tracker;
}
} // namespace Nuclex.Avalonia.Messages

58
Source/Messages/IMessageService.cs Normal file
View file

@ -0,0 +1,58 @@
#region Apache License 2.0
/*
Nuclex Foundation libraries for .NET
Copyright (C) 2002-2025 Markus Ewald / Nuclex Development Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0
using System;
using System.Threading.Tasks;
using MessageBoxIcon = MsBox.Avalonia.Enums.Icon;
using MessageBoxButtons = MsBox.Avalonia.Enums.ButtonEnum;
using MessageDialogResult = MsBox.Avalonia.Enums.ButtonResult;
namespace Nuclex.Avalonia.Messages {
/// <summary>Performs simple user interaction</summary>
/// <remarks>
/// Methods provided by this service can be covered using plain old message boxes
/// and do not require special dialogs or calls to the task dialog API.
/// </remarks>
public interface IMessageService {
/// <summary>Triggered when a message is about to be displayed to the user</summary>
event EventHandler<MessageEventArgs> MessageDisplaying;
/// <summary>Triggered when the user has acknowledged the current message</summary>
event EventHandler MessageAcknowledged;
/// <summary>Asks the user a question that can be answered via several buttons</summary>
/// <param name="image">Image that will be shown on the message box</param>
/// <param name="text">Text that will be shown to the user</param>
/// <param name="buttons">Buttons available for the user to click on</param>
/// <returns>The button the user has clicked on</returns>
Task<MessageDialogResult> ShowQuestionAsync(
MessageBoxIcon image, MessageText text, MessageBoxButtons buttons
);
/// <summary>Displays a notification to the user</summary>
/// <param name="image">Image that will be shown on the message bx</param>
/// <param name="text">Text that will be shown to the user</param>
Task ShowNotificationAsync(MessageBoxIcon image, MessageText text);
}
} // namespace Nuclex.Avalonia.Messages

54
Source/Messages/MessageEventArgs.cs Normal file
View file

@ -0,0 +1,54 @@
#region Apache License 2.0
/*
Nuclex Foundation libraries for .NET
Copyright (C) 2002-2025 Markus Ewald / Nuclex Development Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0
using System;
using MessageBoxIcon = MsBox.Avalonia.Enums.Icon;
namespace Nuclex.Avalonia.Messages {
/// <summary>Provides a displayed message and its severity to event subscribers</summary>
public class MessageEventArgs : EventArgs {
/// <summary>Initializes a new message box event argument container</summary>
/// <param name="image">Image the message box will be displaying</param>
/// <param name="text">Text that will be displayed in the message box</param>
public MessageEventArgs(MessageBoxIcon image, MessageText text) {
this.image = image;
this.text = text;
}
/// <summary>Image that indicates the severity of the message being displayed</summary>
public MessageBoxIcon Image {
get { return this.image; }
}
/// <summary>Text that is being displayed in the message box</summary>
public MessageText Text {
get { return this.text; }
}
/// <summary>Image that indicates the severity of the message being displayed</summary>
private MessageBoxIcon image;
/// <summary>Text that is being displayed in the message box</summary>
private MessageText text;
}
} // namespace Nuclex.Avalonia.Messages

117
Source/Messages/MessageServiceHelper.cs Normal file
View file

@ -0,0 +1,117 @@
#region Apache License 2.0
/*
Nuclex Foundation libraries for .NET
Copyright (C) 2002-2025 Markus Ewald / Nuclex Development Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0
using System;
using System.Threading.Tasks;
#if NET6_0_OR_GREATER
using System.Runtime.Versioning;
#endif
using MessageBoxIcon = MsBox.Avalonia.Enums.Icon;
using MessageBoxButtons = MsBox.Avalonia.Enums.ButtonEnum;
using MessageDialogResult = MsBox.Avalonia.Enums.ButtonResult;
namespace Nuclex.Avalonia.Messages {
/// <summary>Contains helper methods for the message service</summary>
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
public static class MessageServiceHelper {
/// <summary>Asks the user a question that can be answered with yes or no</summary>
/// <param name="messageService">
/// Message service that will be used to display the question
/// </param>
/// <param name="text">Text that will be shown on the message box</param>
/// <returns>The button the user has clicked on</returns>
public static Task<MessageDialogResult> AskYesNoAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowQuestionAsync(
MessageBoxIcon.Question, text, MessageBoxButtons.YesNo
);
}
/// <summary>Asks the user a question that can be answered with ok or cancel</summary>
/// <param name="messageService">
/// Message service that will be used to display the question
/// </param>
/// <param name="text">Text that will be shown on the message box</param>
/// <returns>The button the user has clicked on</returns>
public static Task<MessageDialogResult> AskOkCancelAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowQuestionAsync(
MessageBoxIcon.Question, text, MessageBoxButtons.OkCancel
);
}
/// <summary>
/// Asks the user a question that can be answered with yes, no or cancel
/// </summary>
/// <param name="messageService">
/// Message service that will be used to display the question
/// </param>
/// <param name="text">Text that will be shown on the message box</param>
/// <returns>The button the user has clicked on</returns>
public static Task<MessageDialogResult> AskYesNoCancelAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowQuestionAsync(
MessageBoxIcon.Question, text, MessageBoxButtons.YesNoCancel
);
}
/// <summary>Displays an informative message</summary>
/// <param name="messageService">
/// Message service that will be used to display the warning
/// </param>
/// <param name="text">Text to be displayed on the warning message</param>
public static Task InformAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowNotificationAsync(MessageBoxIcon.Info, text);
}
/// <summary>Displays a warning</summary>
/// <param name="messageService">
/// Message service that will be used to display the warning
/// </param>
/// <param name="text">Text to be displayed on the warning message</param>
public static Task WarnAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowNotificationAsync(MessageBoxIcon.Warning, text);
}
/// <summary>Reports an error</summary>
/// <param name="messageService">
/// Message service that will be used to display the warning
/// </param>
/// <param name="text">Text to be displayed on the warning message</param>
public static Task ReportErrorAsync(
this IMessageService messageService, MessageText text
) {
return messageService.ShowNotificationAsync(MessageBoxIcon.Error, text);
}
}
} // namespace Nuclex.Avalonia.Messages

57
Source/Messages/MessageText.cs Normal file
View file

@ -0,0 +1,57 @@
#region Apache License 2.0
/*
Nuclex Foundation libraries for .NET
Copyright (C) 2002-2025 Markus Ewald / Nuclex Development Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0
using System;
namespace Nuclex.Avalonia.Messages {
/// <summary>Text that will be displayed in a message box</summary>
public class MessageText {
/// <summary>Initializs a new message text</summary>
public MessageText() {
Caption = "Message";
Message = "No message provided";
}
/// <summary>Initializes a new message text by copying another instance</summary>
/// <param name="other">Instance that will be copied</param>
public MessageText(MessageText other) {
Caption = other.Caption;
Message = other.Message;
Details = other.Details;
ExpandedDetails = other.ExpandedDetails;
}
/// <summary>The caption used when the is displayed in a message box</summary>
public string Caption { get; set; }
/// <summary>Main message being displayed to the user</summary>
public string Message { get; set; }
/// <summary>Message details shown below the main message</summary>
public string? Details { get; set; }
/// <summary>
/// Additional informations the user can display by expanding
/// the message dialog. Can be null, in which case the message dialog
/// will not be expandable.
/// </summary>
public string? ExpandedDetails { get; set; }
}
} // namespace Nuclex.Avalonia.Messages