Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 07:47:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Require non-null IApplication in MessageBox API (#4499)

Browse Source
This commit is contained in:
Tig
2025-12-17 05:42:48 -07:00
committed by GitHub
parent 9e0fa4c106
commit c19ca48c7b
1 changed files with 48 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
Terminal.Gui/Views/MessageBox.cs
View File

@@ -11,8 +11,8 @@ namespace Terminal.Gui.Views;
/// or <see langword="null"/> if the user pressed <see cref="Application.QuitKey"/> (typically Esc). /// or <see langword="null"/> if the user pressed <see cref="Application.QuitKey"/> (typically Esc).
/// </para> /// </para>
/// <para> /// <para>
/// <see cref="Query(IApplication?, string, string, string[])"/> uses the default Dialog color scheme. /// <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. /// <see cref="ErrorQuery(IApplication, string, string, string[])"/> uses the Error color scheme.
/// </para> /// </para>
/// <para> /// <para>
/// <b>Important:</b> All MessageBox methods require an <see cref="IApplication"/> instance to be passed. /// <b>Important:</b> All MessageBox methods require an <see cref="IApplication"/> instance to be passed.
@@ -126,11 +126,11 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, string[])"/> which automatically sizes the /// Consider using <see cref="ErrorQuery(IApplication, string, string, string[])"/> which automatically sizes the
/// MessageBox. /// MessageBox.
/// </remarks> /// </remarks>
public static int? ErrorQuery ( public static int? ErrorQuery (
IApplication? app, IApplication app,
int width, int width,
int height, int height,
string title, string title,
@@ -165,7 +165,7 @@ public static class MessageBox
/// <remarks> /// <remarks>
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? ErrorQuery (IApplication? app, string title, string message, params string [] buttons) public static int? ErrorQuery (IApplication app, string title, string message, params string [] buttons)
{ {
return QueryFull ( return QueryFull (
app, app,
@@ -195,11 +195,11 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, int, string[])"/> which automatically sizes the /// Consider using <see cref="ErrorQuery(IApplication, string, string, int, string[])"/> which automatically sizes the
/// MessageBox. /// MessageBox.
/// </remarks> /// </remarks>
public static int? ErrorQuery ( public static int? ErrorQuery (
IApplication? app, IApplication app,
int width, int width,
int height, int height,
string title, string title,
@@ -236,7 +236,7 @@ public static class MessageBox
/// <remarks> /// <remarks>
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? ErrorQuery (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons) public static int? ErrorQuery (IApplication app, string title, string message, int defaultButton = 0, params string [] buttons)
{ {
return QueryFull ( return QueryFull (
app, app,
@@ -270,11 +270,11 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="ErrorQuery(IApplication?, string, string, int, bool, string[])"/> which automatically /// Consider using <see cref="ErrorQuery(IApplication, string, string, int, bool, string[])"/> which automatically
/// sizes the MessageBox. /// sizes the MessageBox.
/// </remarks> /// </remarks>
public static int? ErrorQuery ( public static int? ErrorQuery (
IApplication? app, IApplication app,
int width, int width,
int height, int height,
string title, string title,
@@ -317,7 +317,7 @@ public static class MessageBox
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? ErrorQuery ( public static int? ErrorQuery (
IApplication? app, IApplication app,
string title, string title,
string message, string message,
int defaultButton = 0, int defaultButton = 0,
@@ -352,10 +352,10 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="Query(IApplication?, string, string, string[])"/> which automatically sizes the /// Consider using <see cref="Query(IApplication, string, string, string[])"/> which automatically sizes the
/// MessageBox. /// MessageBox.
/// </remarks> /// </remarks>
public static int? Query (IApplication? app, int width, int height, string title, string message, params string [] buttons) public static int? Query (IApplication app, int width, int height, string title, string message, params string [] buttons)
{ {
return QueryFull ( return QueryFull (
app, app,
@@ -384,7 +384,7 @@ public static class MessageBox
/// <remarks> /// <remarks>
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? Query (IApplication? app, string title, string message, params string [] buttons) public static int? Query (IApplication app, string title, string message, params string [] buttons)
{ {
return QueryFull ( return QueryFull (
app, app,
@@ -414,11 +414,11 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="Query(IApplication?, string, string, int, string[])"/> which automatically sizes the /// Consider using <see cref="Query(IApplication, string, string, int, string[])"/> which automatically sizes the
/// MessageBox. /// MessageBox.
/// </remarks> /// </remarks>
public static int? Query ( public static int? Query (
IApplication? app, IApplication app,
int width, int width,
int height, int height,
string title, string title,
@@ -455,7 +455,7 @@ public static class MessageBox
/// <remarks> /// <remarks>
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? Query (IApplication? app, string title, string message, int defaultButton = 0, params string [] buttons) public static int? Query (IApplication app, string title, string message, int defaultButton = 0, params string [] buttons)
{ {
return QueryFull ( return QueryFull (
app, app,
@@ -489,11 +489,11 @@ public static class MessageBox
/// </returns> /// </returns>
/// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception> /// <exception cref="ArgumentNullException">Thrown if <paramref name="app"/> is <see langword="null"/>.</exception>
/// <remarks> /// <remarks>
/// Consider using <see cref="Query(IApplication?, string, string, int, bool, string[])"/> which automatically sizes /// Consider using <see cref="Query(IApplication, string, string, int, bool, string[])"/> which automatically sizes
/// the MessageBox. /// the MessageBox.
/// </remarks> /// </remarks>
public static int? Query ( public static int? Query (
IApplication? app, IApplication app,
int width, int width,
int height, int height,
string title, string title,
@@ -536,7 +536,7 @@ public static class MessageBox
/// The MessageBox is centered and auto-sized based on title, message, and buttons. /// The MessageBox is centered and auto-sized based on title, message, and buttons.
/// </remarks> /// </remarks>
public static int? Query ( public static int? Query (
IApplication? app, IApplication app,
string title, string title,
string message, string message,
int defaultButton = 0, int defaultButton = 0,
@@ -557,7 +557,7 @@ public static class MessageBox
} }
private static int? QueryFull ( private static int? QueryFull (
IApplication? app, IApplication app,
bool useErrorColors, bool useErrorColors,
int width, int width,
int height, int height,
@@ -568,25 +568,22 @@ public static class MessageBox
params string [] buttons params string [] buttons
) )
{ {
ArgumentNullException.ThrowIfNull (app);
// Create button array for Dialog
var count = 0; var count = 0;
List<Button> buttonList = new (); List<Button> buttonList = [];
Clicked = null; Clicked = null;
if (buttons is { }) if (buttons.Length > 0)
{ {
if (defaultButton > buttons.Length - 1) if (defaultButton > buttons.Length - 1)
{ {
defaultButton = buttons.Length - 1; defaultButton = buttons.Length - 1;
} }
foreach (string s in buttons) foreach (string buttonText in buttons)
{ {
var b = new Button var b = new Button
{ {
Text = s, Text = buttonText,
Data = count Data = count
}; };
@@ -596,7 +593,7 @@ public static class MessageBox
b.Accepting += (s, e) => b.Accepting += (s, e) =>
{ {
if (e?.Context?.Source is Button button) if (e.Context?.Source is Button button)
{ {
Clicked = (int)button.Data!; Clicked = (int)button.Data!;
} }
@@ -605,10 +602,7 @@ public static class MessageBox
Clicked = defaultButton; Clicked = defaultButton;
} }
if (e is { }) e.Handled = true;
{
e.Handled = true;
}
(s as View)?.App?.RequestStop (); (s as View)?.App?.RequestStop ();
}; };
@@ -619,7 +613,7 @@ public static class MessageBox
} }
} }
var d = new Dialog Dialog dialog = new ()
{ {
Title = title, Title = title,
ButtonAlignment = DefaultButtonAlignment, ButtonAlignment = DefaultButtonAlignment,
@@ -628,38 +622,39 @@ public static class MessageBox
Buttons = buttonList.ToArray () Buttons = buttonList.ToArray ()
}; };
d.Width = Dim.Auto ( // ReSharper disable AccessToDisposedClosure
DimAutoStyle.Auto, dialog.Width = Dim.Auto (
Dim.Func (_ => (int)((app.Screen.Width - d.GetAdornmentsThickness ().Horizontal) * (DefaultMinimumWidth / 100f))), DimAutoStyle.Auto,
Dim.Func (_ => (int)((app.Screen.Width - d.GetAdornmentsThickness ().Horizontal) * 0.9f))); Dim.Func (_ => (int)((app.Screen.Width - dialog.GetAdornmentsThickness ().Horizontal) * (DefaultMinimumWidth / 100f))),
Dim.Func (_ => (int)((app.Screen.Width - dialog.GetAdornmentsThickness ().Horizontal) * 0.9f)));
d.Height = Dim.Auto ( dialog.Height = Dim.Auto (
DimAutoStyle.Auto, DimAutoStyle.Auto,
Dim.Func (_ => (int)((app.Screen.Height - d.GetAdornmentsThickness ().Vertical) * (DefaultMinimumHeight / 100f))), Dim.Func (_ => (int)((app.Screen.Height - dialog.GetAdornmentsThickness ().Vertical) * (DefaultMinimumHeight / 100f))),
Dim.Func (_ => (int)((app.Screen.Height - d.GetAdornmentsThickness ().Vertical) * 0.9f))); Dim.Func (_ => (int)((app.Screen.Height - dialog.GetAdornmentsThickness ().Vertical) * 0.9f)));
if (width != 0) if (width != 0)
{ {
d.Width = width; dialog.Width = width;
} }
if (height != 0) if (height != 0)
{ {
d.Height = height; dialog.Height = height;
} }
d.SchemeName = useErrorColors ? SchemeManager.SchemesToSchemeName (Schemes.Error) : SchemeManager.SchemesToSchemeName (Schemes.Dialog); dialog.SchemeName = useErrorColors ? SchemeManager.SchemesToSchemeName (Schemes.Error) : SchemeManager.SchemesToSchemeName (Schemes.Dialog);
d.HotKeySpecifier = new ('\xFFFF'); dialog.HotKeySpecifier = new ('\xFFFF');
d.Text = message; dialog.Text = message;
d.TextAlignment = Alignment.Center; dialog.TextAlignment = Alignment.Center;
d.VerticalTextAlignment = Alignment.Start; dialog.VerticalTextAlignment = Alignment.Start;
d.TextFormatter.WordWrap = wrapMessage; dialog.TextFormatter.WordWrap = wrapMessage;
d.TextFormatter.MultiLine = !wrapMessage; dialog.TextFormatter.MultiLine = !wrapMessage;
// Run the modal; do not shut down the mainloop driver when done // Run the modal
app.Run (d); app.Run (dialog);
d.Dispose (); dialog.Dispose ();
return Clicked; return Clicked;
} }