Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-02 01:03:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Refactored API to support extensibilty... eg Hover (not implemented yet).

Browse Source
This commit is contained in:
Tig
2024-04-05 17:25:23 -04:00
parent dceed59a5f
commit cca32726fc
8 changed files with 259 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Terminal.Gui/View/Adornment/Border.cs
View File

@@ -57,8 +57,8 @@ public class Border : Adornment
Application.GrabbingMouse += Application_GrabbingMouse;
Application.UnGrabbingMouse += Application_UnGrabbingMouse;
EnablingHighlight += Border_EnablingHighlight;
DisablingHighlight += Border_DisablingHighlight;
HighlightStyle = HighlightStyle.Pressed;
Highlight += Border_Highlight;
}
#if SUBVIEW_BASED_BORDER
@@ -192,17 +192,17 @@ public class Border : Adornment
private LineStyle _savedHighlightLineStyle;
private void Border_EnablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
private void Border_Highlight (object sender, HighlightEventArgs e)
{
_savedHighlightLineStyle = Parent?.BorderStyle ?? LineStyle;
LineStyle = LineStyle.Heavy;
Parent?.SetNeedsDisplay ();
e.Cancel = true;
}
private void Border_DisablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
{
LineStyle = _savedHighlightLineStyle;
if (e.HighlightStyle == HighlightStyle)
{
_savedHighlightLineStyle = Parent?.BorderStyle ?? LineStyle;
LineStyle = LineStyle.Heavy;
}
else
{
LineStyle = _savedHighlightLineStyle;
}
Parent?.SetNeedsDisplay ();
e.Cancel = true;
}
@@ -242,7 +242,7 @@ public class Border : Adornment
_startGrabPoint = new (mouseEvent.X + Frame.X, mouseEvent.Y + Frame.Y);
_dragPosition = new (mouseEvent.X, mouseEvent.Y);
Application.GrabMouse (this);
EnableHighlight ();
SetHighlight (HighlightStyle);
}
return true;
@@ -286,7 +286,7 @@ public class Border : Adornment
{
_dragPosition = null;
Application.UngrabMouse ();
DisableHighlight();
SetHighlight (HighlightStyle.None);
return true;
}

277
Terminal.Gui/View/ViewMouse.cs
View File

