Fixes #2114. 3D Effect

Terminal.Gui/Application/Application.cs

@@ -973,6 +973,7 @@ public static void RunIteration (ref RunState state, ref bool firstIteration)
 
  if (state.Toplevel.NeedsDisplay || state.Toplevel.SubViewNeedsDisplay || state.Toplevel.LayoutNeeded || OverlappedChildNeedsDisplay ())
  {
+ state.Toplevel.SetNeedsDisplay();
  state.Toplevel.Draw ();
  Driver.UpdateScreen ();
 

Terminal.Gui/Drawing/Color.cs

@@ -259,6 +259,27 @@ public Color GetHighlightColor ()
 
  }
 
+ /// <summary>
+ /// Gets a color that is the same hue as the current color, but with a different lightness.
+ /// </summary>
+ /// <returns></returns>
+ public Color GetDarkerColor ()
+ {
+ // TODO: This is a temporary implementation; just enough to show how it could work. 
+ var hsl = ColorHelper.ColorConverter.RgbToHsl (new RGB (R, G, B));
+
+ var amount = .3;
+ if (hsl.L <= 5)
+ {
+ return DarkGray;
+ }
+ hsl.L = (byte)(hsl.L * amount);
+
+ var rgb = ColorHelper.ColorConverter.HslToRgb (hsl);
+ return new (rgb.R, rgb.G, rgb.B);
+
+ }
+
  #region Legacy Color Names
 
  /// <summary>The black color.</summary>

Terminal.Gui/View/Adornment/Margin.cs

@@ -1,4 +1,5 @@
-namespace Terminal.Gui;
+#nullable enable
+namespace Terminal.Gui;
 
 /// <summary>The Margin for a <see cref="View"/>.</summary>
 /// <remarks>
@@ -15,8 +16,64 @@ public Margin ()
  public Margin (View parent) : base (parent)
  {
  /* Do nothing; View.CreateAdornment requires a constructor that takes a parent */
+
+ HighlightStyle |= HighlightStyle.Pressed;
+ Highlight += Margin_Highlight;
+ LayoutStarted += Margin_LayoutStarted;
+ }
+
+ private void Margin_LayoutStarted (object? sender, LayoutEventArgs e)
+ {
+ // Adjust the shadow such that it is drawn aligned with the Border
+ if (_shadow && _rightShadow is {} && _bottomShadow is {})
+ {
+ _rightShadow.Y = Parent.Border.Thickness.Top - (Parent.Border.Thickness.Top > 2 && Parent.Border.ShowTitle ? 1 : 0);
+ _bottomShadow.X = Parent.Border.Thickness.Left;
+ }
  }
 
+ private bool _pressed;
+ private void Margin_Highlight (object? sender, HighlightEventArgs e)
+ {
+ if (_shadow)
+ {
+ if (_pressed && e.HighlightStyle == HighlightStyle.None)
+ {
+ Thickness = new (Thickness.Left - 1, Thickness.Top, Thickness.Right + 1, Thickness.Bottom);
+
+ if (_rightShadow is { })
+ {
+ _rightShadow.Visible = true;
+ }
+
+ if (_bottomShadow is { })
+ {
+ _bottomShadow.Visible = true;
+ }
+
+ _pressed = false;
+ return;
+ }
+
+ if (!_pressed && (e.HighlightStyle.HasFlag (HighlightStyle.Pressed) /*|| e.HighlightStyle.HasFlag (HighlightStyle.PressedOutside)*/))
+ {
+ Thickness = new (Thickness.Left + 1, Thickness.Top, Thickness.Right - 1, Thickness.Bottom);
+ _pressed = true;
+ if (_rightShadow is { })
+ {
+ _rightShadow.Visible = false;
+ }
+
+ if (_bottomShadow is { })
+ {
+ _bottomShadow.Visible = false;
+ }
+ }
+ }
+
+ }
+
+
  /// <summary>
  /// The color scheme for the Margin. If set to <see langword="null"/>, gets the <see cref="Adornment.Parent"/>'s
  /// <see cref="View.SuperView"/> scheme. color scheme.
@@ -30,12 +87,165 @@ public override ColorScheme ColorScheme
  return base.ColorScheme;
  }
 
- return Parent?.SuperView?.ColorScheme ?? Colors.ColorSchemes ["TopLevel"];
+ return (Parent?.SuperView?.ColorScheme ?? Colors.ColorSchemes ["TopLevel"])!;
  }
  set
  {
  base.ColorScheme = value;
  Parent?.SetNeedsDisplay ();
  }
  }
