mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 00:07:58 +01:00
e7a4df492d
* Initial plan
* Rename Command.Select to Command.Activate and Selecting to Activating
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Add Activating event propagation to SuperView
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Update all comments and docs referencing Select to Activate
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Fix event log messages in examples to use Activating/Activate
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Revert automatic Activating event propagation that broke tests
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* Update docfx documentation to use Activate/Activating terminology
Co-authored-by: tig <585482+tig@users.noreply.github.com>
* renames
* Revert "Add Activating event propagation to SuperView"
This reverts commit 6d82bee9ad.
* added command diagrams
* mermaid
* updated level 3
* again
* Select->Activate in MouseTests.cs
* Update Terminal.Gui/Views/Selectors/FlagSelector.cs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Refactor: Rename Selecting to Activating in View APIs
Renamed the `Selecting` event and `OnSelecting` method to
`Activating` and `OnActivating` to better reflect their purpose.
Updated all related comments, test method names, variables,
and assertions in `View` and `ViewCommandTests` to align with
the new terminology.
Improved code clarity by using `_` for unused parameters in
lambda expressions. Renamed properties like `HandleSelecting`
to `HandleActivating` and adjusted naming conventions for
consistency (e.g., `OnactivatingCount` to `OnActivatingCount`).
These changes enhance readability, maintainability, and
terminology consistency across the codebase.
* Update Terminal.Gui/Views/Selectors/OptionSelector.cs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Typos
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
496 lines
14 KiB
C#
496 lines
14 KiB
C#
#nullable enable
|
|
using JetBrains.Annotations;
|
|
|
|
namespace ViewsTests;
|
|
|
|
[TestSubject (typeof (Shortcut))]
|
|
public class ShortcutTests
|
|
{
|
|
[Fact]
|
|
public void Constructor_Defaults ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
Assert.NotNull (shortcut);
|
|
Assert.True (shortcut.CanFocus);
|
|
Assert.IsType<DimAuto> (shortcut.Width);
|
|
Assert.IsType<DimAuto> (shortcut.Height);
|
|
}
|
|
|
|
[Fact]
|
|
public void Size_Defaults ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
shortcut.Layout ();
|
|
|
|
Assert.Equal (2, shortcut.Frame.Width);
|
|
Assert.Equal (1, shortcut.Frame.Height);
|
|
Assert.Equal (2, shortcut.Viewport.Width);
|
|
Assert.Equal (1, shortcut.Viewport.Height);
|
|
|
|
Assert.Equal (0, shortcut.CommandView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
|
|
|
|
Assert.Equal (0, shortcut.HelpView.Viewport.Width);
|
|
Assert.Equal (0, shortcut.HelpView.Viewport.Height);
|
|
|
|
Assert.Equal (0, shortcut.KeyView.Viewport.Width);
|
|
Assert.Equal (0, shortcut.KeyView.Viewport.Height);
|
|
|
|
// 0123456789
|
|
// " 0 A "
|
|
shortcut = new ()
|
|
{
|
|
Key = Key.A,
|
|
HelpText = "0"
|
|
};
|
|
shortcut.Layout ();
|
|
Assert.Equal (8, shortcut.Frame.Width);
|
|
Assert.Equal (1, shortcut.Frame.Height);
|
|
Assert.Equal (8, shortcut.Viewport.Width);
|
|
Assert.Equal (1, shortcut.Viewport.Height);
|
|
|
|
Assert.Equal (0, shortcut.CommandView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
|
|
|
|
Assert.Equal (1, shortcut.HelpView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.HelpView.Viewport.Height);
|
|
|
|
Assert.Equal (1, shortcut.KeyView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.KeyView.Viewport.Height);
|
|
|
|
// 0123456789
|
|
// " C 0 A "
|
|
shortcut = new ()
|
|
{
|
|
Title = "C",
|
|
Key = Key.A,
|
|
HelpText = "0"
|
|
};
|
|
shortcut.Layout ();
|
|
Assert.Equal (9, shortcut.Frame.Width);
|
|
Assert.Equal (1, shortcut.Frame.Height);
|
|
Assert.Equal (9, shortcut.Viewport.Width);
|
|
Assert.Equal (1, shortcut.Viewport.Height);
|
|
|
|
Assert.Equal (1, shortcut.CommandView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.CommandView.Viewport.Height);
|
|
|
|
Assert.Equal (1, shortcut.HelpView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.HelpView.Viewport.Height);
|
|
|
|
Assert.Equal (1, shortcut.KeyView.Viewport.Width);
|
|
Assert.Equal (1, shortcut.KeyView.Viewport.Height);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData ("", "", KeyCode.Null, 2)]
|
|
[InlineData ("C", "", KeyCode.Null, 3)]
|
|
[InlineData ("", "H", KeyCode.Null, 5)]
|
|
[InlineData ("", "", KeyCode.K, 5)]
|
|
[InlineData ("C", "", KeyCode.K, 6)]
|
|
[InlineData ("C", "H", KeyCode.Null, 6)]
|
|
[InlineData ("", "H", KeyCode.K, 8)]
|
|
[InlineData ("C", "H", KeyCode.K, 9)]
|
|
public void NaturalSize (string command, string help, KeyCode key, int expectedWidth)
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
HelpText = help,
|
|
Key = key,
|
|
Title = command
|
|
};
|
|
|
|
shortcut.Layout ();
|
|
|
|
// |0123456789
|
|
// | C H K |
|
|
Assert.Equal (expectedWidth, shortcut.Frame.Width);
|
|
|
|
shortcut = new ()
|
|
{
|
|
HelpText = help,
|
|
Title = command,
|
|
Key = key
|
|
};
|
|
|
|
shortcut.Layout ();
|
|
Assert.Equal (expectedWidth, shortcut.Frame.Width);
|
|
|
|
shortcut = new ()
|
|
{
|
|
HelpText = help,
|
|
Key = key,
|
|
Title = command
|
|
};
|
|
|
|
shortcut.Layout ();
|
|
Assert.Equal (expectedWidth, shortcut.Frame.Width);
|
|
|
|
shortcut = new ()
|
|
{
|
|
Key = key,
|
|
HelpText = help,
|
|
Title = command
|
|
};
|
|
|
|
shortcut.Layout ();
|
|
Assert.Equal (expectedWidth, shortcut.Frame.Width);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData (0, 0, 3, 3)]
|
|
[InlineData (1, 0, 3, 3)]
|
|
[InlineData (2, 0, 3, 3)]
|
|
[InlineData (3, 0, 3, 3)]
|
|
[InlineData (4, 0, 3, 3)]
|
|
[InlineData (5, 0, 3, 3)]
|
|
[InlineData (6, 0, 3, 3)]
|
|
[InlineData (7, 0, 3, 4)]
|
|
[InlineData (8, 0, 3, 5)]
|
|
[InlineData (9, 0, 3, 6)]
|
|
[InlineData (10, 0, 4, 7)]
|
|
[InlineData (11, 0, 5, 8)]
|
|
public void Set_Width_Layouts_Correctly (int width, int expectedCmdX, int expectedHelpX, int expectedKeyX)
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
Width = width,
|
|
Title = "C",
|
|
Text = "H",
|
|
Key = Key.K
|
|
};
|
|
shortcut.Layout ();
|
|
|
|
// 01234
|
|
// -C--K
|
|
|
|
// 012345
|
|
// -C--K-
|
|
|
|
// 0123456
|
|
// -C-H-K-
|
|
|
|
// 01234567
|
|
// -C--H-K-
|
|
|
|
// 012345678
|
|
// -C--H--K-
|
|
|
|
// 0123456789
|
|
// -C--H--K-
|
|
Assert.Equal (expectedCmdX, shortcut.CommandView.Frame.X);
|
|
Assert.Equal (expectedHelpX, shortcut.HelpView.Frame.X);
|
|
Assert.Equal (expectedKeyX, shortcut.KeyView.Frame.X);
|
|
}
|
|
|
|
[Fact]
|
|
public void CommandView_Text_And_Title_Track ()
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
Title = "T"
|
|
};
|
|
|
|
Assert.Equal (shortcut.Title, shortcut.CommandView.Text);
|
|
|
|
shortcut = new ();
|
|
|
|
shortcut.CommandView = new ()
|
|
{
|
|
Text = "T"
|
|
};
|
|
Assert.Equal (shortcut.Title, shortcut.CommandView.Text);
|
|
}
|
|
|
|
[Fact]
|
|
public void HelpText_And_Text_Are_The_Same ()
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
Text = "H"
|
|
};
|
|
|
|
Assert.Equal (shortcut.Text, shortcut.HelpText);
|
|
|
|
shortcut = new ()
|
|
{
|
|
HelpText = "H"
|
|
};
|
|
|
|
Assert.Equal (shortcut.Text, shortcut.HelpText);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData (KeyCode.Null, "")]
|
|
[InlineData (KeyCode.F1, "F1")]
|
|
public void KeyView_Text_Tracks_Key (KeyCode key, string expected)
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
Key = key
|
|
};
|
|
|
|
Assert.Equal (expected, shortcut.KeyView.Text);
|
|
}
|
|
|
|
// Test Key
|
|
[Fact]
|
|
public void Key_Defaults_To_Empty ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
Assert.Equal (Key.Empty, shortcut.Key);
|
|
}
|
|
|
|
[Fact]
|
|
public void Key_Can_Be_Set ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
shortcut.Key = Key.F1;
|
|
|
|
Assert.Equal (Key.F1, shortcut.Key);
|
|
}
|
|
|
|
[Fact]
|
|
public void Key_Can_Be_Set_To_Empty ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
shortcut.Key = Key.Empty;
|
|
|
|
Assert.Equal (Key.Empty, shortcut.Key);
|
|
}
|
|
|
|
[Fact]
|
|
public void Key_Set_Binds_Key_To_CommandView_Accept ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
shortcut.Key = Key.F1;
|
|
|
|
// TODO:
|
|
}
|
|
|
|
[Fact]
|
|
public void Key_Changing_Removes_Previous_Binding ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
shortcut.Key = Key.A;
|
|
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
|
|
|
|
shortcut.Key = Key.B;
|
|
Assert.False (shortcut.HotKeyBindings.TryGet (Key.A, out _));
|
|
Assert.True (shortcut.HotKeyBindings.TryGet (Key.B, out _));
|
|
}
|
|
|
|
// Test Key gets bound correctly
|
|
[Fact]
|
|
public void BindKeyToApplication_Defaults_To_HotKey ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
Assert.False (shortcut.BindKeyToApplication);
|
|
}
|
|
|
|
[Fact]
|
|
public void BindKeyToApplication_Can_Be_Set ()
|
|
{
|
|
IApplication? app = Application.Create ();
|
|
var shortcut = new Shortcut () { App = app };
|
|
|
|
shortcut.BindKeyToApplication = true;
|
|
|
|
Assert.True (shortcut.BindKeyToApplication);
|
|
}
|
|
|
|
[Fact]
|
|
public void BindKeyToApplication_Changing_Adjusts_KeyBindings ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
shortcut.Key = Key.A;
|
|
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
|
|
|
|
shortcut.App = Application.Create ();
|
|
shortcut.BindKeyToApplication = true;
|
|
shortcut.BeginInit ();
|
|
shortcut.EndInit ();
|
|
Assert.False (shortcut.HotKeyBindings.TryGet (Key.A, out _));
|
|
Assert.True (shortcut.App?.Keyboard.KeyBindings.TryGet (Key.A, out _));
|
|
|
|
shortcut.BindKeyToApplication = false;
|
|
Assert.True (shortcut.HotKeyBindings.TryGet (Key.A, out _));
|
|
Assert.False (shortcut.App?.Keyboard.KeyBindings.TryGet (Key.A, out _));
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData (Orientation.Horizontal)]
|
|
[InlineData (Orientation.Vertical)]
|
|
public void Orientation_SetsCorrectly (Orientation orientation)
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
Orientation = orientation
|
|
};
|
|
|
|
Assert.Equal (orientation, shortcut.Orientation);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData (AlignmentModes.StartToEnd)]
|
|
[InlineData (AlignmentModes.EndToStart)]
|
|
public void AlignmentModes_SetsCorrectly (AlignmentModes alignmentModes)
|
|
{
|
|
var shortcut = new Shortcut
|
|
{
|
|
AlignmentModes = alignmentModes
|
|
};
|
|
|
|
Assert.Equal (alignmentModes, shortcut.AlignmentModes);
|
|
}
|
|
|
|
[Fact]
|
|
public void Action_SetsAndGetsCorrectly ()
|
|
{
|
|
var actionInvoked = false;
|
|
|
|
var shortcut = new Shortcut
|
|
{
|
|
Action = () => { actionInvoked = true; }
|
|
};
|
|
|
|
shortcut.Action.Invoke ();
|
|
|
|
Assert.True (actionInvoked);
|
|
}
|
|
|
|
[Fact]
|
|
public void SubView_Visibility_Controlled_By_Removal ()
|
|
{
|
|
var shortcut = new Shortcut ();
|
|
|
|
Assert.True (shortcut.CommandView.Visible);
|
|
Assert.Contains (shortcut.CommandView, shortcut.SubViews);
|
|
Assert.True (shortcut.HelpView.Visible);
|
|
Assert.DoesNotContain (shortcut.HelpView, shortcut.SubViews);
|
|
Assert.True (shortcut.KeyView.Visible);
|
|
Assert.DoesNotContain (shortcut.KeyView, shortcut.SubViews);
|
|
|
|
shortcut.HelpText = "help";
|
|
Assert.True (shortcut.HelpView.Visible);
|
|
Assert.Contains (shortcut.HelpView, shortcut.SubViews);
|
|
Assert.True (shortcut.KeyView.Visible);
|
|
Assert.DoesNotContain (shortcut.KeyView, shortcut.SubViews);
|
|
|
|
shortcut.Key = Key.A;
|
|
Assert.True (shortcut.HelpView.Visible);
|
|
Assert.Contains (shortcut.HelpView, shortcut.SubViews);
|
|
Assert.True (shortcut.KeyView.Visible);
|
|
Assert.Contains (shortcut.KeyView, shortcut.SubViews);
|
|
|
|
shortcut.HelpView.Visible = false;
|
|
shortcut.ShowHide ();
|
|
Assert.False (shortcut.HelpView.Visible);
|
|
Assert.DoesNotContain (shortcut.HelpView, shortcut.SubViews);
|
|
Assert.True (shortcut.KeyView.Visible);
|
|
Assert.Contains (shortcut.KeyView, shortcut.SubViews);
|
|
|
|
shortcut.KeyView.Visible = false;
|
|
shortcut.ShowHide ();
|
|
Assert.False (shortcut.HelpView.Visible);
|
|
Assert.DoesNotContain (shortcut.HelpView, shortcut.SubViews);
|
|
Assert.False (shortcut.KeyView.Visible);
|
|
Assert.DoesNotContain (shortcut.KeyView, shortcut.SubViews);
|
|
}
|
|
|
|
[Fact]
|
|
public void Focus_CanFocus_Default_Is_True ()
|
|
{
|
|
Shortcut shortcut = new ();
|
|
shortcut.Key = Key.A;
|
|
shortcut.Text = "Help";
|
|
shortcut.Title = "Command";
|
|
Assert.True (shortcut.CanFocus);
|
|
Assert.False (shortcut.CommandView.CanFocus);
|
|
}
|
|
|
|
[Fact]
|
|
public void Focus_CanFocus_CommandView_Add_Tracks ()
|
|
{
|
|
Shortcut shortcut = new ();
|
|
Assert.True (shortcut.CanFocus);
|
|
Assert.False (shortcut.CommandView.CanFocus);
|
|
|
|
shortcut.CommandView = new () { CanFocus = true };
|
|
Assert.True (shortcut.CommandView.CanFocus);
|
|
|
|
shortcut.CommandView.CanFocus = true;
|
|
Assert.True (shortcut.CommandView.CanFocus);
|
|
|
|
shortcut.CanFocus = false;
|
|
Assert.False (shortcut.CanFocus);
|
|
Assert.True (shortcut.CommandView.CanFocus);
|
|
|
|
shortcut.CommandView.CanFocus = false;
|
|
Assert.False (shortcut.CanFocus);
|
|
Assert.False (shortcut.CommandView.CanFocus);
|
|
|
|
shortcut.CommandView.CanFocus = true;
|
|
Assert.False (shortcut.CanFocus);
|
|
Assert.True (shortcut.CommandView.CanFocus);
|
|
}
|
|
|
|
[Theory (Skip = "Broke somehow!")]
|
|
[InlineData (true, KeyCode.A, 1, 1)]
|
|
[InlineData (true, KeyCode.C, 1, 1)]
|
|
[InlineData (true, KeyCode.C | KeyCode.AltMask, 1, 1)]
|
|
[InlineData (true, KeyCode.Enter, 1, 1)]
|
|
[InlineData (true, KeyCode.Space, 1, 1)]
|
|
[InlineData (true, KeyCode.F1, 0, 0)]
|
|
[InlineData (false, KeyCode.A, 1, 1)]
|
|
[InlineData (false, KeyCode.C, 1, 1)]
|
|
[InlineData (false, KeyCode.C | KeyCode.AltMask, 1, 1)]
|
|
[InlineData (false, KeyCode.Enter, 0, 0)]
|
|
[InlineData (false, KeyCode.Space, 0, 0)]
|
|
[InlineData (false, KeyCode.F1, 0, 0)]
|
|
public void KeyDown_CheckBox_Raises_Accepted_Selected (bool canFocus, KeyCode key, int expectedAccept, int expectedSelect)
|
|
{
|
|
IApplication? app = Application.Create ();
|
|
Runnable<bool> runnable = new ();
|
|
app.Begin (runnable);
|
|
|
|
var shortcut = new Shortcut
|
|
{
|
|
Key = Key.A,
|
|
Text = "0",
|
|
CommandView = new CheckBox ()
|
|
{
|
|
Title = "_C"
|
|
},
|
|
CanFocus = canFocus
|
|
};
|
|
runnable.Add (shortcut);
|
|
|
|
Assert.Equal (canFocus, shortcut.HasFocus);
|
|
|
|
var accepted = 0;
|
|
shortcut.Accepting += (s, e) =>
|
|
{
|
|
accepted++;
|
|
e.Handled = true;
|
|
};
|
|
|
|
var selected = 0;
|
|
shortcut.Activating += (s, e) => selected++;
|
|
|
|
app.Keyboard.RaiseKeyDownEvent (key);
|
|
|
|
Assert.Equal (expectedAccept, accepted);
|
|
Assert.Equal (expectedSelect, selected);
|
|
}
|
|
|
|
}
|