@@ -1,15 +1,51 @@
using System.ComponentModel;
using System.Diagnostics;
namespace Terminal.Gui;
/// <summary>
/// Describes the highlight style of a view.
/// </summary>
[Flags]
public enum HighlightStyle
{
/// <summary>
/// No highlight.
/// </summary>
None = 0,
/// <summary>
/// The mouse is hovering over the view.
/// </summary>
Hover = 1,
/// <summary>
/// The mouse is pressed within the <see cref="View.Bounds"/>.
/// </summary>
Pressed = 2,
/// <summary>
/// The mouse is pressed but moved outside the <see cref="View.Bounds"/>.
/// </summary>
PressedOutside = 4
}
public class HighlightEventArgs : CancelEventArgs
{
public HighlightEventArgs (HighlightStyle style)
{
HighlightStyle = style;
}
public HighlightStyle HighlightStyle { get; }
}
public partial class View
{
/// <summary>
/// Gets or sets whether the <see cref="View"/> will be highlighted visually while the mouse button is
/// pressed.
/// </summary>
public bool HighlightOnPress { get; set; }
public HighlightStyle HighlightStyle { get; set; }
/// <summary>Gets or sets whether the <see cref="View"/> wants continuous button pressed events.</summary>
public virtual bool WantContinuousButtonPressed { get; set; }
@@ -93,9 +129,7 @@ public partial class View
/// mouse buttons was clicked, it calls <see cref="OnMouseClick"/> to process the click.
/// </para>
/// <para>
/// If <see cref="HighlightOnPress"/> is <see langword="true"/>, the view will be highlighted when the mouse is
/// pressed.
/// See <see cref="EnableHighlight"/> and <see cref="DisableHighlight"/> for more information.
/// See <see cref="SetHighlight"/> and <see cref="DisableHighlight"/> for more information.
/// </para>
/// <para>
/// If <see cref="WantContinuousButtonPressed"/> is <see langword="true"/>, the <see cref="OnMouseClick"/> event
@@ -124,18 +158,41 @@ public partial class View
return mouseEvent.Handled = true;
}
if ((HighlightOnPress || WantContinuousButtonPressed) && Highlight (mouseEvent))
if (HighlightStyle != Gui.HighlightStyle.None || WantContinuousButtonPressed)
{
Debug.Assert (mouseEvent.Handled);
if (HandlePressed (mouseEvent))
{
return mouseEvent.Handled;
}
return mouseEvent.Handled;
if (HandleReleased (mouseEvent))
{
return mouseEvent.Handled;
}
if (HandleClicked (mouseEvent))
{
return mouseEvent.Handled;
}
}
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4Clicked))
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button1DoubleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2DoubleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3DoubleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4DoubleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button1TripleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2TripleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3TripleClicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4TripleClicked)
)
{
// If it's a click, and we didn't handle it, then we'll call OnMouseClick
// We get here if the view did not handle the mouse event via OnMouseEvent/MouseEvent and
// it did not handle the press/release/clicked events via HandlePress/HandleRelease/HandleClicked
return OnMouseClick (new (mouseEvent));
}
@@ -143,43 +200,18 @@ public partial class View
}
/// <summary>
/// Highlight the view when the mouse is pressed.
/// For cases where the view is grabbed and the mouse is clicked, this method handles the released event (typically
/// when <see cref="WantContinuousButtonPressed"/> or <see cref="HighlightStyle"/> are set).
/// </summary>
/// <remarks>
/// <para>
/// Set <see cref="HighlightOnPress"/> to <see langword="true"/> to have the view highlighted when the mouse is
/// pressed.
/// </para>
/// <para>
/// Calls <see cref="OnEnablingHighlight"/> which fires the <see cref="EnablingHighlight"/> event.
/// </para>
/// <para>
/// Calls <see cref="OnDisablingHighlight"/> which fires the <see cref="DisablingHighlight"/> event.
/// Marked internal just to support unit tests
/// </para>
/// </remarks>
/// <param name="mouseEvent"></param>
/// <returns><see langword="true"/>, if the event was handled, <see langword="false"/> otherwise.</returns>
private bool Highlight (MouseEvent mouseEvent)
private bool HandlePressed (MouseEvent mouseEvent)
{
if (Application.MouseGrabView == this
&& (mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4Clicked)))
{
// We're grabbed. Clicked event comes after the last Release. This is our signal to ungrab
Application.UngrabMouse ();
DisableHighlight ();
// If mouse is still in bounds, click
if (!WantContinuousButtonPressed && Bounds.Contains (mouseEvent.X, mouseEvent.Y))
{
return OnMouseClick (new (mouseEvent));
}
return mouseEvent.Handled = true;
}
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2Pressed)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3Pressed)
@@ -199,11 +231,11 @@ public partial class View
if (Bounds.Contains (mouseEvent.X, mouseEvent.Y))
{
EnableHighlight ();
SetHighlight (HighlightStyle.HasFlag(HighlightStyle.Pressed) ? HighlightStyle.Pressed : HighlightStyle.None);
}
else
{
DisableHighlight ();
SetHighlight (HighlightStyle.HasFlag (HighlightStyle.PressedOutside) ? HighlightStyle.PressedOutside : HighlightStyle.None);
}
if (WantContinuousButtonPressed && Application.MouseGrabView == this)
@@ -215,6 +247,20 @@ public partial class View
return mouseEvent.Handled = true;
}
return false;
}
/// <summary>
/// For cases where the view is grabbed and the mouse is clicked, this method handles the released event (typically
/// when <see cref="WantContinuousButtonPressed"/> or <see cref="HighlightStyle"/> are set).
/// </summary>
/// <remarks>
/// Marked internal just to support unit tests
/// </remarks>
/// <param name="mouseEvent"></param>
/// <returns><see langword="true"/>, if the event was handled, <see langword="false"/> otherwise.</returns>
internal bool HandleReleased (MouseEvent mouseEvent)
{
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Released)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2Released)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3Released)
@@ -222,53 +268,111 @@ public partial class View
{
if (Application.MouseGrabView == this)
{
DisableHighlight ();
SetHighlight (HighlightStyle.None);
}
return mouseEvent.Handled = true;
}
return mouseEvent.Handled;
return false;
}
/// <summary>
/// For cases where the view is grabbed and the mouse is clicked, this method handles the click event (typically
/// when <see cref="WantContinuousButtonPressed"/> or <see cref="HighlightStyle"/> are set).
/// </summary>
/// <remarks>
/// Marked internal just to support unit tests
/// </remarks>
/// <param name="mouseEvent"></param>
/// <returns><see langword="true"/>, if the event was handled, <see langword="false"/> otherwise.</returns>
internal bool HandleClicked (MouseEvent mouseEvent)
{
if (Application.MouseGrabView == this
&& (mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button2Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button3Clicked)
|| mouseEvent.Flags.HasFlag (MouseFlags.Button4Clicked)))
{
// We're grabbed. Clicked event comes after the last Release. This is our signal to ungrab
Application.UngrabMouse ();
SetHighlight (HighlightStyle.None);
// If mouse is still in bounds, click
if (!WantContinuousButtonPressed && Bounds.Contains (mouseEvent.X, mouseEvent.Y))
{
return OnMouseClick (new (mouseEvent));
}
return mouseEvent.Handled = true;
}
return false;
}
[CanBeNull]
private ColorScheme _savedHighlightColorScheme;
/// <summary>
/// Enables the highlight for the view. Called from OnMouseEvent.
/// Enables the highlight for the view when the mouse is pressed. Called from OnMouseEvent.
/// </summary>
public void EnableHighlight ()
/// <remarks>
/// <para>
/// Set <see cref="HighlightStyle"/> to have the view highlighted based on the mouse.
/// </para>
/// <para>
/// Calls <see cref="OnHighlight"/> which fires the <see cref="Highlight"/> event.
/// </para>
/// <para>
/// Marked internal just to support unit tests
/// </para>
/// </remarks>
internal void SetHighlight (HighlightStyle style)
{
if (OnEnablingHighlight () == true)
// Enable override via virtual method and/or event
if (OnHighlight (style) == true)
{
return;
}
if (_savedHighlightColorScheme is null && ColorScheme is { })
if (style.HasFlag (HighlightStyle.Pressed) || style.HasFlag (HighlightStyle.PressedOutside))
{
_savedHighlightColorScheme ??= ColorScheme;
if (CanFocus)
if (_savedHighlightColorScheme is null && ColorScheme is { })
{
// TODO: Make the inverted color configurable
var cs = new ColorScheme (ColorScheme)
{
// For Buttons etc...
Focus = new (ColorScheme.Normal.Foreground, ColorScheme.Focus.Background),
_savedHighlightColorScheme ??= ColorScheme;
// For Adornments
Normal = new (ColorScheme.Focus.Foreground, ColorScheme.Normal.Background)
};
ColorScheme = cs;
if (CanFocus)
{
// TODO: Make the inverted color configurable
var cs = new ColorScheme (ColorScheme)
{
// For Buttons etc...
Focus = new (ColorScheme.Normal.Foreground, ColorScheme.Focus.Background),
// For Adornments
Normal = new (ColorScheme.Focus.Foreground, ColorScheme.Normal.Background)
};
ColorScheme = cs;
}
else
{
var cs = new ColorScheme (ColorScheme)
{
// For Buttons etc... that can't focus (like up/down).
Normal = new (ColorScheme.Focus.Background, ColorScheme.Normal.Foreground)
};
ColorScheme = cs;
}
}
else
}
else
{
// Unhighlight
if (_savedHighlightColorScheme is { })
{
var cs = new ColorScheme (ColorScheme)
{
// For Buttons etc... that can't focus (like up/down).
Normal = new (ColorScheme.Focus.Background, ColorScheme.Normal.Foreground)
};
ColorScheme = cs;
ColorScheme = _savedHighlightColorScheme;
_savedHighlightColorScheme = null;
}
}
}
@@ -277,53 +381,16 @@ public partial class View
/// Fired when the view is highlighted. Set <see cref="CancelEventArgs.Cancel"/> to <see langword="true"/>
/// to implement a custom highlight scheme or prevent the view from being highlighted.
/// </summary>
public event EventHandler<CancelEventArgs> EnablingHighlight;
public event EventHandler<HighlightEventArgs> Highlight;
/// <summary>
/// Called when the view is to be highlighted.
/// </summary>
/// <returns><see langword="true"/>, if the event was handled, <see langword="false"/> otherwise.</returns>
protected virtual bool? OnEnablingHighlight ()
protected virtual bool? OnHighlight (HighlightStyle highlight)
{
CancelEventArgs args = new ();
EnablingHighlight?.Invoke (this, args);
return args.Cancel;
}
/// <summary>
/// Disables the highlight for the view. Called from OnMouseEvent.
/// </summary>
public void DisableHighlight ()
{
if (OnDisablingHighlight () == true)
{
return;
}
// Unhighlight
if (_savedHighlightColorScheme is { })
{
ColorScheme = _savedHighlightColorScheme;
_savedHighlightColorScheme = null;
}
}
/// <summary>
/// Fired when the view is no longer to be highlighted. Set <see cref="CancelEventArgs.Cancel"/> to
/// <see langword="true"/>
/// to implement a custom highlight scheme or prevent the view from being highlighted.
/// </summary>
public event EventHandler<CancelEventArgs> DisablingHighlight;
/// <summary>
/// Called when the view is no longer to be highlighted.
/// </summary>
/// <returns><see langword="true"/>, if the event was handled, <see langword="false"/> otherwise.</returns>
protected virtual bool? OnDisablingHighlight ()
{
CancelEventArgs args = new ();
DisablingHighlight?.Invoke (this, args);
HighlightEventArgs args = new (highlight);
Highlight?.Invoke (this, args);
return args.Cancel;
}