+
+ private bool _shadow;
+
+ /// <summary>
+ /// Gets or sets whether the Margin includes a shadow effect. The shadow is drawn on the right and bottom sides of the
+ /// Margin.
+ /// </summary>
+ public bool EnableShadow (bool enable)
+ {
+ if (_shadow == enable)
+ {
+ return _shadow;
+ }
+
+ if (_shadow)
+ {
+ Thickness = new (Thickness.Left, Thickness.Top, Thickness.Right - 1, Thickness.Bottom - 1);
+ }
+
+ _shadow = enable;
+
+ if (_shadow)
+ {
+ Thickness = new (Thickness.Left, Thickness.Top, Thickness.Right + 1, Thickness.Bottom + 1);
+ }
+
+ if (_rightShadow is { })
+ {
+ _rightShadow.Visible = _shadow;
+ }
+
+ if (_bottomShadow is { })
+ {
+ _bottomShadow.Visible = _shadow;
+ }
+ return _shadow;
+ }
+
+ private View? _bottomShadow;
+ private View? _rightShadow;
+
+ /// <inheritdoc/>
+ public override void BeginInit ()
+ {
+ base.BeginInit ();
+
+ if (Parent is null)
+ {
+ return;
+ }
+
+ Attribute attr = Parent.GetNormalColor ();
+
+ Add (
+ _rightShadow = new ShadowView
+ {
+ X = Pos.AnchorEnd (1),
+ Y = 0,
+ Width = 1,
+ Height = Dim.Fill (),
+ Visible = _shadow,
+ Orientation = Orientation.Vertical
+ },
+ _bottomShadow = new ShadowView
+ {
+ X = 0,
+ Y = Pos.AnchorEnd (1),
+ Width = Dim.Fill (),
+ Height = 1,
+ Visible = _shadow,
+ Orientation = Orientation.Horizontal
+ }
+ );
+ }
+}
+
+/// <summary>
+/// Draws a shadow on the right or bottom of the view.
+/// </summary>
+internal class ShadowView : View
+{
+ // TODO: Add these to CM.Glyphs
+ private readonly char VERTICAL_START_GLYPH = '\u2596';
+ private readonly char VERTICAL_GLYPH = '\u258C';
+ private readonly char HORIZONTAL_START_GLYPH = '\u259d';
+ private readonly char HORIZONTAL_GLYPH = '\u2580';
+ private readonly char HORIZONTAL_END_GLYPH = '\u2598';
+
+ /// <summary>
+ /// Gets or sets the orientation of the shadow.
+ /// </summary>
+ public Orientation Orientation { get; set; }
+
+ /// <inheritdoc />
+ public override Attribute GetNormalColor ()
+ {
+ if (SuperView is Adornment adornment)
+ {
+ if (adornment.Parent.SuperView is { })
+ {
+ Attribute attr = adornment.Parent.SuperView.GetNormalColor ();
+ return new (new Attribute (attr.Foreground.GetDarkerColor (), attr.Background));
+ }
+ else
+ {
+ Attribute attr = Application.Top.GetNormalColor ();
+ return new (new Attribute (attr.Foreground.GetDarkerColor (), attr.Background));
+ }
+ }
+ return base.GetNormalColor ();
+ }
+
+ /// <inheritdoc/>
+ public override void OnDrawContent (Rectangle viewport)
+ {
+ //base.OnDrawContent (viewport);
+
+ if (Orientation == Orientation.Vertical)
+ {
+ DrawVerticalShadow (viewport);
+ }
+ else
+ {
+ DrawHorizontalShadow (viewport);
+ }
+ }
+
+ private void DrawHorizontalShadow (Rectangle rectangle)
+ {
+ // Draw the start glyph
+ AddRune (0, 0, (Rune)HORIZONTAL_START_GLYPH);
+
+ // Fill the rest of the rectangle with the glyph
+ for (var i = 1; i < rectangle.Width - 1; i++)
+ {
+ AddRune (i, 0, (Rune)HORIZONTAL_GLYPH);
+ }
+
+ // Last is special
+ AddRune (rectangle.Width - 1, 0, (Rune)HORIZONTAL_END_GLYPH);
+ }
+
+ private void DrawVerticalShadow (Rectangle viewport)
+ {
+ // Draw the start glyph
+ AddRune (0, 0, (Rune)VERTICAL_START_GLYPH);
+
+ // Fill the rest of the rectangle with the glyph
+ for (var i = 1; i < viewport.Height; i++)
+ {
+ AddRune (0, i, (Rune)VERTICAL_GLYPH);
+ }
+ }
 }

Terminal.Gui/View/ViewAdornments.cs

