using System.ComponentModel; using Xunit.Abstractions; // ReSharper disable AccessToModifiedClosure namespace Terminal.Gui.ViewsTests; public class CheckBoxTests (ITestOutputHelper output) { private static readonly Size _size25x1 = new (25, 1); [Theory] [InlineData ("01234", 0, 0, 0, 0)] [InlineData ("01234", 1, 0, 1, 0)] [InlineData ("01234", 0, 1, 0, 1)] [InlineData ("01234", 1, 1, 1, 1)] [InlineData ("01234", 10, 1, 10, 1)] [InlineData ("01234", 10, 3, 10, 3)] [InlineData ("0_1234", 0, 0, 0, 0)] [InlineData ("0_1234", 1, 0, 1, 0)] [InlineData ("0_1234", 0, 1, 0, 1)] [InlineData ("0_1234", 1, 1, 1, 1)] [InlineData ("0_1234", 10, 1, 10, 1)] [InlineData ("0_12你", 10, 3, 10, 3)] [InlineData ("0_12你", 0, 0, 0, 0)] [InlineData ("0_12你", 1, 0, 1, 0)] [InlineData ("0_12你", 0, 1, 0, 1)] [InlineData ("0_12你", 1, 1, 1, 1)] [InlineData ("0_12你", 10, 1, 10, 1)] public void CheckBox_AbsoluteSize_Text (string text, int width, int height, int expectedWidth, int expectedHeight) { var checkBox = new CheckBox { X = 0, Y = 0, Width = width, Height = height, Text = text }; checkBox.Layout (); Assert.Equal (new (expectedWidth, expectedHeight), checkBox.Frame.Size); Assert.Equal (new (expectedWidth, expectedHeight), checkBox.Viewport.Size); Assert.Equal (new (expectedWidth, expectedHeight), checkBox.TextFormatter.ConstrainToSize); checkBox.Dispose (); } [Theory] [InlineData (0, 0, 0, 0)] [InlineData (1, 0, 1, 0)] [InlineData (0, 1, 0, 1)] [InlineData (1, 1, 1, 1)] [InlineData (10, 1, 10, 1)] [InlineData (10, 3, 10, 3)] public void CheckBox_AbsoluteSize_DefaultText (int width, int height, int expectedWidth, int expectedHeight) { var checkBox = new CheckBox { X = 0, Y = 0, Width = width, Height = height }; Assert.Equal (new (expectedWidth, expectedHeight), checkBox.Frame.Size); Assert.Equal (new (expectedWidth, expectedHeight), checkBox.Viewport.Size); Assert.Equal (new (expectedWidth, expectedHeight), checkBox.TextFormatter.ConstrainToSize); checkBox.Dispose (); } // Test that Title and Text are the same [Fact] public void Text_Mirrors_Title () { var view = new CheckBox (); view.Title = "Hello"; Assert.Equal ("Hello", view.Title); Assert.Equal ("Hello", view.TitleTextFormatter.Text); Assert.Equal ("Hello", view.Text); Assert.Equal ($"{CM.Glyphs.CheckStateUnChecked} Hello", view.TextFormatter.Text); } [Fact] public void Title_Mirrors_Text () { var view = new CheckBox (); view.Text = "Hello"; Assert.Equal ("Hello", view.Text); Assert.Equal ($"{CM.Glyphs.CheckStateUnChecked} Hello", view.TextFormatter.Text); Assert.Equal ("Hello", view.Title); Assert.Equal ("Hello", view.TitleTextFormatter.Text); } [Fact] public void Constructors_Defaults () { var ckb = new CheckBox (); Assert.True (ckb.Width is DimAuto); Assert.True (ckb.Height is DimAuto); ckb.Layout (); Assert.Equal (CheckState.UnChecked, ckb.CheckedState); Assert.False (ckb.AllowCheckStateNone); Assert.Equal (string.Empty, ckb.Text); Assert.Equal ($"{CM.Glyphs.CheckStateUnChecked} ", ckb.TextFormatter.Text); Assert.True (ckb.CanFocus); Assert.Equal (new (0, 0, 2, 1), ckb.Frame); ckb = new () { Text = "Test", CheckedState = CheckState.Checked }; Assert.True (ckb.Width is DimAuto); Assert.True (ckb.Height is DimAuto); ckb.Layout (); Assert.Equal (CheckState.Checked, ckb.CheckedState); Assert.False (ckb.AllowCheckStateNone); Assert.Equal ("Test", ckb.Text); Assert.Equal ($"{CM.Glyphs.CheckStateChecked} Test", ckb.TextFormatter.Text); Assert.True (ckb.CanFocus); Assert.Equal (new (0, 0, 6, 1), ckb.Frame); ckb = new () { Text = "Test", X = 1, Y = 2 }; Assert.True (ckb.Width is DimAuto); Assert.True (ckb.Height is DimAuto); ckb.Layout (); Assert.Equal (CheckState.UnChecked, ckb.CheckedState); Assert.False (ckb.AllowCheckStateNone); Assert.Equal ("Test", ckb.Text); Assert.Equal ($"{CM.Glyphs.CheckStateUnChecked} Test", ckb.TextFormatter.Text); Assert.True (ckb.CanFocus); Assert.Equal (new (1, 2, 6, 1), ckb.Frame); ckb = new () { Text = "Test", X = 3, Y = 4, CheckedState = CheckState.Checked }; Assert.True (ckb.Width is DimAuto); Assert.True (ckb.Height is DimAuto); ckb.Layout (); Assert.Equal (CheckState.Checked, ckb.CheckedState); Assert.False (ckb.AllowCheckStateNone); Assert.Equal ("Test", ckb.Text); Assert.Equal ($"{CM.Glyphs.CheckStateChecked} Test", ckb.TextFormatter.Text); Assert.True (ckb.CanFocus); Assert.Equal (new (3, 4, 6, 1), ckb.Frame); } [Fact] [SetupFakeDriver] public void AllowCheckStateNone_Get_Set () { var checkBox = new CheckBox { Text = "Check this out 你" }; checkBox.HasFocus = true; Assert.True (checkBox.HasFocus); Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); // Select with keyboard Assert.True (checkBox.NewKeyDownEvent (Key.Space)); Assert.Equal (CheckState.Checked, checkBox.CheckedState); // Select with mouse Assert.True (checkBox.NewMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked })); Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); checkBox.AllowCheckStateNone = true; Assert.True (checkBox.NewKeyDownEvent (Key.Space)); Assert.Equal (CheckState.None, checkBox.CheckedState); checkBox.Draw (); checkBox.AllowCheckStateNone = false; Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); } [Fact] public void Commands_Select () { Application.Navigation = new ApplicationNavigation (); Application.Top = new Toplevel (); View otherView = new () { CanFocus = true }; var ckb = new CheckBox (); Application.Top.Add (ckb, otherView); Application.Top.SetFocus (); Assert.True (ckb.HasFocus); int checkedStateChangingCount = 0; ckb.CheckedStateChanging += (s, e) => checkedStateChangingCount++; int selectCount = 0; ckb.Selecting += (s, e) => selectCount++; int acceptCount = 0; ckb.Accepting += (s, e) => acceptCount++; Assert.Equal (CheckState.UnChecked, ckb.CheckedState); Assert.Equal (0, checkedStateChangingCount); Assert.Equal (0, selectCount); Assert.Equal (0, acceptCount); Assert.Equal (Key.Empty, ckb.HotKey); // Test while focused ckb.Text = "_Test"; Assert.Equal (Key.T, ckb.HotKey); ckb.NewKeyDownEvent (Key.T); Assert.Equal (CheckState.Checked, ckb.CheckedState); Assert.Equal (1, checkedStateChangingCount); Assert.Equal (1, selectCount); Assert.Equal (0, acceptCount); ckb.Text = "T_est"; Assert.Equal (Key.E, ckb.HotKey); ckb.NewKeyDownEvent (Key.E.WithAlt); Assert.Equal (2, checkedStateChangingCount); Assert.Equal (2, selectCount); Assert.Equal (0, acceptCount); ckb.NewKeyDownEvent (Key.Space); Assert.Equal (3, checkedStateChangingCount); Assert.Equal (3, selectCount); Assert.Equal (0, acceptCount); ckb.NewKeyDownEvent (Key.Enter); Assert.Equal (3, checkedStateChangingCount); Assert.Equal (3, selectCount); Assert.Equal (1, acceptCount); Application.Top.Dispose (); Application.ResetState (false); } [Fact] public void Accept_Cancel_Event_OnAccept_Returns_True () { var ckb = new CheckBox (); var acceptInvoked = false; ckb.Accepting += ViewOnAccept; bool? ret = ckb.InvokeCommand (Command.Accept); Assert.True (ret); Assert.True (acceptInvoked); return; void ViewOnAccept (object sender, CommandEventArgs e) { acceptInvoked = true; e.Cancel = true; } } #region Mouse Tests [Fact] [SetupFakeDriver] public void Mouse_Click () { var checkBox = new CheckBox { Text = "_Checkbox" }; Assert.True (checkBox.CanFocus); int checkedStateChangingCount = 0; checkBox.CheckedStateChanging += (s, e) => checkedStateChangingCount++; int selectCount = 0; checkBox.Selecting += (s, e) => selectCount++; int acceptCount = 0; checkBox.Accepting += (s, e) => acceptCount++; checkBox.HasFocus = true; Assert.True (checkBox.HasFocus); Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); Assert.Equal (0, checkedStateChangingCount); Assert.Equal (0, selectCount); Assert.Equal (0, acceptCount); Assert.True (checkBox.NewMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked })); Assert.Equal (CheckState.Checked, checkBox.CheckedState); Assert.Equal (1, checkedStateChangingCount); Assert.Equal (1, selectCount); Assert.Equal (0, acceptCount); Assert.True (checkBox.NewMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked })); Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); Assert.Equal (2, checkedStateChangingCount); Assert.Equal (2, selectCount); Assert.Equal (0, acceptCount); checkBox.AllowCheckStateNone = true; Assert.True (checkBox.NewMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1Clicked })); Assert.Equal (CheckState.None, checkBox.CheckedState); Assert.Equal (3, checkedStateChangingCount); Assert.Equal (3, selectCount); Assert.Equal (0, acceptCount); } [Fact] [SetupFakeDriver] public void Mouse_DoubleClick () { var checkBox = new CheckBox { Text = "_Checkbox" }; Assert.True (checkBox.CanFocus); int checkedStateChangingCount = 0; checkBox.CheckedStateChanging += (s, e) => checkedStateChangingCount++; int selectCount = 0; checkBox.Selecting += (s, e) => selectCount++; int acceptCount = 0; checkBox.Accepting += (s, e) => acceptCount++; checkBox.HasFocus = true; Assert.True (checkBox.HasFocus); Assert.Equal (CheckState.UnChecked, checkBox.CheckedState); Assert.Equal (0, checkedStateChangingCount); Assert.Equal (0, selectCount); Assert.Equal (0, acceptCount); Assert.True (checkBox.NewMouseEvent (new () { Position = new (0, 0), Flags = MouseFlags.Button1DoubleClicked })); } #endregion Mouse Tests [Fact] [AutoInitShutdown] public void TextAlignment_Centered () { var checkBox = new CheckBox { X = 1, Y = Pos.Center (), Text = "Check this out 你", TextAlignment = Alignment.Center, Width = 25 }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); var top = new Toplevel (); top.Add (win); Application.Begin (top); ((FakeDriver)Application.Driver!).SetBufferSize (30, 5); Assert.Equal (Alignment.Center, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); Assert.Equal (_size25x1, checkBox.TextFormatter.ConstrainToSize); var expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateUnChecked} Check this out 你 │ │ │ └────────────────────────────┘ "; Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); checkBox.CheckedState = CheckState.Checked; Application.Refresh (); expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateChecked} Check this out 你 │ │ │ └────────────────────────────┘ "; pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); top.Dispose (); } [Fact] [AutoInitShutdown] public void TextAlignment_Justified () { var checkBox1 = new CheckBox { X = 1, Y = Pos.Center (), Text = "Check first out 你", TextAlignment = Alignment.Fill, Width = 25 }; var checkBox2 = new CheckBox { X = 1, Y = Pos.Bottom (checkBox1), Text = "Check second out 你", TextAlignment = Alignment.Fill, Width = 25 }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox1, checkBox2); var top = new Toplevel (); top.Add (win); RunState rs = Application.Begin (top); ((FakeDriver)Application.Driver!).SetBufferSize (30, 6); Assert.Equal (Alignment.Fill, checkBox1.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox1.Frame); Assert.Equal (Alignment.Fill, checkBox2.TextAlignment); Assert.Equal (new (1, 2, 25, 1), checkBox2.Frame); var expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateUnChecked} Check first out 你 │ │ {CM.Glyphs.CheckStateUnChecked} Check second out 你 │ │ │ └────────────────────────────┘ "; Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 6), pos); checkBox1.CheckedState = CheckState.Checked; Application.RunIteration (ref rs); Assert.Equal (new (1, 1, 25, 1), checkBox1.Frame); Assert.Equal (_size25x1, checkBox1.TextFormatter.ConstrainToSize); checkBox2.CheckedState = CheckState.Checked; Application.RunIteration (ref rs); Assert.Equal (new (1, 2, 25, 1), checkBox2.Frame); Assert.Equal (_size25x1, checkBox2.TextFormatter.ConstrainToSize); Application.Refresh (); expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateChecked} Check first out 你 │ │ {CM.Glyphs.CheckStateChecked} Check second out 你 │ │ │ └────────────────────────────┘ "; pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 6), pos); top.Dispose (); } [Fact] [AutoInitShutdown] public void TextAlignment_Left () { var checkBox = new CheckBox { X = 1, Y = Pos.Center (), Text = "Check this out 你", Width = 25 }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); var top = new Toplevel (); top.Add (win); Application.Begin (top); ((FakeDriver)Application.Driver!).SetBufferSize (30, 5); Assert.Equal (Alignment.Start, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); Assert.Equal (_size25x1, checkBox.TextFormatter.ConstrainToSize); var expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateUnChecked} Check this out 你 │ │ │ └────────────────────────────┘ "; Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); checkBox.CheckedState = CheckState.Checked; Application.Refresh (); expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ {CM.Glyphs.CheckStateChecked} Check this out 你 │ │ │ └────────────────────────────┘ "; pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); top.Dispose (); } [Fact] [AutoInitShutdown] public void TextAlignment_Right () { var checkBox = new CheckBox { X = 1, Y = Pos.Center (), Text = "Check this out 你", TextAlignment = Alignment.End, Width = 25 }; var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" }; win.Add (checkBox); var top = new Toplevel (); top.Add (win); Application.Begin (top); ((FakeDriver)Application.Driver!).SetBufferSize (30, 5); Assert.Equal (Alignment.End, checkBox.TextAlignment); Assert.Equal (new (1, 1, 25, 1), checkBox.Frame); Assert.Equal (_size25x1, checkBox.TextFormatter.ConstrainToSize); var expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ Check this out 你 {CM.Glyphs.CheckStateUnChecked} │ │ │ └────────────────────────────┘ "; Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); checkBox.CheckedState = CheckState.Checked; Application.Refresh (); expected = @$" ┌┤Test Demo 你├──────────────┐ │ │ │ Check this out 你 {CM.Glyphs.CheckStateChecked} │ │ │ └────────────────────────────┘ "; pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, output); Assert.Equal (new (0, 0, 30, 5), pos); top.Dispose (); } [Fact] public void HotKey_Command_Does_Not_Fire_Accept () { var cb = new CheckBox (); var accepted = false; cb.Accepting += CheckBoxOnAccept; cb.InvokeCommand (Command.HotKey); Assert.False (accepted); return; void CheckBoxOnAccept (object sender, CommandEventArgs e) { accepted = true; } } [Theory] [InlineData (CheckState.Checked)] [InlineData (CheckState.UnChecked)] [InlineData (CheckState.None)] public void Selected_Handle_Event_Does_Not_Prevent_Change (CheckState initialState) { var ckb = new CheckBox { AllowCheckStateNone = true }; var checkedInvoked = false; ckb.CheckedState = initialState; ckb.Selecting += OnSelecting; Assert.Equal (initialState, ckb.CheckedState); bool? ret = ckb.InvokeCommand (Command.Select); Assert.True (ret); Assert.True (checkedInvoked); Assert.NotEqual (initialState, ckb.CheckedState); return; void OnSelecting (object sender, CommandEventArgs e) { checkedInvoked = true; e.Cancel = true; } } [Theory] [InlineData (CheckState.Checked)] [InlineData (CheckState.UnChecked)] [InlineData (CheckState.None)] public void CheckedStateChanging_Cancel_Event_Prevents_Change (CheckState initialState) { var ckb = new CheckBox { AllowCheckStateNone = true }; var checkedInvoked = false; ckb.CheckedState = initialState; ckb.CheckedStateChanging += OnCheckedStateChanging; Assert.Equal (initialState, ckb.CheckedState); // AdvanceCheckState returns false if the state was changed, true if it was cancelled, null if it was not changed bool? ret = ckb.AdvanceCheckState (); Assert.True (ret); Assert.True (checkedInvoked); Assert.Equal (initialState, ckb.CheckedState); return; void OnCheckedStateChanging (object sender, CancelEventArgs e) { checkedInvoked = true; e.Cancel = true; } } }