30
Terminal.Gui/Views/Button.cs
View File

@@ -33,6 +33,9 @@ public class Button : View
private readonly Rune _rightDefault;
private bool _isDefault;
/// <inheritdoc />
private bool _wantContinuousButtonPressed;
/// <summary>Initializes a new instance of <see cref="Button"/> using <see cref="LayoutStyle.Computed"/> layout.</summary>
/// <remarks>The width of the <see cref="Button"/> is computed based on the text length. The height will always be 1.</remarks>
public Button ()
@@ -50,7 +53,7 @@ public class Button : View
CanFocus = true;
AutoSize = true;
HighlightOnPress = true;
HighlightStyle |= HighlightStyle.Pressed;
// Override default behavior of View
AddCommand (Command.HotKey, () =>
@@ -65,6 +68,31 @@ public class Button : View
TitleChanged += Button_TitleChanged;
MouseClick += Button_MouseClick;
}
/// <inheritdoc />
public override bool WantContinuousButtonPressed
{
get => _wantContinuousButtonPressed;
set
{
if (value == _wantContinuousButtonPressed)
{
return;
}
_wantContinuousButtonPressed = value;
if (_wantContinuousButtonPressed)
{
HighlightStyle |= HighlightStyle.PressedOutside;
}
else
{
HighlightStyle &= ~HighlightStyle.PressedOutside;
}
}
}
private void Button_MouseClick (object sender, MouseEventEventArgs e)
{
e.Handled = InvokeCommand (Command.HotKey) == true;

2
Terminal.Gui/Views/CheckBox.cs
View File

@@ -35,7 +35,7 @@ public class CheckBox : View
TitleChanged += Checkbox_TitleChanged;
HighlightOnPress = true;
HighlightStyle = Gui.HighlightStyle.PressedOutside | Gui.HighlightStyle.Pressed;
MouseClick += CheckBox_MouseClick;
}

