mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
0f72cf8a74
* Pulled from v2_release * Refactor migration guide for Terminal.Gui v2 Restructured and expanded the migration guide to provide a comprehensive resource for transitioning from Terminal.Gui v1 to v2. Key updates include: - Added a Table of Contents for easier navigation. - Summarized major architectural changes in v2, including the instance-based application model, IRunnable architecture, and 24-bit TrueColor support. - Updated examples to reflect new patterns, such as initializers replacing constructors and explicit disposal using `IDisposable`. - Documented changes to the layout system, including the removal of `Absolute`/`Computed` styles and the introduction of `Viewport`. - Standardized event patterns to use `object sender, EventArgs args`. - Detailed updates to the Keyboard, Mouse, and Navigation APIs, including configurable key bindings and viewport-relative mouse coordinates. - Replaced legacy components like `ScrollView` and `ContextMenu` with built-in scrolling and `PopoverMenu`. - Clarified disposal rules and introduced best practices for resource management. - Provided a complete migration example and a summary of breaking changes. This update aims to simplify the migration process by addressing breaking changes, introducing new features, and aligning with modern .NET conventions. * Refactor to use Application.Instance for lifecycle management Replaced all occurrences of `ApplicationImpl.Instance` with the new `Application.Instance` property across the codebase to align with the updated application lifecycle model. Encapsulated the `ApplicationImpl` class by making it `internal`, ensuring it is no longer directly accessible outside its assembly. Introduced the `[Obsolete]` `Application.Instance` property as a backward-compatible singleton for the legacy static `Application` model, while encouraging the use of `Application.Create()` for new code. Updated `MessageBox` methods to use `Application.Instance` for consistent modal dialog management. Improved documentation to reflect these changes and emphasize the transition to the instance-based application model. Performed code cleanup in multiple classes to ensure consistency and maintainability. These changes maintain backward compatibility while preparing the codebase for the eventual removal of the legacy `ApplicationImpl` class. * Fix doc bug * - Removed obsolete `.cd` class diagram files. - Introduced `IRunnable` interface for decoupling component execution. - Added fluent API for running dialogs and retrieving results. - Enhanced `View` with `App` and `Driver` properties for better decoupling. - Improved testability with support for mock and real applications. - Implemented `IDisposable` for proper resource cleanup. - Replaced `RunnableSessionStack` with `SessionStack` for session management. - Updated driver architecture to align with the new model. - Scoped `IKeyboard` to application contexts for modularity. - Updated documentation with migration strategies and best practices. These changes modernize the library, improve maintainability, and align with current development practices.
667 lines
28 KiB
C#
667 lines
28 KiB
C#
namespace Terminal.Gui.Views;
|
|
|
|
/// <summary>
|
|
/// Displays a modal message box with a title, message, and buttons. Returns the index of the selected button,
|
|
/// or <see langword="null"/> if the user cancels with <see cref="Application.QuitKey"/>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// MessageBox provides static methods for displaying modal dialogs with customizable buttons and messages.
|
|
/// All methods return <see langword="int?"/> where the value is the 0-based index of the button pressed,
|
|
/// or <see langword="null"/> if the user pressed <see cref="Application.QuitKey"/> (typically Esc).
|
|
/// </para>
|
|
/// <para>
|
|
/// <see cref="Query(IApplication?, string, string, string[])"/> uses the default Dialog color scheme.
|
|
/// <see cref="ErrorQuery(IApplication?, string, string, string[])"/> uses the Error color scheme.
|
|
/// </para>
|
|
/// <para>
|
|
/// <b>Important:</b> All MessageBox methods require an <see cref="IApplication"/> instance to be passed.
|
|
/// This enables proper modal dialog management and respects the application's lifecycle. Pass your
|
|
/// application instance (from <see cref="Application.Create()"/>) or use the legacy
|
|
/// <see cref="Application.Instance"/> if using the static Application pattern.
|
|
/// </para>
|
|
/// <para>
|
|
/// Example using instance-based pattern:
|
|
/// <code>
|
|
/// IApplication app = Application.Create();
|
|
/// app.Init();
|
|
///
|
|
/// int? result = MessageBox.Query(app, "Quit Demo", "Are you sure you want to quit?", "Yes", "No");
|
|
/// if (result == 0) // User clicked "Yes"
|
|
/// app.RequestStop();
|
|
/// else if (result == null) // User pressed Esc
|
|
/// // Handle cancellation
|
|
///
|
|
/// app.Shutdown();
|
|
/// </code>
|
|
/// </para>
|
|
/// <para>
|
|
/// Example using legacy static pattern:
|
|
/// <code>
|
|
/// Application.Init();
|
|
///
|
|
/// int? result = MessageBox.Query(ApplicationImpl.Instance, "Quit Demo", "Are you sure?", "Yes", "No");
|
|
/// if (result == 0) // User clicked "Yes"
|
|
/// Application.RequestStop();
|
|
///
|
|
/// Application.Shutdown();
|
|
/// </code>
|
|
/// </para>
|
|
/// <para>
|
|
/// The <see cref="Clicked"/> property provides a global variable alternative for web-based consoles
|
|
/// without SynchronizationContext. However, using the return value is preferred as it's more thread-safe
|
|
/// and follows modern async patterns.
|
|
/// </para>
|
|
/// </remarks>
|
|
public static class MessageBox
|
|
{
|
|
private static LineStyle _defaultBorderStyle = LineStyle.Heavy; // Resources/config.json overrides
|
|
private static Alignment _defaultButtonAlignment = Alignment.Center; // Resources/config.json overrides
|
|
private static int _defaultMinimumWidth = 0; // Resources/config.json overrides
|
|
private static int _defaultMinimumHeight = 0; // Resources/config.json overrides
|
|
|
|
/// <summary>
|
|
/// Defines the default border styling for <see cref="MessageBox"/>. Can be configured via
|
|
/// <see cref="ConfigurationManager"/>.
|
|
/// </summary>
|
|
[ConfigurationProperty (Scope = typeof (ThemeScope))]
|
|
public static LineStyle DefaultBorderStyle
|
|
{
|
|
get => _defaultBorderStyle;
|
|
set => _defaultBorderStyle = value;
|
|
}
|
|
|
|
/// <summary>The default <see cref="Alignment"/> for <see cref="Dialog"/>.</summary>
|
|
/// <remarks>This property can be set in a Theme.</remarks>
|
|
[ConfigurationProperty (Scope = typeof (ThemeScope))]
|
|
public static Alignment DefaultButtonAlignment
|
|
{
|
|
get => _defaultButtonAlignment;
|
|
set => _defaultButtonAlignment = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Defines the default minimum MessageBox width, as a percentage of the screen width. Can be configured via
|
|
/// <see cref="ConfigurationManager"/>.
|
|
/// </summary>
|
|
[ConfigurationProperty (Scope = typeof (ThemeScope))]
|
|
public static int DefaultMinimumWidth
|
|
{
|
|
get => _defaultMinimumWidth;
|
|
set => _defaultMinimumWidth = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Defines the default minimum Dialog height, as a percentage of the screen width. Can be configured via
|
|
/// <see cref="ConfigurationManager"/>.
|
|
/// </summary>
|
|
[ConfigurationProperty (Scope = typeof (ThemeScope))]
|
|
public static int DefaultMinimumHeight
|
|
{
|
|
get => _defaultMinimumHeight;
|
|
set => _defaultMinimumHeight = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed <see cref="Application.QuitKey"/>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This global variable is useful for web-based consoles without a SynchronizationContext or TaskScheduler.
|
|
/// Warning: Not thread-safe.
|
|
/// </remarks>
|
|
public static int? Clicked { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Displays an error <see cref="MessageBox"/> with fixed dimensions.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, string[])"/> which automatically sizes the
|
|
/// MessageBox.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (
|
|
IApplication? app,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
0,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized error <see cref="MessageBox"/>.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (IApplication? app, string title, string message, params string [] buttons)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
0,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an error <see cref="MessageBox"/> with fixed dimensions and a default button.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, int, string[])"/> which automatically sizes the
|
|
/// MessageBox.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (
|
|
IApplication? app,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized error <see cref="MessageBox"/> with a default button.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an error <see cref="MessageBox"/> with fixed dimensions, a default button, and word-wrap control.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="wrapMessage">
|
|
/// If <see langword="true"/>, word-wraps the message; otherwise displays as-is with multi-line
|
|
/// support.
|
|
/// </param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, int, bool, string[])"/> which automatically
|
|
/// sizes the MessageBox.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (
|
|
IApplication? app,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
bool wrapMessage = true,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
wrapMessage,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized error <see cref="MessageBox"/> with a default button and word-wrap control.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="wrapMessage">
|
|
/// If <see langword="true"/>, word-wraps the message; otherwise displays as-is with multi-line
|
|
/// support.
|
|
/// </param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? ErrorQuery (
|
|
IApplication? app,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
bool wrapMessage = true,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
true,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
wrapMessage,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays a <see cref="MessageBox"/> with fixed dimensions.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="Query(IApplication?, string, string, string[])"/> which automatically sizes the
|
|
/// MessageBox.
|
|
/// </remarks>
|
|
public static int? Query (IApplication? app, int width, int height, string title, string message, params string [] buttons)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
0,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized <see cref="MessageBox"/>.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? Query (IApplication? app, string title, string message, params string [] buttons)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
0,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays a <see cref="MessageBox"/> with fixed dimensions and a default button.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="Query(IApplication?, string, string, int, string[])"/> which automatically sizes the
|
|
/// MessageBox.
|
|
/// </remarks>
|
|
public static int? Query (
|
|
IApplication? app,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized <see cref="MessageBox"/> with a default button.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines and will be word-wrapped.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? Query (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
true,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays a <see cref="MessageBox"/> with fixed dimensions, a default button, and word-wrap control.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="width">Width for the MessageBox.</param>
|
|
/// <param name="height">Height for the MessageBox.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="wrapMessage">
|
|
/// If <see langword="true"/>, word-wraps the message; otherwise displays as-is with multi-line
|
|
/// support.
|
|
/// </param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// Consider using <see cref="Query(IApplication?, string, string, int, bool, string[])"/> which automatically sizes
|
|
/// the MessageBox.
|
|
/// </remarks>
|
|
public static int? Query (
|
|
IApplication? app,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
bool wrapMessage = true,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
width,
|
|
height,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
wrapMessage,
|
|
buttons);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Displays an auto-sized <see cref="MessageBox"/> with a default button and word-wrap control.
|
|
/// </summary>
|
|
/// <param name="app">The application instance. If <see langword="null"/>, uses <see cref="IApplication.TopRunnableView"/>.</param>
|
|
/// <param name="title">Title for the MessageBox.</param>
|
|
/// <param name="message">Message to display. May contain multiple lines.</param>
|
|
/// <param name="defaultButton">Index of the default button (0-based).</param>
|
|
/// <param name="wrapMessage">
|
|
/// If <see langword="true"/>, word-wraps the message; otherwise displays as-is with multi-line
|
|
/// support.
|
|
/// </param>
|
|
/// <param name="buttons">Array of button labels.</param>
|
|
/// <returns>
|
|
/// The index of the selected button, or <see langword="null"/> if the user pressed
|
|
/// <see cref="Application.QuitKey"/>.
|
|
/// </returns>
|
|
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
|
|
/// <remarks>
|
|
/// The MessageBox is centered and auto-sized based on title, message, and buttons.
|
|
/// </remarks>
|
|
public static int? Query (
|
|
IApplication? app,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
bool wrapMessage = true,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
return QueryFull (
|
|
app,
|
|
false,
|
|
0,
|
|
0,
|
|
title,
|
|
message,
|
|
defaultButton,
|
|
wrapMessage,
|
|
buttons);
|
|
}
|
|
|
|
private static int? QueryFull (
|
|
IApplication? app,
|
|
bool useErrorColors,
|
|
int width,
|
|
int height,
|
|
string title,
|
|
string message,
|
|
int defaultButton = 0,
|
|
bool wrapMessage = true,
|
|
params string [] buttons
|
|
)
|
|
{
|
|
ArgumentNullException.ThrowIfNull (app);
|
|
|
|
// Create button array for Dialog
|
|
var count = 0;
|
|
List<Button> buttonList = new ();
|
|
Clicked = null;
|
|
|
|
if (buttons is { })
|
|
{
|
|
if (defaultButton > buttons.Length - 1)
|
|
{
|
|
defaultButton = buttons.Length - 1;
|
|
}
|
|
|
|
foreach (string s in buttons)
|
|
{
|
|
var b = new Button
|
|
{
|
|
Text = s,
|
|
Data = count
|
|
};
|
|
|
|
if (count == defaultButton)
|
|
{
|
|
b.IsDefault = true;
|
|
|
|
b.Accepting += (s, e) =>
|
|
{
|
|
if (e?.Context?.Source is Button button)
|
|
{
|
|
Clicked = (int)button.Data!;
|
|
}
|
|
else
|
|
{
|
|
Clicked = defaultButton;
|
|
}
|
|
|
|
if (e is { })
|
|
{
|
|
e.Handled = true;
|
|
}
|
|
|
|
(s as View)?.App?.RequestStop ();
|
|
};
|
|
}
|
|
|
|
buttonList.Add (b);
|
|
count++;
|
|
}
|
|
}
|
|
|
|
var d = new Dialog
|
|
{
|
|
Title = title,
|
|
ButtonAlignment = DefaultButtonAlignment,
|
|
ButtonAlignmentModes = AlignmentModes.StartToEnd | AlignmentModes.AddSpaceBetweenItems,
|
|
BorderStyle = DefaultBorderStyle,
|
|
Buttons = buttonList.ToArray ()
|
|
};
|
|
|
|
d.Width = Dim.Auto (
|
|
DimAutoStyle.Auto,
|
|
Dim.Func (_ => (int)((app.Screen.Width - d.GetAdornmentsThickness ().Horizontal) * (DefaultMinimumWidth / 100f))),
|
|
Dim.Func (_ => (int)((app.Screen.Width - d.GetAdornmentsThickness ().Horizontal) * 0.9f)));
|
|
|
|
d.Height = Dim.Auto (
|
|
DimAutoStyle.Auto,
|
|
Dim.Func (_ => (int)((app.Screen.Height - d.GetAdornmentsThickness ().Vertical) * (DefaultMinimumHeight / 100f))),
|
|
Dim.Func (_ => (int)((app.Screen.Height - d.GetAdornmentsThickness ().Vertical) * 0.9f)));
|
|
|
|
if (width != 0)
|
|
{
|
|
d.Width = width;
|
|
}
|
|
|
|
if (height != 0)
|
|
{
|
|
d.Height = height;
|
|
}
|
|
|
|
d.SchemeName = useErrorColors ? SchemeManager.SchemesToSchemeName (Schemes.Error) : SchemeManager.SchemesToSchemeName (Schemes.Dialog);
|
|
|
|
d.HotKeySpecifier = new ('\xFFFF');
|
|
d.Text = message;
|
|
d.TextAlignment = Alignment.Center;
|
|
d.VerticalTextAlignment = Alignment.Start;
|
|
d.TextFormatter.WordWrap = wrapMessage;
|
|
d.TextFormatter.MultiLine = !wrapMessage;
|
|
|
|
// Run the modal; do not shut down the mainloop driver when done
|
|
app.Run (d);
|
|
d.Dispose ();
|
|
|
|
return Clicked;
|
|
}
|
|
}
|