#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 {
/// Uses Avalonia to display message boxes
public class AvaloniaMessagePresenter : IMessageService {
#region class MessageScope
/// Triggers the message displayed and acknowledged events
private class MessageScope : IDisposable {
///
/// Initializes a new message scope, triggering the message displayed event
///
/// Message service the scope belongs to
/// Image of the message being displayed
/// Text contained in the message being displayed
public MessageScope(
AvaloniaMessagePresenter self, MessageBoxIcon image, MessageText text
) {
EventHandler? messageDisplayed = self.MessageDisplaying;
if(messageDisplayed != null) {
messageDisplayed(this, new MessageEventArgs(image, text));
}
this.self = self;
}
/// Triggers the message acknowledged event
public void Dispose() {
EventHandler? messageAcknowledged = self.MessageAcknowledged;
if(messageAcknowledged != null) {
messageAcknowledged(this, EventArgs.Empty);
}
}
/// Message service the scope belongs to
private AvaloniaMessagePresenter self;
}
#endregion // class MessageScope
/// Triggered when a message is displayed to the user
public event EventHandler? MessageDisplaying;
/// Triggered when the user has acknowledged the current message
public event EventHandler? MessageAcknowledged;
/// Initializes a new Avalonia message service
/// Used to determine the current top-level window
public AvaloniaMessagePresenter(IActiveWindowTracker tracker) {
this.tracker = tracker;
}
/// Asks the user a question that can be answered via several buttons
/// Image that will be shown on the message box
/// Text that will be shown to the user
/// Buttons available for the user to click on
/// The button the user has clicked on
public Task ShowQuestionAsync(
MessageBoxIcon image, MessageText text, MessageBoxButtons buttons
) {
using(var scope = new MessageScope(this, image, text)) {
MsBox.Avalonia.Base.IMsBox 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
}
}
/// Displays a notification to the user
/// Image that will be shown on the message bx
/// Text that will be shown to the user
public Task ShowNotificationAsync(MessageBoxIcon image, MessageText text) {
using(var scope = new MessageScope(this, image, text)) {
MsBox.Avalonia.Base.IMsBox 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);
}
}
}
/// Reports an error using the system's message box functions
/// Title of the message box
/// Message text that will be displayed
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'");
}
}
/// Windows only: display a message box with an OK button
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
private const uint MB_OK = 0x00000000;
/// Windows only: display a message box with an Exclamation icon
#if NET6_0_OR_GREATER
[SupportedOSPlatform("windows")]
#endif
private const uint MB_ICONEXCLAMATION = 0x00000030;
/// Windows only: displays a native Windows message box
/// Handle of the window that owns the message box
/// Text that should be in the message box
/// Caption or window title of the message box
/// Which icons and buttons that message box should have
/// How the user closed the message box and which button they clicked
[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);
// Provides the currently active top-level window
private IActiveWindowTracker tracker;
}
} // namespace Nuclex.Avalonia.Messages