2
Terminal.Gui/Views/ColorPicker.cs
View File

@@ -31,7 +31,7 @@ public class ColorPicker : View
private void SetInitialProperties ()
{
HighlightOnPress = true;
HighlightStyle = Gui.HighlightStyle.PressedOutside | Gui.HighlightStyle.Pressed;
CanFocus = true;
AddCommands ();

2
Terminal.Gui/Views/RadioGroup.cs
View File

@@ -77,7 +77,7 @@ public class RadioGroup : View
LayoutStarted += RadioGroup_LayoutStarted;
HighlightOnPress = true;
HighlightStyle = Gui.HighlightStyle.PressedOutside | Gui.HighlightStyle.Pressed;
MouseClick += RadioGroup_MouseClick;
}

10
UICatalog/Scenarios/Mouse.cs
View File

@@ -76,9 +76,17 @@ public class Mouse : Scenario
Y = Pos.Bottom (cbWantContinuousPresses),
Title = "_Highlight on Press",
};
cbHighlightOnPress.Checked = win.HighlightStyle == (HighlightStyle.Pressed | HighlightStyle.PressedOutside);
cbHighlightOnPress.Toggled += (s, e) =>
{
win.HighlightOnPress = !win.HighlightOnPress;
if (e.NewValue == true)
{
win.HighlightStyle = HighlightStyle.Pressed | HighlightStyle.PressedOutside;
}
else
{
win.HighlightStyle = HighlightStyle.None;
}
};
win.Add (cbHighlightOnPress);