@@ -59,6 +59,36 @@
  /// </remarks>
  public Margin Margin { get; private set; }
 
+ [SerializableConfigurationProperty (Scope = typeof (ThemeScope))]
+ public static bool DefaultShadow { get; set; } = false;
+
+
+ private bool _shadow;
+ /// <summary>
+ /// Gets or sets whether the View is shown with a shadow effect. The shadow is drawn on the right and bottom sides of the
+ /// Margin.
+ /// </summary>
+ /// <remarks>
+ /// Setting this property to <see langword="true"/> will add a shadow to the right and bottom sides of the Margin.
+ /// The View 's <see cref="Frame"/> will be expanded to include the shadow.
+ /// </remarks>
+ public bool Shadow
+ {
+ get => _shadow;
+ set
+ {
+ if (_shadow == value)
+ {
+ return;
+ }
+ _shadow = value;
+ if (Margin is { })
+ {
+ _shadow = Margin.EnableShadow (value);
+ }
+ }
+ }
+
  /// <summary>
  /// The <see cref="Adornment"/> that offsets the <see cref="Viewport"/> from the <see cref="Margin"/>.
  /// The Border provides the space for a visual border (drawn using

Terminal.Gui/View/ViewEventArgs.cs

@@ -58,8 +58,11 @@ public DrawEventArgs (Rectangle newViewport, Rectangle oldViewport)
 public class FocusEventArgs : EventArgs
 {
  /// <summary>Constructs.</summary>
- /// <param name="view">The view that gets or loses focus.</param>
- public FocusEventArgs (View view) { View = view; }
+ /// <param name="leaving">The view that gets or loses focus.</param>
+ public FocusEventArgs (View leaving, View entering) {
+ Leaving = leaving;
+ Entering = entering;
+ }
 
  /// <summary>
  /// Indicates if the current focus event has already been processed and the driver should stop notifying any other
@@ -68,6 +71,10 @@ public class FocusEventArgs : EventArgs
  /// </summary>
  public bool Handled { get; set; }
 
- /// <summary>Indicates the current view that gets or loses focus.</summary>
- public View View { get; set; }
+ /// <summary>Indicates the view that is losing focus.</summary>
+ public View Leaving { get; set; }
+
+ /// <summary>Indicates the view that is gaining focus.</summary>
+ public View Entering { get; set; }
+
 }

Terminal.Gui/View/ViewMouse.cs

@@ -335,14 +335,14 @@ private bool HandlePressed (MouseEvent mouseEvent)
 
  if (Viewport.Contains (mouseEvent.Position))
  {
- if (SetHighlight (HighlightStyle.HasFlag (HighlightStyle.Pressed) ? HighlightStyle.Pressed : HighlightStyle.None) == true)
+ if (this is not Adornment && SetHighlight (HighlightStyle.HasFlag (HighlightStyle.Pressed) ? HighlightStyle.Pressed : HighlightStyle.None) == true)
  {
  return true;
  }
  }
  else
  {
- if (SetHighlight (HighlightStyle.HasFlag (HighlightStyle.PressedOutside) ? HighlightStyle.PressedOutside : HighlightStyle.None) == true)
+ if (this is not Adornment && SetHighlight (HighlightStyle.HasFlag (HighlightStyle.PressedOutside) ? HighlightStyle.PressedOutside : HighlightStyle.None) == true)
 
  {
  return true;
@@ -533,6 +533,20 @@ internal bool SetHighlight (HighlightStyle style)
  HighlightEventArgs args = new (highlight);
  Highlight?.Invoke (this, args);
 
+ if (args.Cancel)
+ {
+ return true;
+ }
+
+ args = new (highlight);
+ Margin?.Highlight?.Invoke (this, args);
+
+ //args = new (highlight);
+ //Border?.Highlight?.Invoke (this, args);
+
+ //args = new (highlight);
+ //Padding?.Highlight?.Invoke (this, args);
+
  return args.Cancel;
  }
 

Terminal.Gui/View/ViewSubViews.cs

@@ -505,7 +505,7 @@ public bool CanFocus
  /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  public virtual bool OnEnter (View view)
  {
- var args = new FocusEventArgs (view);
+ var args = new FocusEventArgs (view, this);
  Enter?.Invoke (this, args);
 
  if (args.Handled)
@@ -521,7 +521,7 @@ public virtual bool OnEnter (View view)
  /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
  public virtual bool OnLeave (View view)
  {
- var args = new FocusEventArgs (view);
+ var args = new FocusEventArgs (this, view);
  Leave?.Invoke (this, args);
 
  if (args.Handled)