58
UnitTests/View/MouseTests.cs
View File

@@ -465,27 +465,26 @@ public class MouseTests (ITestOutputHelper output)
}
[Theory]
[InlineData(false, 0, 0)]
[InlineData (true, 1, 1)]
public void HighlightOnPress_Fires_Events_And_Highlights (bool highlightOnPress, int expectedEnabling, int expectedDisabling)
[InlineData (HighlightStyle.None, 0, 0)]
[InlineData (HighlightStyle.Pressed | HighlightStyle.PressedOutside, 1, 1)]
public void HighlightOnPress_Fires_Events_And_Highlights (HighlightStyle highlightOnPress, int expectedEnabling, int expectedDisabling)
{
var view = new View ()
{
HighlightOnPress = highlightOnPress,
HighlightStyle = highlightOnPress,
Height = 1,
Width = 1
};
int enablingHighlight = 0;
int disablingHighlight = 0;
view.EnablingHighlight += View_EnablingHighlight;
view.DisablingHighlight += View_DisablingHighlight;
view.Highlight += View_Highlight;
view.ColorScheme = new ColorScheme (new Attribute (ColorName.Red, ColorName.Blue));
ColorScheme originalColorScheme = view.ColorScheme;
view.NewMouseEvent (new () { Flags = MouseFlags.Button1Pressed, });
if (highlightOnPress)
if (highlightOnPress != HighlightStyle.None)
{
Assert.NotEqual (originalColorScheme, view.ColorScheme);
}
@@ -503,16 +502,21 @@ public class MouseTests (ITestOutputHelper output)
return;
void View_DisablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
void View_Highlight (object sender, HighlightEventArgs e)
{
disablingHighlight++;
}
void View_EnablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
{
enablingHighlight++;
if (e.HighlightStyle == HighlightStyle.None)
{
disablingHighlight++;
}
else
{
enablingHighlight++;
}
}
}
// TODO: Add tests for each combination of HighlightFlags
[Theory]
[InlineData (0)]
[InlineData (1)]
@@ -521,14 +525,13 @@ public class MouseTests (ITestOutputHelper output)
{
var view = new View ()
{
HighlightOnPress = true,
HighlightStyle = HighlightStyle.Pressed | HighlightStyle.PressedOutside,
Height = 1,
Width = 1
};
int enablingHighlight = 0;
int disablingHighlight = 0;
view.EnablingHighlight += View_EnablingHighlight;
view.DisablingHighlight += View_DisablingHighlight;
view.Highlight += View_Highlight;
bool inViewport = view.Bounds.Contains (x, 0);
// Start at 0,0 ; in viewport
@@ -546,8 +549,8 @@ public class MouseTests (ITestOutputHelper output)
}
else
{
Assert.Equal (1, enablingHighlight);
Assert.Equal (1, disablingHighlight);
Assert.Equal (2, enablingHighlight);
Assert.Equal (0, disablingHighlight);
}
// Move backto 0,0 ; in viewport
@@ -559,21 +562,24 @@ public class MouseTests (ITestOutputHelper output)
}
else
{
Assert.Equal (2, enablingHighlight);
Assert.Equal (1, disablingHighlight);
Assert.Equal (3, enablingHighlight);
Assert.Equal (0, disablingHighlight);
}
view.Dispose ();
return;
void View_DisablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
void View_Highlight (object sender, HighlightEventArgs e)
{
disablingHighlight++;
}
void View_EnablingHighlight (object sender, System.ComponentModel.CancelEventArgs e)
{
enablingHighlight++;
if (e.HighlightStyle == HighlightStyle.None)
{
disablingHighlight++;
}
else
{
enablingHighlight++;
}
}
}