diff --git a/README.md b/README.md
index 8ace962338..6ffb641f54 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-
-
-
+
+
+
[](https://www.nuget.org/packages/Terminal.Gui)
[](https://www.nuget.org/packages/Terminal.Gui)
@@ -31,8 +31,10 @@ dotnet run
## Documentation
-* [Documentation Home](https://gui-cs.github.io/Terminal.GuiV2Docs)
+* [Getting Started](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/getting-started.html)
+* [What's new in v2](https://gui-cs.github.io/Terminal.GuiV2Docs/docs/newinv2.html)
* [API Documentation](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.html)
+* [Documentation Home](https://gui-cs.github.io/Terminal.GuiV2Docs)
## Showcase & Examples
diff --git a/ReactiveExample/ReactiveExample.csproj b/ReactiveExample/ReactiveExample.csproj
index e3e43708ea..68974a8b41 100644
--- a/ReactiveExample/ReactiveExample.csproj
+++ b/ReactiveExample/ReactiveExample.csproj
@@ -12,7 +12,7 @@
-
+
diff --git a/Terminal.Gui/Application.cs b/Terminal.Gui/Application.cs
index 1901bba2ac..5e17af95f5 100644
--- a/Terminal.Gui/Application.cs
+++ b/Terminal.Gui/Application.cs
@@ -88,7 +88,7 @@ internal static void ResetState ()
#if DEBUG_IDISPOSABLE
// Don't dispose the toplevels. It's up to caller dispose them
- Debug.Assert (t.WasDisposed);
+ //Debug.Assert (t.WasDisposed);
#endif
}
@@ -99,6 +99,7 @@ internal static void ResetState ()
// Don't dispose the Top. It's up to caller dispose it
if (Top is { })
{
+
Debug.Assert (Top.WasDisposed);
// If End wasn't called _cachedRunStateToplevel may be null
@@ -132,7 +133,7 @@ internal static void ResetState ()
// Don't reset ForceDriver; it needs to be set before Init is called.
//ForceDriver = string.Empty;
- Force16Colors = false;
+ //Force16Colors = false;
_forceFakeConsole = false;
// Run State stuff
@@ -525,7 +526,10 @@ public static RunState Begin (Toplevel toplevel)
MoveCurrent (Current);
}
- toplevel.SetRelativeLayout (Driver.Bounds);
+ //if (Toplevel.LayoutStyle == LayoutStyle.Computed) {
+ toplevel.SetRelativeLayout (Driver.Screen.Size);
+
+ //}
// BUGBUG: This call is likely not needed.
toplevel.LayoutSubviews ();
@@ -638,7 +642,7 @@ public static T Run (Func errorHandler = null, ConsoleDriver
public static void Run (Toplevel view, Func errorHandler = null, ConsoleDriver driver = null)
{
ArgumentNullException.ThrowIfNull (view);
-
+
if (_initialized)
{
if (Driver is null)
@@ -878,7 +882,7 @@ public static void RunIteration (ref RunState state, ref bool firstIteration)
}
else
{
- Driver.UpdateCursor ();
+ //Driver.UpdateCursor ();
}
if (state.Toplevel != Top && !state.Toplevel.Modal && (Top.NeedsDisplay || Top.SubViewNeedsDisplay || Top.LayoutNeeded))
@@ -1307,7 +1311,7 @@ public static bool OnSizeChanging (SizeChangedEventArgs args)
foreach (Toplevel t in _topLevels)
{
- t.SetRelativeLayout (Rectangle.Empty with { Size = args.Size });
+ t.SetRelativeLayout (args.Size);
t.LayoutSubviews ();
t.PositionToplevels ();
t.OnSizeChanging (new (args.Size));
@@ -1437,15 +1441,15 @@ private static void OnUnGrabbedMouse (View view)
///
///
/// Use this event to receive mouse events in screen coordinates. Use to
- /// receive mouse events relative to a 's bounds.
+ /// receive mouse events relative to a .
///
/// The will contain the that contains the mouse coordinates.
///
- public static event EventHandler MouseEvent;
+ public static event EventHandler? MouseEvent;
/// Called when a mouse event occurs. Raises the event.
/// This method can be used to simulate a mouse event, e.g. in unit tests.
- /// The mouse event with coordinates relative to the screen.
+ /// The mouse event with coordinates relative to the screen.
internal static void OnMouseEvent (MouseEvent mouseEvent)
{
if (IsMouseDisabled)
@@ -1453,7 +1457,6 @@ internal static void OnMouseEvent (MouseEvent mouseEvent)
return;
}
- // TODO: In PR #3273, FindDeepestView will return adornments. Update logic below to fix adornment mouse handling
var view = View.FindDeepestView (Current, mouseEvent.X, mouseEvent.Y);
if (view is { })
@@ -1472,18 +1475,18 @@ internal static void OnMouseEvent (MouseEvent mouseEvent)
{
// If the mouse is grabbed, send the event to the view that grabbed it.
// The coordinates are relative to the Bounds of the view that grabbed the mouse.
- Point boundsLoc = MouseGrabView.ScreenToBounds (mouseEvent.X, mouseEvent.Y);
+ Point frameLoc = MouseGrabView.ScreenToViewport (mouseEvent.X, mouseEvent.Y);
var viewRelativeMouseEvent = new MouseEvent
{
- X = boundsLoc.X,
- Y = boundsLoc.Y,
+ X = frameLoc.X,
+ Y = frameLoc.Y,
Flags = mouseEvent.Flags,
ScreenPosition = new (mouseEvent.X, mouseEvent.Y),
View = MouseGrabView
};
- if (MouseGrabView.Bounds.Contains (viewRelativeMouseEvent.X, viewRelativeMouseEvent.Y) is false)
+ if ((MouseGrabView.Viewport with { Location = Point.Empty }).Contains (viewRelativeMouseEvent.X, viewRelativeMouseEvent.Y) is false)
{
// The mouse has moved outside the bounds of the view that grabbed the mouse
_mouseEnteredView?.NewMouseLeaveEvent (mouseEvent);
@@ -1546,14 +1549,14 @@ internal static void OnMouseEvent (MouseEvent mouseEvent)
View = view
};
}
- else if (view.BoundsToScreen (view.Bounds).Contains (mouseEvent.X, mouseEvent.Y))
+ else if (view.ViewportToScreen (Rectangle.Empty with { Size = view.Viewport.Size }).Contains (mouseEvent.X, mouseEvent.Y))
{
- Point boundsPoint = view.ScreenToBounds (mouseEvent.X, mouseEvent.Y);
+ Point viewportLocation = view.ScreenToViewport (mouseEvent.X, mouseEvent.Y);
me = new ()
{
- X = boundsPoint.X,
- Y = boundsPoint.Y,
+ X = viewportLocation.X,
+ Y = viewportLocation.Y,
Flags = mouseEvent.Flags,
ScreenPosition = new (mouseEvent.X, mouseEvent.Y),
View = view
@@ -1586,10 +1589,37 @@ internal static void OnMouseEvent (MouseEvent mouseEvent)
//Debug.WriteLine ($"OnMouseEvent: ({a.MouseEvent.X},{a.MouseEvent.Y}) - {a.MouseEvent.Flags}");
- if (view.NewMouseEvent (me) == false)
+ while (view.NewMouseEvent (me) != true)
{
- // Should we bubble up the event, if it is not handled?
- //return;
+ if (MouseGrabView is { })
+ {
+ break;
+ }
+
+ if (view is Adornment adornmentView)
+ {
+ view = adornmentView.Parent.SuperView;
+ }
+ else
+ {
+ view = view.SuperView;
+ }
+
+ if (view is null)
+ {
+ break;
+ }
+
+ Point boundsPoint = view.ScreenToViewport (mouseEvent.X, mouseEvent.Y);
+
+ me = new ()
+ {
+ X = boundsPoint.X,
+ Y = boundsPoint.Y,
+ Flags = mouseEvent.Flags,
+ ScreenPosition = new (mouseEvent.X, mouseEvent.Y),
+ View = view
+ };
}
BringOverlappedTopToFront ();
diff --git a/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs b/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs
index 1974b6147e..7187d71912 100644
--- a/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs
+++ b/Terminal.Gui/ConsoleDrivers/ConsoleDriver.cs
@@ -18,15 +18,31 @@ public abstract class ConsoleDriver
// This is in addition to the dirty flag on each cell.
internal bool [] _dirtyLines;
- /// Gets the dimensions of the terminal.
- public Rectangle Bounds => new (0, 0, Cols, Rows);
+ // QUESTION: When non-full screen apps are supported, will this represent the app size, or will that be in Application?
+ /// Gets the location and size of the terminal screen.
+ public Rectangle Screen => new (0, 0, Cols, Rows);
+
+ private Rectangle _clip;
///
/// Gets or sets the clip rectangle that and are subject
/// to.
///
- /// The rectangle describing the bounds of .
- public Rectangle Clip { get; set; }
+ /// The rectangle describing the of region.
+ public Rectangle Clip
+ {
+ get => _clip;
+ set
+ {
+ if (_clip == value)
+ {
+ return;
+ }
+
+ // Don't ever let Clip be bigger than Screen
+ _clip = Rectangle.Intersect (Screen, value);
+ }
+ }
/// Get the operating system clipboard.
public IClipboard Clipboard { get; internal set; }
@@ -278,16 +294,6 @@ public void AddStr (string str)
for (var i = 0; i < runes.Count; i++)
{
- //if (runes [i].IsCombiningMark()) {
-
- // // Attempt to normalize
- // string combined = runes [i-1] + runes [i].ToString();
-
- // // Normalize to Form C (Canonical Composition)
- // string normalized = combined.Normalize (NormalizationForm.FormC);
-
- // runes [i-]
- //}
AddRune (runes [i]);
}
}
@@ -295,31 +301,27 @@ public void AddStr (string str)
/// Clears the of the driver.
public void ClearContents ()
{
- // TODO: This method is really "Clear Contents" now and should not be abstract (or virtual)
Contents = new Cell [Rows, Cols];
//CONCURRENCY: Unsynchronized access to Clip isn't safe.
- Clip = new (0, 0, Cols, Rows);
+ // TODO: ClearContents should not clear the clip; it should only clear the contents. Move clearing it elsewhere.
+ Clip = Screen;
_dirtyLines = new bool [Rows];
lock (Contents)
{
- // Can raise an exception while is still resizing.
- try
+ for (var row = 0; row < Rows; row++)
{
- for (var row = 0; row < Rows; row++)
+ for (var c = 0; c < Cols; c++)
{
- for (var c = 0; c < Cols; c++)
+ Contents [row, c] = new Cell
{
- Contents [row, c] = new Cell
- {
- Rune = (Rune)' ', Attribute = new Attribute (Color.White, Color.Black), IsDirty = true
- };
- _dirtyLines [row] = true;
- }
+ Rune = (Rune)' ',
+ Attribute = new Attribute (Color.White, Color.Black),
+ IsDirty = true
+ };
+ _dirtyLines [row] = true;
}
}
- catch (IndexOutOfRangeException)
- { }
}
}
@@ -327,18 +329,28 @@ public void ClearContents ()
/// upon success
public abstract bool EnsureCursorVisibility ();
- // TODO: Move FillRect to ./Drawing
- /// Fills the specified rectangle with the specified rune.
- ///
- ///
+ /// Fills the specified rectangle with the specified rune, using
+ ///
+ /// The value of is honored. Any parts of the rectangle not in the clip will not be drawn.
+ ///
+ /// The Screen-relative rectangle.
+ /// The Rune used to fill the rectangle
public void FillRect (Rectangle rect, Rune rune = default)
{
- for (int r = rect.Y; r < rect.Y + rect.Height; r++)
+ rect = Rectangle.Intersect (rect, Clip);
+ lock (Contents)
{
- for (int c = rect.X; c < rect.X + rect.Width; c++)
+ for (int r = rect.Y; r < rect.Y + rect.Height; r++)
{
- Application.Driver.Move (c, r);
- Application.Driver.AddRune (rune == default (Rune) ? new Rune (' ') : rune);
+ for (int c = rect.X; c < rect.X + rect.Width; c++)
+ {
+ Contents [r, c] = new Cell
+ {
+ Rune = (rune != default ? rune : (Rune)' '),
+ Attribute = CurrentAttribute, IsDirty = true
+ };
+ _dirtyLines [r] = true;
+ }
}
}
}
@@ -372,10 +384,13 @@ public void FillRect (Rectangle rect, Rune rune = default)
/// The column.
/// The row.
///
- /// if the coordinate is outside of the screen bounds or outside of .
+ /// if the coordinate is outside the screen bounds or outside of .
/// otherwise.
///
- public bool IsValidLocation (int col, int row) { return col >= 0 && row >= 0 && col < Cols && row < Rows && Clip.Contains (col, row); }
+ public bool IsValidLocation (int col, int row)
+ {
+ return col >= 0 && row >= 0 && col < Cols && row < Rows && Clip.Contains (col, row);
+ }
///
/// Updates and to the specified column and row in .
@@ -437,6 +452,7 @@ public virtual void Move (int col, int row)
/// Gets whether the supports TrueColor output.
public virtual bool SupportsTrueColor => true;
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
///
/// Gets or sets whether the should use 16 colors instead of the default TrueColors.
/// See to change this setting via .
@@ -466,6 +482,7 @@ public Attribute CurrentAttribute
get => _currentAttribute;
set
{
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. Once Attribute.PlatformColor is removed, this can be fixed.
if (Application.Driver is { })
{
_currentAttribute = new Attribute (value.Foreground, value.Background);
diff --git a/Terminal.Gui/ConsoleDrivers/NetDriver.cs b/Terminal.Gui/ConsoleDrivers/NetDriver.cs
index 4a85804f28..22cd0b9872 100644
--- a/Terminal.Gui/ConsoleDrivers/NetDriver.cs
+++ b/Terminal.Gui/ConsoleDrivers/NetDriver.cs
@@ -1315,7 +1315,7 @@ public override void UpdateCursor ()
{
EnsureCursorVisibility ();
- if (Col >= 0 && Col < Cols && Row >= 0 && Row < Rows)
+ if (Col >= 0 && Col < Cols && Row >= 0 && Row <= Rows)
{
SetCursorPosition (Col, Row);
SetWindowPosition (0, Row);
diff --git a/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs b/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
index 9f5e8a006f..7b67c31f7a 100644
--- a/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
+++ b/Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
@@ -18,6 +18,7 @@
using System.ComponentModel;
using System.Diagnostics;
using System.Runtime.InteropServices;
+using System.Text;
using static Terminal.Gui.ConsoleDrivers.ConsoleKeyMapping;
namespace Terminal.Gui;
@@ -110,6 +111,7 @@ public bool WriteToConsole (Size size, ExtendedCharInfo [] charInfoBuffer, Coord
}
_stringBuilder.Append (EscSeqUtils.CSI_RestoreCursorPosition);
+ _stringBuilder.Append (EscSeqUtils.CSI_HideCursor);
var s = _stringBuilder.ToString ();
@@ -129,6 +131,11 @@ public bool WriteToConsole (Size size, ExtendedCharInfo [] charInfoBuffer, Coord
return result;
}
+ public bool WriteANSI (string ansi)
+ {
+ return WriteConsole (_screenBuffer, ansi, (uint)ansi.Length, out uint _, null);
+ }
+
public void ReadFromConsoleOutput (Size size, Coord coords, ref SmallRect window)
{
_screenBuffer = CreateConsoleScreenBuffer (
@@ -167,7 +174,10 @@ public void ReadFromConsoleOutput (Size size, Coord coords, ref SmallRect window
}
}
- public bool SetCursorPosition (Coord position) { return SetConsoleCursorPosition (_screenBuffer, position); }
+ public bool SetCursorPosition (Coord position)
+ {
+ return SetConsoleCursorPosition (_screenBuffer, position);
+ }
public void SetInitialCursorVisibility ()
{
@@ -577,14 +587,14 @@ public struct InputRecord
public readonly override string ToString ()
{
return EventType switch
- {
- EventType.Focus => FocusEvent.ToString (),
- EventType.Key => KeyEvent.ToString (),
- EventType.Menu => MenuEvent.ToString (),
- EventType.Mouse => MouseEvent.ToString (),
- EventType.WindowBufferSize => WindowBufferSizeEvent.ToString (),
- _ => "Unknown event type: " + EventType
- };
+ {
+ EventType.Focus => FocusEvent.ToString (),
+ EventType.Key => KeyEvent.ToString (),
+ EventType.Menu => MenuEvent.ToString (),
+ EventType.Mouse => MouseEvent.ToString (),
+ EventType.WindowBufferSize => WindowBufferSizeEvent.ToString (),
+ _ => "Unknown event type: " + EventType
+ };
}
}
@@ -980,7 +990,6 @@ internal class WindowsDriver : ConsoleDriver
{
private readonly bool _isWindowsTerminal;
- private CursorVisibility _cachedCursorVisibility;
private WindowsConsole.SmallRect _damageRegion;
private bool _isButtonDoubleClicked;
private bool _isButtonPressed;
@@ -1023,9 +1032,6 @@ public WindowsDriver ()
public WindowsConsole WinConsole { get; private set; }
- ///
- public override bool EnsureCursorVisibility () { return WinConsole is null || WinConsole.EnsureCursorVisibility (); }
-
public WindowsConsole.KeyEventRecord FromVKPacketToKeyEventRecord (WindowsConsole.KeyEventRecord keyEvent)
{
if (keyEvent.wVirtualKeyCode != (VK)ConsoleKey.Packet)
@@ -1072,25 +1078,12 @@ public WindowsConsole.KeyEventRecord FromVKPacketToKeyEventRecord (WindowsConsol
};
}
- ///
- public override bool GetCursorVisibility (out CursorVisibility visibility)
- {
- if (WinConsole is { })
- {
- return WinConsole.GetCursorVisibility (out visibility);
- }
-
- visibility = _cachedCursorVisibility;
-
- return true;
- }
-
public override bool IsRuneSupported (Rune rune) { return base.IsRuneSupported (rune) && rune.IsBmp; }
public override void Refresh ()
{
UpdateScreen ();
- WinConsole?.SetInitialCursorVisibility ();
+ //WinConsole?.SetInitialCursorVisibility ();
UpdateCursor ();
}
@@ -1164,13 +1157,6 @@ public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool al
}
}
- ///
- public override bool SetCursorVisibility (CursorVisibility visibility)
- {
- _cachedCursorVisibility = visibility;
-
- return WinConsole is null || WinConsole.SetCursorVisibility (visibility);
- }
#region Not Implemented
@@ -1194,9 +1180,13 @@ public WindowsConsole.ConsoleKeyInfoEx ToConsoleKeyInfoEx (WindowsConsole.KeyEve
return new WindowsConsole.ConsoleKeyInfoEx (cki, capslock, numlock, scrolllock);
}
+ #region Cursor Handling
+
+ private CursorVisibility? _cachedCursorVisibility;
+
public override void UpdateCursor ()
{
- if (Col < 0 || Row < 0 || Col > Cols || Row > Rows)
+ if (Col < 0 || Row < 0 || Col >= Cols || Row >= Rows)
{
GetCursorVisibility (out CursorVisibility cursorVisibility);
_cachedCursorVisibility = cursorVisibility;
@@ -1205,16 +1195,90 @@ public override void UpdateCursor ()
return;
}
- SetCursorVisibility (_cachedCursorVisibility);
-
var position = new WindowsConsole.Coord
{
X = (short)Col,
Y = (short)Row
};
- WinConsole?.SetCursorPosition (position);
+
+ if (Force16Colors)
+ {
+ WinConsole?.SetCursorPosition (position);
+ }
+ else
+ {
+ var sb = new StringBuilder ();
+ sb.Append (EscSeqUtils.CSI_SetCursorPosition (position.Y + 1, position.X + 1));
+ WinConsole?.WriteANSI (sb.ToString ());
+ }
+
+ if (_cachedCursorVisibility is { })
+ {
+ SetCursorVisibility (_cachedCursorVisibility.Value);
+ }
+ //EnsureCursorVisibility ();
}
+ ///
+ public override bool GetCursorVisibility (out CursorVisibility visibility)
+ {
+ if (WinConsole is { })
+ {
+ return WinConsole.GetCursorVisibility (out visibility);
+ }
+
+ visibility = _cachedCursorVisibility ?? CursorVisibility.Default;
+
+ return true;
+ }
+
+ ///
+ public override bool SetCursorVisibility (CursorVisibility visibility)
+ {
+ _cachedCursorVisibility = visibility;
+
+ if (Force16Colors)
+ {
+ return WinConsole is null || WinConsole.SetCursorVisibility (visibility);
+ }
+ else
+ {
+ var sb = new StringBuilder ();
+ sb.Append (visibility != CursorVisibility.Invisible ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
+ return WinConsole?.WriteANSI (sb.ToString ()) ?? false;
+ }
+ }
+
+ ///
+ public override bool EnsureCursorVisibility ()
+ {
+ if (Force16Colors)
+ {
+ return WinConsole is null || WinConsole.EnsureCursorVisibility ();
+ }
+ else
+ {
+ var sb = new StringBuilder ();
+ sb.Append (_cachedCursorVisibility != CursorVisibility.Invisible ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
+ return WinConsole?.WriteANSI (sb.ToString ()) ?? false;
+ }
+
+ if (!(Col >= 0 && Row >= 0 && Col < Cols && Row < Rows))
+ {
+ GetCursorVisibility (out CursorVisibility cursorVisibility);
+ _cachedCursorVisibility = cursorVisibility;
+ SetCursorVisibility (CursorVisibility.Invisible);
+
+ return false;
+ }
+
+ SetCursorVisibility (_cachedCursorVisibility ?? CursorVisibility.Default);
+
+ return _cachedCursorVisibility == CursorVisibility.Default;
+ }
+
+ #endregion Cursor Handling
+
public override void UpdateScreen ()
{
Size windowSize = WinConsole?.GetConsoleBufferWindow (out Point _) ?? new Size (Cols, Rows);
@@ -1226,8 +1290,8 @@ public override void UpdateScreen ()
var bufferCoords = new WindowsConsole.Coord
{
- X = (short)Clip.Width,
- Y = (short)Clip.Height
+ X = (short)Cols, //Clip.Width,
+ Y = (short)Rows, //Clip.Height
};
for (var row = 0; row < Rows; row++)
@@ -1574,13 +1638,13 @@ private KeyCode MapKey (WindowsConsole.ConsoleKeyInfoEx keyInfoEx)
// returned (e.g. on ENG OemPlus un-shifted is =, not +). This is important
// for key persistence ("Ctrl++" vs. "Ctrl+=").
mappedChar = keyInfo.Key switch
- {
- ConsoleKey.OemPeriod => '.',
- ConsoleKey.OemComma => ',',
- ConsoleKey.OemPlus => '+',
- ConsoleKey.OemMinus => '-',
- _ => mappedChar
- };
+ {
+ ConsoleKey.OemPeriod => '.',
+ ConsoleKey.OemComma => ',',
+ ConsoleKey.OemPlus => '+',
+ ConsoleKey.OemMinus => '-',
+ _ => mappedChar
+ };
}
// Return the mappedChar with they modifiers. Because mappedChar is un-shifted, if Shift was down
@@ -1745,7 +1809,10 @@ private async Task ProcessContinuousButtonPressedAsync (MouseFlags mouseFlag)
Flags = mouseFlag
};
- if (Application.WantContinuousButtonPressedView is null)
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
+ View view = Application.WantContinuousButtonPressedView;
+
+ if (view is null)
{
break;
}
@@ -1759,6 +1826,7 @@ private async Task ProcessContinuousButtonPressedAsync (MouseFlags mouseFlag)
//Debug.WriteLine($"ProcessContinuousButtonPressedAsync: {view}");
if (_isButtonPressed && (mouseFlag & MouseFlags.ReportMousePosition) == 0)
{
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
Application.Invoke (() => OnMouseEvent (me));
}
}
@@ -1813,6 +1881,7 @@ private MouseEvent ToDriverMouse (WindowsConsole.MouseEventRecord mouseEvent)
if (_isButtonDoubleClicked || _isOneFingerDoubleClicked)
{
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
Application.MainLoop.AddIdle (
() =>
{
@@ -1884,6 +1953,7 @@ private MouseEvent ToDriverMouse (WindowsConsole.MouseEventRecord mouseEvent)
if ((mouseFlag & MouseFlags.ReportMousePosition) == 0)
{
+ // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
Application.MainLoop.AddIdle (
() =>
{
diff --git a/Terminal.Gui/Drawing/LineCanvas.cs b/Terminal.Gui/Drawing/LineCanvas.cs
index 6fe9858523..0e9fac7613 100644
--- a/Terminal.Gui/Drawing/LineCanvas.cs
+++ b/Terminal.Gui/Drawing/LineCanvas.cs
@@ -48,7 +48,7 @@ public class LineCanvas : IDisposable
// TODO: Add other resolvers
};
- private Rectangle _cachedBounds;
+ private Rectangle _cachedViewport;
/// Creates a new instance.
public LineCanvas ()
@@ -67,37 +67,37 @@ public LineCanvas ()
/// Gets the rectangle that describes the bounds of the canvas. Location is the coordinates of the line that is
/// furthest left/top and Size is defined by the line that extends the furthest right/bottom.
///
- public Rectangle Bounds
+ public Rectangle Viewport
{
get
{
- if (_cachedBounds.IsEmpty)
+ if (_cachedViewport.IsEmpty)
{
if (_lines.Count == 0)
{
- return _cachedBounds;
+ return _cachedViewport;
}
- Rectangle bounds = _lines [0].Bounds;
+ Rectangle viewport = _lines [0].Viewport;
for (var i = 1; i < _lines.Count; i++)
{
- bounds = Rectangle.Union (bounds, _lines [i].Bounds);
+ viewport = Rectangle.Union (viewport, _lines [i].Viewport);
}
- if (bounds is {Width: 0} or {Height: 0})
+ if (viewport is {Width: 0} or {Height: 0})
{
- bounds = bounds with
+ viewport = viewport with
{
- Width = Math.Clamp (bounds.Width, 1, short.MaxValue),
- Height = Math.Clamp (bounds.Height, 1, short.MaxValue)
+ Width = Math.Clamp (viewport.Width, 1, short.MaxValue),
+ Height = Math.Clamp (viewport.Height, 1, short.MaxValue)
};
}
- _cachedBounds = bounds;
+ _cachedViewport = viewport;
}
- return _cachedBounds;
+ return _cachedViewport;
}
}
@@ -134,7 +134,7 @@ public void AddLine (
Attribute? attribute = default
)
{
- _cachedBounds = Rectangle.Empty;
+ _cachedViewport = Rectangle.Empty;
_lines.Add (new StraightLine (start, length, orientation, style, attribute));
}
@@ -142,14 +142,14 @@ public void AddLine (
///
public void AddLine (StraightLine line)
{
- _cachedBounds = Rectangle.Empty;
+ _cachedViewport = Rectangle.Empty;
_lines.Add (line);
}
/// Clears all lines from the LineCanvas.
public void Clear ()
{
- _cachedBounds = Rectangle.Empty;
+ _cachedViewport = Rectangle.Empty;
_lines.Clear ();
}
@@ -157,7 +157,7 @@ public void Clear ()
/// Clears any cached states from the canvas Call this method if you make changes to lines that have already been
/// added.
///
- public void ClearCache () { _cachedBounds = Rectangle.Empty; }
+ public void ClearCache () { _cachedViewport = Rectangle.Empty; }
///
/// Evaluates the lines that have been added to the canvas and returns a map containing the glyphs and their
@@ -170,9 +170,9 @@ public Dictionary GetCellMap ()
Dictionary map = new ();
// walk through each pixel of the bitmap
- for (int y = Bounds.Y; y < Bounds.Y + Bounds.Height; y++)
+ for (int y = Viewport.Y; y < Viewport.Y + Viewport.Height; y++)
{
- for (int x = Bounds.X; x < Bounds.X + Bounds.Width; x++)
+ for (int x = Viewport.X; x < Viewport.X + Viewport.Width; x++)
{
IntersectionDefinition? [] intersects = _lines
.Select (l => l.Intersects (x, y))
@@ -232,7 +232,7 @@ public Dictionary GetMap (Rectangle inArea)
/// intersection symbols.
///
/// A map of all the points within the canvas.
- public Dictionary GetMap () { return GetMap (Bounds); }
+ public Dictionary GetMap () { return GetMap (Viewport); }
/// Merges one line canvas into this one.
///
@@ -260,13 +260,13 @@ public StraightLine RemoveLastLine ()
///
/// Returns the contents of the line canvas rendered to a string. The string will include all columns and rows,
- /// even if has negative coordinates. For example, if the canvas contains a single line that
+ /// even if has negative coordinates. For example, if the canvas contains a single line that
/// starts at (-1,-1) with a length of 2, the rendered string will have a length of 2.
///
/// The canvas rendered to a string.
public override string ToString ()
{
- if (Bounds.IsEmpty)
+ if (Viewport.IsEmpty)
{
return string.Empty;
}
@@ -275,13 +275,13 @@ public override string ToString ()
Dictionary runeMap = GetMap ();
// Create the rune canvas
- Rune [,] canvas = new Rune [Bounds.Height, Bounds.Width];
+ Rune [,] canvas = new Rune [Viewport.Height, Viewport.Width];
// Copy the rune map to the canvas, adjusting for any negative coordinates
foreach (KeyValuePair kvp in runeMap)
{
- int x = kvp.Key.X - Bounds.X;
- int y = kvp.Key.Y - Bounds.Y;
+ int x = kvp.Key.X - Viewport.X;
+ int y = kvp.Key.Y - Viewport.Y;
canvas [y, x] = kvp.Value;
}
diff --git a/Terminal.Gui/Drawing/StraightLine.cs b/Terminal.Gui/Drawing/StraightLine.cs
index 1dd7b803c4..9a2785f0f4 100644
--- a/Terminal.Gui/Drawing/StraightLine.cs
+++ b/Terminal.Gui/Drawing/StraightLine.cs
@@ -45,8 +45,8 @@ public StraightLine (
/// Gets the rectangle that describes the bounds of the canvas. Location is the coordinates of the line that is
/// furthest left/top and Size is defined by the line that extends the furthest right/bottom.
///
- // PERF: Probably better to store the rectangle rather than make a new one on every single access to Bounds.
- internal Rectangle Bounds
+ // PERF: Probably better to store the rectangle rather than make a new one on every single access to Viewport.
+ internal Rectangle Viewport
{
get
{
diff --git a/Terminal.Gui/Drawing/Thickness.cs b/Terminal.Gui/Drawing/Thickness.cs
index 26f97ffb35..ffe8b3f708 100644
--- a/Terminal.Gui/Drawing/Thickness.cs
+++ b/Terminal.Gui/Drawing/Thickness.cs
@@ -161,6 +161,7 @@ public Rectangle Draw (Rectangle rect, string label = null)
Application.Driver.FillRect (rect with { Height = Math.Min (rect.Height, Top) }, topChar);
}
+ // Draw the Left side
// Draw the Left side
if (Left > 0)
{
diff --git a/Terminal.Gui/Input/Mouse.cs b/Terminal.Gui/Input/Mouse.cs
index 2b3f2852be..7ea253a764 100644
--- a/Terminal.Gui/Input/Mouse.cs
+++ b/Terminal.Gui/Input/Mouse.cs
@@ -116,10 +116,10 @@ public class MouseEvent
/// The View at the location for the mouse event.
public View View { get; set; }
- /// The X position of the mouse in -relative coordinates.
+ /// The X position of the mouse in -relative coordinates.
public int X { get; set; }
- /// The Y position of the mouse in -relative coordinates.
+ /// The Y position of the mouse in -relative coordinates.
public int Y { get; set; }
///
@@ -133,12 +133,12 @@ public class MouseEvent
///
///
///
- /// The and properties are always -relative. When the mouse is grabbed by a view,
+ /// The and properties are always -relative. When the mouse is grabbed by a view,
/// provides the mouse position screen-relative coordinates, enabling the grabbed view to know how much the
/// mouse has moved.
///
///
- /// Calculated and processed in .
+ /// Calculated and processed in .
///
///
public Point ScreenPosition { get; set; }
diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj
index c2f39edb84..3c909c250d 100644
--- a/Terminal.Gui/Terminal.Gui.csproj
+++ b/Terminal.Gui/Terminal.Gui.csproj
@@ -48,8 +48,8 @@
-
-
+
+
diff --git a/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs b/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs
index ba5fbed5a4..76d74f512d 100644
--- a/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs
+++ b/Terminal.Gui/Text/Autocomplete/AppendAutocomplete.cs
@@ -117,7 +117,7 @@ public override void RenderOverlay (Point renderAt)
Suggestion suggestion = Suggestions.ElementAt (SelectedIdx);
string fragment = suggestion.Replacement.Substring (suggestion.Remove);
- int spaceAvailable = textField.Bounds.Width - textField.Text.GetColumns ();
+ int spaceAvailable = textField.Viewport.Width - textField.Text.GetColumns ();
int spaceRequired = fragment.EnumerateRunes ().Sum (c => c.GetColumns ());
if (spaceAvailable < spaceRequired)
diff --git a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs b/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs
index 55a6140759..86fc949ecf 100644
--- a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs
+++ b/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.PopUp.cs
@@ -16,7 +16,7 @@ public Popup (PopupAutocomplete autoComplete)
protected internal override bool OnMouseEvent (MouseEvent mouseEvent) { return _autoComplete.OnMouseEvent (mouseEvent); }
- public override void OnDrawContent (Rectangle contentArea)
+ public override void OnDrawContent (Rectangle viewport)
{
if (!_autoComplete.LastPopupPos.HasValue)
{
diff --git a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs b/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs
index 84ea483657..e76aa8a2d0 100644
--- a/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs
+++ b/Terminal.Gui/Text/Autocomplete/PopupAutocomplete.cs
@@ -271,13 +271,13 @@ public override void RenderOverlay (Point renderAt)
if (PopupInsideContainer)
{
// don't overspill vertically
- height = Math.Min (HostControl.Bounds.Height - renderAt.Y, MaxHeight);
+ height = Math.Min (HostControl.Viewport.Height - renderAt.Y, MaxHeight);
// There is no space below, lets see if can popup on top
- if (height < Suggestions.Count && HostControl.Bounds.Height - renderAt.Y >= height)
+ if (height < Suggestions.Count && HostControl.Viewport.Height - renderAt.Y >= height)
{
// Verifies that the upper limit available is greater than the lower limit
- if (renderAt.Y > HostControl.Bounds.Height - renderAt.Y)
+ if (renderAt.Y > HostControl.Viewport.Height - renderAt.Y)
{
renderAt.Y = Math.Max (renderAt.Y - Math.Min (Suggestions.Count + 1, MaxHeight + 1), 0);
height = Math.Min (Math.Min (Suggestions.Count, MaxHeight), LastPopupPos.Value.Y - 1);
@@ -287,13 +287,13 @@ public override void RenderOverlay (Point renderAt)
else
{
// don't overspill vertically
- height = Math.Min (Math.Min (top.Bounds.Height - HostControl.Frame.Bottom, MaxHeight), Suggestions.Count);
+ height = Math.Min (Math.Min (top.Viewport.Height - HostControl.Frame.Bottom, MaxHeight), Suggestions.Count);
// There is no space below, lets see if can popup on top
if (height < Suggestions.Count && HostControl.Frame.Y - top.Frame.Y >= height)
{
// Verifies that the upper limit available is greater than the lower limit
- if (HostControl.Frame.Y > top.Bounds.Height - HostControl.Frame.Y)
+ if (HostControl.Frame.Y > top.Viewport.Height - HostControl.Frame.Y)
{
renderAt.Y = Math.Max (HostControl.Frame.Y - Math.Min (Suggestions.Count, MaxHeight), 0);
height = Math.Min (Math.Min (Suggestions.Count, MaxHeight), HostControl.Frame.Y);
@@ -323,34 +323,34 @@ public override void RenderOverlay (Point renderAt)
if (PopupInsideContainer)
{
// don't overspill horizontally, let's see if can be displayed on the left
- if (width > HostControl.Bounds.Width - renderAt.X)
+ if (width > HostControl.Viewport.Width - renderAt.X)
{
// Verifies that the left limit available is greater than the right limit
- if (renderAt.X > HostControl.Bounds.Width - renderAt.X)
+ if (renderAt.X > HostControl.Viewport.Width - renderAt.X)
{
renderAt.X -= Math.Min (width, LastPopupPos.Value.X);
width = Math.Min (width, LastPopupPos.Value.X);
}
else
{
- width = Math.Min (width, HostControl.Bounds.Width - renderAt.X);
+ width = Math.Min (width, HostControl.Viewport.Width - renderAt.X);
}
}
}
else
{
// don't overspill horizontally, let's see if can be displayed on the left
- if (width > top.Bounds.Width - (renderAt.X + HostControl.Frame.X))
+ if (width > top.Viewport.Width - (renderAt.X + HostControl.Frame.X))
{
// Verifies that the left limit available is greater than the right limit
- if (renderAt.X + HostControl.Frame.X > top.Bounds.Width - (renderAt.X + HostControl.Frame.X))
+ if (renderAt.X + HostControl.Frame.X > top.Viewport.Width - (renderAt.X + HostControl.Frame.X))
{
renderAt.X -= Math.Min (width, LastPopupPos.Value.X);
width = Math.Min (width, LastPopupPos.Value.X);
}
else
{
- width = Math.Min (width, top.Bounds.Width - renderAt.X);
+ width = Math.Min (width, top.Viewport.Width - renderAt.X);
}
}
}
diff --git a/Terminal.Gui/Text/TextFormatter.cs b/Terminal.Gui/Text/TextFormatter.cs
index 6168c53f01..db13b5930b 100644
--- a/Terminal.Gui/Text/TextFormatter.cs
+++ b/Terminal.Gui/Text/TextFormatter.cs
@@ -30,7 +30,7 @@ public TextAlignment Alignment
/// Gets or sets whether the should be automatically changed to fit the .
///
- /// Used by to resize the view's to fit .
+ /// Used by to resize the view's to fit .
///
/// AutoSize is ignored if and
/// are used.
@@ -73,8 +73,8 @@ public TextDirection Direction
}
///
- /// Determines if the bounds width will be used or only the text width will be used,
- /// If all the bounds area will be filled with whitespaces and the same background color
+ /// Determines if the viewport width will be used or only the text width will be used,
+ /// If all the viewport area will be filled with whitespaces and the same background color
/// showing a perfect rectangle.
///
public bool FillRemaining { get; set; }
@@ -202,17 +202,17 @@ public bool WordWrap
/// Causes the text to be formatted (references ). Sets to
/// false.
///
- /// Specifies the screen-relative location and maximum size for drawing the text.
+ /// Specifies the screen-relative location and maximum size for drawing the text.
/// The color to use for all text except the hotkey
/// The color to use to draw the hotkey
- /// Specifies the screen-relative location and maximum container size.
+ /// Specifies the screen-relative location and maximum container size.
/// The console driver currently used by the application.
///
public void Draw (
- Rectangle bounds,
+ Rectangle screen,
Attribute normalColor,
Attribute hotColor,
- Rectangle containerBounds = default,
+ Rectangle maximum = default,
ConsoleDriver driver = null
)
{
@@ -240,46 +240,46 @@ public void Draw (
}
bool isVertical = IsVerticalDirection (Direction);
- Rectangle maxBounds = bounds;
+ Rectangle maxScreen = screen;
if (driver is { })
{
// INTENT: What, exactly, is the intent of this?
- maxBounds = containerBounds == default (Rectangle)
- ? bounds
+ maxScreen = maximum == default (Rectangle)
+ ? screen
: new (
- Math.Max (containerBounds.X, bounds.X),
- Math.Max (containerBounds.Y, bounds.Y),
+ Math.Max (maximum.X, screen.X),
+ Math.Max (maximum.Y, screen.Y),
Math.Max (
- Math.Min (containerBounds.Width, containerBounds.Right - bounds.Left),
+ Math.Min (maximum.Width, maximum.Right - screen.Left),
0
),
Math.Max (
Math.Min (
- containerBounds.Height,
- containerBounds.Bottom - bounds.Top
+ maximum.Height,
+ maximum.Bottom - screen.Top
),
0
)
);
}
- if (maxBounds.Width == 0 || maxBounds.Height == 0)
+ if (maxScreen.Width == 0 || maxScreen.Height == 0)
{
return;
}
- int lineOffset = !isVertical && bounds.Y < 0 ? Math.Abs (bounds.Y) : 0;
+ int lineOffset = !isVertical && screen.Y < 0 ? Math.Abs (screen.Y) : 0;
for (int line = lineOffset; line < linesFormatted.Count; line++)
{
- if ((isVertical && line > bounds.Width) || (!isVertical && line > bounds.Height))
+ if ((isVertical && line > screen.Width) || (!isVertical && line > screen.Height))
{
continue;
}
- if ((isVertical && line >= maxBounds.Left + maxBounds.Width)
- || (!isVertical && line >= maxBounds.Top + maxBounds.Height + lineOffset))
+ if ((isVertical && line >= maxScreen.Left + maxScreen.Width)
+ || (!isVertical && line >= maxScreen.Top + maxScreen.Height + lineOffset))
{
break;
}
@@ -305,14 +305,14 @@ public void Draw (
if (isVertical)
{
int runesWidth = GetWidestLineLength (linesFormatted, line, TabWidth);
- x = bounds.Right - runesWidth;
- CursorPosition = bounds.Width - runesWidth + (_hotKeyPos > -1 ? _hotKeyPos : 0);
+ x = screen.Right - runesWidth;
+ CursorPosition = screen.Width - runesWidth + (_hotKeyPos > -1 ? _hotKeyPos : 0);
}
else
{
int runesWidth = StringExtensions.ToString (runes).GetColumns ();
- x = bounds.Right - runesWidth;
- CursorPosition = bounds.Width - runesWidth + (_hotKeyPos > -1 ? _hotKeyPos : 0);
+ x = screen.Right - runesWidth;
+ CursorPosition = screen.Width - runesWidth + (_hotKeyPos > -1 ? _hotKeyPos : 0);
}
}
else if (Alignment is TextAlignment.Left or TextAlignment.Justified)
@@ -322,11 +322,11 @@ public void Draw (
int runesWidth = line > 0
? GetWidestLineLength (linesFormatted, 0, line, TabWidth)
: 0;
- x = bounds.Left + runesWidth;
+ x = screen.Left + runesWidth;
}
else
{
- x = bounds.Left;
+ x = screen.Left;
}
CursorPosition = _hotKeyPos > -1 ? _hotKeyPos : 0;
@@ -336,16 +336,16 @@ public void Draw (
if (isVertical)
{
int runesWidth = GetWidestLineLength (linesFormatted, line, TabWidth);
- x = bounds.Left + line + (bounds.Width - runesWidth) / 2;
+ x = screen.Left + line + (screen.Width - runesWidth) / 2;
- CursorPosition = (bounds.Width - runesWidth) / 2 + (_hotKeyPos > -1 ? _hotKeyPos : 0);
+ CursorPosition = (screen.Width - runesWidth) / 2 + (_hotKeyPos > -1 ? _hotKeyPos : 0);
}
else
{
int runesWidth = StringExtensions.ToString (runes).GetColumns ();
- x = bounds.Left + (bounds.Width - runesWidth) / 2;
+ x = screen.Left + (screen.Width - runesWidth) / 2;
- CursorPosition = (bounds.Width - runesWidth) / 2 + (_hotKeyPos > -1 ? _hotKeyPos : 0);
+ CursorPosition = (screen.Width - runesWidth) / 2 + (_hotKeyPos > -1 ? _hotKeyPos : 0);
}
}
else
@@ -358,35 +358,35 @@ public void Draw (
{
if (isVertical)
{
- y = bounds.Bottom - runes.Length;
+ y = screen.Bottom - runes.Length;
}
else
{
- y = bounds.Bottom - linesFormatted.Count + line;
+ y = screen.Bottom - linesFormatted.Count + line;
}
}
else if (VerticalAlignment is VerticalTextAlignment.Top or VerticalTextAlignment.Justified)
{
if (isVertical)
{
- y = bounds.Top;
+ y = screen.Top;
}
else
{
- y = bounds.Top + line;
+ y = screen.Top + line;
}
}
else if (VerticalAlignment == VerticalTextAlignment.Middle)
{
if (isVertical)
{
- int s = (bounds.Height - runes.Length) / 2;
- y = bounds.Top + s;
+ int s = (screen.Height - runes.Length) / 2;
+ y = screen.Top + s;
}
else
{
- int s = (bounds.Height - linesFormatted.Count) / 2;
- y = bounds.Top + line + s;
+ int s = (screen.Height - linesFormatted.Count) / 2;
+ y = screen.Top + line + s;
}
}
else
@@ -394,9 +394,9 @@ public void Draw (
throw new ArgumentOutOfRangeException ($"{nameof (VerticalAlignment)}");
}
- int colOffset = bounds.X < 0 ? Math.Abs (bounds.X) : 0;
- int start = isVertical ? bounds.Top : bounds.Left;
- int size = isVertical ? bounds.Height : bounds.Width;
+ int colOffset = screen.X < 0 ? Math.Abs (screen.X) : 0;
+ int start = isVertical ? screen.Top : screen.Left;
+ int size = isVertical ? screen.Height : screen.Width;
int current = start + colOffset;
List lastZeroWidthPos = null;
Rune rune = default;
@@ -422,15 +422,15 @@ public void Draw (
break;
}
- if ((!isVertical && current - start > maxBounds.Left + maxBounds.Width - bounds.X + colOffset)
- || (isVertical && idx > maxBounds.Top + maxBounds.Height - bounds.Y))
+ if ((!isVertical && current - start > maxScreen.Left + maxScreen.Width - screen.X + colOffset)
+ || (isVertical && idx > maxScreen.Top + maxScreen.Height - screen.Y))
{
break;
}
}
- //if ((!isVertical && idx > maxBounds.Left + maxBounds.Width - bounds.X + colOffset)
- // || (isVertical && idx > maxBounds.Top + maxBounds.Height - bounds.Y))
+ //if ((!isVertical && idx > maxBounds.Left + maxBounds.Width - viewport.X + colOffset)
+ // || (isVertical && idx > maxBounds.Top + maxBounds.Height - viewport.Y))
// break;
diff --git a/Terminal.Gui/View/Adornment/Adornment.cs b/Terminal.Gui/View/Adornment/Adornment.cs
index 307f3cb3e1..585929e991 100644
--- a/Terminal.Gui/View/Adornment/Adornment.cs
+++ b/Terminal.Gui/View/Adornment/Adornment.cs
@@ -1,14 +1,14 @@
namespace Terminal.Gui;
///
-/// Adornments are a special form of that appear outside the :
+/// Adornments are a special form of that appear outside the :
/// , , and . They are defined using the
/// class, which specifies the thickness of the sides of a rectangle.
///
///
///
/// Each of , , and has slightly different
-/// behavior relative to , , keyboard input, and
+/// behavior relative to , , keyboard input, and
/// mouse input. Each can be customized by manipulating their Subviews.
///
///
@@ -89,7 +89,7 @@ public void OnThicknessChanged (Thickness previousThickness)
public override View SuperView
{
get => null;
- set => throw new NotImplementedException ();
+ set => throw new InvalidOperationException (@"Adornments can not be Subviews or have SuperViews. Use Parent instead.");
}
//internal override Adornment CreateAdornment (Type adornmentType)
@@ -107,10 +107,14 @@ internal override void LayoutAdornments ()
/// Gets the rectangle that describes the area of the Adornment. The Location is always (0,0).
/// The size is the size of the .
///
- public override Rectangle Bounds
+ ///
+ /// The Viewport of an Adornment cannot be modified. Attempting to set this property will throw an
+ /// .
+ ///
+ public override Rectangle Viewport
{
get => Frame with { Location = Point.Empty };
- set => throw new InvalidOperationException ("It makes no sense to set Bounds of a Thickness.");
+ set => throw new InvalidOperationException (@"The Viewport of an Adornment cannot be modified.");
}
///
@@ -123,10 +127,11 @@ public override Rectangle FrameToScreen ()
// Adornments are *Children* of a View, not SubViews. Thus View.FrameToScreen will not work.
// To get the screen-relative coordinates of an Adornment, we need get the parent's Frame
- // in screen coords, and add our Frame location to it.
- Rectangle parent = Parent.FrameToScreen ();
+ // in screen coords, ...
+ Rectangle parentScreen = Parent.FrameToScreen ();
- return new (new (parent.X + Frame.X, parent.Y + Frame.Y), Frame.Size);
+ // ...and add our Frame location to it.
+ return new (new (parentScreen.X + Frame.X, parentScreen.Y + Frame.Y), Frame.Size);
}
///
@@ -137,19 +142,21 @@ public override Rectangle FrameToScreen ()
public override bool OnDrawAdornments () { return false; }
/// Redraws the Adornments that comprise the .
- public override void OnDrawContent (Rectangle contentArea)
+ public override void OnDrawContent (Rectangle viewport)
{
if (Thickness == Thickness.Empty)
{
return;
}
- Rectangle screenBounds = BoundsToScreen (contentArea);
+ Rectangle prevClip = SetClip ();
+
+ Rectangle screen = ViewportToScreen (viewport);
Attribute normalAttr = GetNormalColor ();
Driver.SetAttribute (normalAttr);
// This just draws/clears the thickness, not the insides.
- Thickness.Draw (screenBounds, ToString ());
+ Thickness.Draw (screen, ToString ());
if (!string.IsNullOrEmpty (TextFormatter.Text))
{
@@ -160,11 +167,16 @@ public override void OnDrawContent (Rectangle contentArea)
}
}
- TextFormatter?.Draw (screenBounds, normalAttr, normalAttr, Rectangle.Empty);
+ TextFormatter?.Draw (screen, normalAttr, normalAttr, Rectangle.Empty);
if (Subviews.Count > 0)
{
- base.OnDrawContent (contentArea);
+ base.OnDrawContent (viewport);
+ }
+
+ if (Driver is { })
+ {
+ Driver.Clip = prevClip;
}
ClearLayoutNeeded ();
@@ -181,8 +193,8 @@ public override void OnDrawContent (Rectangle contentArea)
///
public override bool SuperViewRendersLineCanvas
{
- get => false; // throw new NotImplementedException ();
- set => throw new NotImplementedException ();
+ get => false;
+ set => throw new InvalidOperationException (@"Adornment can only render to their Parent or Parent's Superview.");
}
#endregion View Overrides
@@ -205,6 +217,7 @@ public override bool Contains (int x, int y)
{
return false;
}
+
Rectangle frame = Frame;
frame.Offset (Parent.Frame.Location);
@@ -227,43 +240,6 @@ public override bool Contains (int x, int y)
return base.OnMouseEnter (mouseEvent);
}
- /// Called when a mouse event occurs within the Adornment.
- ///
- ///
- /// The coordinates are relative to .
- ///
- ///
- /// A mouse click on the Adornment will cause the Parent to focus.
- ///
- ///
- /// A mouse drag on the Adornment will cause the Parent to move.
- ///
- ///
- ///
- /// , if the event was handled, otherwise.
- protected internal override bool OnMouseEvent (MouseEvent mouseEvent)
- {
- if (Parent is null)
- {
- return false;
- }
-
- var args = new MouseEventEventArgs (mouseEvent);
-
- if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked))
- {
- if (Parent.CanFocus && !Parent.HasFocus)
- {
- Parent.SetFocus ();
- Parent.SetNeedsDisplay ();
- }
-
- return OnMouseClick (args);
- }
-
- return false;
- }
-
///
protected internal override bool OnMouseLeave (MouseEvent mouseEvent)
{
diff --git a/Terminal.Gui/View/Adornment/Border.cs b/Terminal.Gui/View/Adornment/Border.cs
index cee764c568..922fa2a19f 100644
--- a/Terminal.Gui/View/Adornment/Border.cs
+++ b/Terminal.Gui/View/Adornment/Border.cs
@@ -149,14 +149,14 @@ public override ColorScheme ColorScheme
}
}
- Rectangle GetBorderBounds (Rectangle screenBounds)
+ Rectangle GetBorderRectangle (Rectangle screenRect)
{
return new (
- screenBounds.X + Math.Max (0, Thickness.Left - 1),
- screenBounds.Y + Math.Max (0, Thickness.Top - 1),
+ screenRect.X + Math.Max (0, Thickness.Left - 1),
+ screenRect.Y + Math.Max (0, Thickness.Top - 1),
Math.Max (
0,
- screenBounds.Width
+ screenRect.Width
- Math.Max (
0,
Math.Max (0, Thickness.Left - 1)
@@ -165,7 +165,7 @@ Rectangle GetBorderBounds (Rectangle screenBounds)
),
Math.Max (
0,
- screenBounds.Height
+ screenRect.Height
- Math.Max (
0,
Math.Max (0, Thickness.Top - 1)
@@ -204,6 +204,7 @@ private void Border_Highlight (object sender, HighlightEventArgs e)
{
if (!Parent.Arrangement.HasFlag (ViewArrangement.Movable))
{
+ e.Cancel = true;
return;
}
@@ -300,7 +301,7 @@ protected internal override bool OnMouseEvent (MouseEvent mouseEvent)
_dragPosition = new Point (mouseEvent.X, mouseEvent.Y);
- Point parentLoc = Parent.SuperView?.ScreenToBounds (mouseEvent.ScreenPosition.X, mouseEvent.ScreenPosition.Y) ?? mouseEvent.ScreenPosition;
+ Point parentLoc = Parent.SuperView?.ScreenToViewport (mouseEvent.ScreenPosition.X, mouseEvent.ScreenPosition.Y) ?? mouseEvent.ScreenPosition;
GetLocationEnsuringFullVisibility (
Parent,
@@ -360,9 +361,9 @@ private void Application_UnGrabbingMouse (object sender, GrabMouseEventArgs e)
#endregion Mouse Support
///
- public override void OnDrawContent (Rectangle contentArea)
+ public override void OnDrawContent (Rectangle viewport)
{
- base.OnDrawContent (contentArea);
+ base.OnDrawContent (viewport);
if (Thickness == Thickness.Empty)
{
@@ -370,7 +371,7 @@ public override void OnDrawContent (Rectangle contentArea)
}
//Driver.SetAttribute (Colors.ColorSchemes ["Error"].Normal);
- Rectangle screenBounds = BoundsToScreen (contentArea);
+ Rectangle screenBounds = ViewportToScreen (viewport);
//OnDrawSubviews (bounds);
@@ -381,7 +382,7 @@ public override void OnDrawContent (Rectangle contentArea)
// ...thickness extends outward (border/title is always as far in as possible)
// PERF: How about a call to Rectangle.Offset?
- var borderBounds = GetBorderBounds (screenBounds);
+ var borderBounds = GetBorderRectangle (screenBounds);
int topTitleLineY = borderBounds.Y;
int titleY = borderBounds.Y;
var titleBarsLength = 0; // the little vertical thingies
@@ -432,10 +433,17 @@ public override void OnDrawContent (Rectangle contentArea)
if (canDrawBorder && Thickness.Top > 0 && maxTitleWidth > 0 && !string.IsNullOrEmpty (Parent?.Title))
{
+ var focus = Parent.GetNormalColor();
+ if (Parent.SuperView is { } && Parent.SuperView?.Subviews!.Count (s => s.CanFocus) > 1)
+ {
+ // Only use focus color if there are multiple focusable views
+ focus = Parent.GetFocusColor() ;
+ }
+
Parent.TitleTextFormatter.Draw (
new (borderBounds.X + 2, titleY, maxTitleWidth, 1),
- Parent.HasFocus ? Parent.GetFocusColor () : Parent.GetNormalColor (),
- Parent.HasFocus ? Parent.GetFocusColor () : Parent.GetHotNormalColor ());
+ Parent.HasFocus ? focus : Parent.GetNormalColor (),
+ Parent.HasFocus ? focus : Parent.GetHotNormalColor ());
}
if (canDrawBorder && LineStyle != LineStyle.None)
@@ -641,7 +649,5 @@ public override void OnDrawContent (Rectangle contentArea)
}
}
}
-
- //base.OnDrawContent (contentArea);
}
}
diff --git a/Terminal.Gui/View/Adornment/Padding.cs b/Terminal.Gui/View/Adornment/Padding.cs
index d9d373de4d..f979dcf903 100644
--- a/Terminal.Gui/View/Adornment/Padding.cs
+++ b/Terminal.Gui/View/Adornment/Padding.cs
@@ -42,7 +42,7 @@ public override ColorScheme ColorScheme
/// Called when a mouse event occurs within the Padding.
///
///
- /// The coordinates are relative to .
+ /// The coordinates are relative to .
///
///
/// A mouse click on the Padding will cause the Parent to focus.
diff --git a/Terminal.Gui/View/Layout/ViewLayout.cs b/Terminal.Gui/View/Layout/ViewLayout.cs
index dcfce11103..f593d93d2b 100644
--- a/Terminal.Gui/View/Layout/ViewLayout.cs
+++ b/Terminal.Gui/View/Layout/ViewLayout.cs
@@ -1,4 +1,5 @@
using System.Diagnostics;
+using System.IO.Compression;
namespace Terminal.Gui;
@@ -42,18 +43,18 @@ public partial class View
/// Gets or sets the absolute location and dimension of the view.
///
/// The rectangle describing absolute location and dimension of the view, in coordinates relative to the
- /// 's .
+ /// 's Content, which is bound by .
///
///
- /// Frame is relative to the 's .
+ /// Frame is relative to the 's Content, which is bound by .
///
/// Setting Frame will set , , , and to the
/// values of the corresponding properties of the parameter.
+ /// This causes to be .
///
- /// This causes to be .
///
/// Altering the Frame will eventually (when the view hierarchy is next laid out via see
- /// cref="LayoutSubviews"/>) cause and
+ /// cref="LayoutSubviews"/>) cause and
///
/// methods to be called.
///
@@ -63,7 +64,12 @@ public Rectangle Frame
get => _frame;
set
{
- _frame = value with { Width = Math.Max (value.Width, 0), Height = Math.Max (value.Height, 0) };
+ if (_frame == value)
+ {
+ return;
+ }
+
+ SetFrame (value with { Width = Math.Max (value.Width, 0), Height = Math.Max (value.Height, 0) });
// If Frame gets set, by definition, the View is now LayoutStyle.Absolute, so
// set all Pos/Dim to Absolute values.
@@ -73,62 +79,83 @@ public Rectangle Frame
_height = _frame.Height;
// TODO: Figure out if the below can be optimized.
- if (IsInitialized /*|| LayoutStyle == LayoutStyle.Absolute*/)
+ if (IsInitialized)
{
- LayoutAdornments ();
- SetTextFormatterSize ();
- SetNeedsLayout ();
- SetNeedsDisplay ();
+ OnResizeNeeded ();
}
}
}
+ private void SetFrame (Rectangle frame)
+ {
+ Rectangle oldViewport = Rectangle.Empty;
+ if (IsInitialized)
+ {
+ oldViewport = Viewport;
+ }
+ // This is the only place where _frame should be set directly. Use Frame = or SetFrame instead.
+ _frame = frame;
+
+ OnViewportChanged (new (IsInitialized ? Viewport : Rectangle.Empty, oldViewport));
+ }
+
/// Gets the with a screen-relative location.
/// The location and size of the view in screen-relative coordinates.
public virtual Rectangle FrameToScreen ()
{
- Rectangle ret = Frame;
- View super = SuperView;
+ Rectangle screen = Frame;
+ View current = SuperView;
- while (super is { })
+ while (current is { })
{
- if (super is Adornment adornment)
+ if (current is Adornment adornment)
{
// Adornments don't have SuperViews; use Adornment.FrameToScreen override
- ret = adornment.FrameToScreen ();
- ret.Offset (Frame.X, Frame.Y);
+ // which will give us the screen coordinates of the parent
+
+ var parentScreen = adornment.FrameToScreen ();
+
+ // Now add our Frame location
+ parentScreen.Offset (screen.X, screen.Y);
- return ret;
+ return parentScreen;
}
- Point boundsOffset = super.GetBoundsOffset ();
- boundsOffset.Offset(super.Frame.X, super.Frame.Y);
- ret.X += boundsOffset.X;
- ret.Y += boundsOffset.Y;
- super = super.SuperView;
+ Point viewportOffset = current.GetViewportOffsetFromFrame ();
+ viewportOffset.Offset (current.Frame.X - current.Viewport.X, current.Frame.Y - current.Viewport.Y);
+ screen.X += viewportOffset.X;
+ screen.Y += viewportOffset.Y;
+ current = current.SuperView;
}
- return ret;
+ return screen;
}
///
/// Converts a screen-relative coordinate to a Frame-relative coordinate. Frame-relative means relative to the
- /// View's 's .
+ /// View's 's .
///
- /// The coordinate relative to the 's .
+ /// The coordinate relative to the 's .
/// Screen-relative column.
/// Screen-relative row.
public virtual Point ScreenToFrame (int x, int y)
{
- Point superViewBoundsOffset = SuperView?.GetBoundsOffset () ?? Point.Empty;
if (SuperView is null)
{
- superViewBoundsOffset.Offset (x - Frame.X, y - Frame.Y);
- return superViewBoundsOffset;
+ return new Point (x - Frame.X, y - Frame.Y);
}
- var frame = SuperView.ScreenToFrame (x - superViewBoundsOffset.X, y - superViewBoundsOffset.Y);
- frame.Offset (-Frame.X, -Frame.Y);
+ Point superViewViewportOffset = SuperView.GetViewportOffsetFromFrame ();
+ superViewViewportOffset.X -= SuperView.Viewport.X;
+ superViewViewportOffset.Y -= SuperView.Viewport.Y;
+
+ x -= superViewViewportOffset.X;
+ y -= superViewViewportOffset.Y;
+
+ Point frame = SuperView.ScreenToFrame (x, y);
+ frame.X -= Frame.X;
+ frame.Y -= Frame.Y;
+
return frame;
}
@@ -138,13 +165,16 @@ public virtual Point ScreenToFrame (int x, int y)
/// The object representing the X position.
///
///
+ /// The position is relative to the 's Content, which is bound by .
+ ///
+ ///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
- /// initialized ( is true) and has been
+ /// initialized ( is true) and has been
/// called.
///
///
/// Changing this property will eventually (when the view is next drawn) cause the
- /// and methods to be called.
+ /// and methods to be called.
///
///
/// Changing this property will cause to be updated. If the new value is not of type
@@ -157,7 +187,13 @@ public Pos X
get => VerifyIsInitialized (_x, nameof (X));
set
{
+ if (Equals (_x, value))
+ {
+ return;
+ }
+
_x = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (X)} cannot be null");
+
OnResizeNeeded ();
}
}
@@ -168,13 +204,16 @@ public Pos X
/// The object representing the Y position.
///
///
+ /// The position is relative to the 's Content, which is bound by .
+ ///
+ ///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
- /// initialized ( is true) and has been
+ /// initialized ( is true) and has been
/// called.
///
///
/// Changing this property will eventually (when the view is next drawn) cause the
- /// and methods to be called.
+ /// and methods to be called.
///
///
/// Changing this property will cause to be updated. If the new value is not of type
@@ -187,6 +226,11 @@ public Pos Y
get => VerifyIsInitialized (_y, nameof (Y));
set
{
+ if (Equals (_y, value))
+ {
+ return;
+ }
+
_y = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Y)} cannot be null");
OnResizeNeeded ();
}
@@ -198,13 +242,16 @@ public Pos Y
/// The object representing the height of the view (the number of rows).
///
///
+ /// The dimension is relative to the 's Content, which is bound by .
+ ///
+ ///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has
- /// been initialized ( is true) and has been
+ /// been initialized ( is true) and has been
/// called.
///
///
/// Changing this property will eventually (when the view is next drawn) cause the
- /// and methods to be called.
+ /// and methods to be called.
///
///
/// Changing this property will cause to be updated. If the new value is not of type
@@ -217,6 +264,11 @@ public Dim Height
get => VerifyIsInitialized (_height, nameof (Height));
set
{
+ if (Equals (_height, value))
+ {
+ return;
+ }
+
_height = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Height)} cannot be null");
if (AutoSize)
@@ -247,13 +299,16 @@ public Dim Height
/// The object representing the width of the view (the number of columns).
///
///
+ /// The dimension is relative to the 's Content, which is bound by .
+ ///
+ ///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has
- /// been initialized ( is true) and has been
+ /// been initialized ( is true) and has been
/// called.
///
///
/// Changing this property will eventually (when the view is next drawn) cause the
- /// and methods to be called.
+ /// and methods to be called.
///
///
/// Changing this property will cause to be updated. If the new value is not of type
@@ -266,6 +321,11 @@ public Dim Width
get => VerifyIsInitialized (_width, nameof (Width));
set
{
+ if (Equals (_width, value))
+ {
+ return;
+ }
+
_width = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Width)} cannot be null");
if (AutoSize)
@@ -288,123 +348,13 @@ public Dim Width
#endregion Frame
- #region Bounds
-
- ///
- /// The bounds represent the View-relative rectangle used for this view; the area inside the view where
- /// subviews and content are presented.
- ///
- /// The rectangle describing the location and size of the area where the views' subviews and content are drawn.
- ///
- ///
- /// If is the value of Bounds is indeterminate until
- /// the view has been initialized ( is true) and has been
- /// called.
- ///
- ///
- /// Updates to the Bounds updates , and has the same effect as updating the
- /// .
- ///
- ///
- /// Altering the Bounds will eventually (when the view is next laid out) cause the
- /// and methods to be called.
- ///
- ///
- /// Because coordinates are relative to the upper-left corner of the , the
- /// coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to
- /// obtain the size of the area of the view for tasks such as drawing the view's contents.
- ///
- ///
- public virtual Rectangle Bounds
- {
- get
- {
-#if DEBUG
- if (LayoutStyle == LayoutStyle.Computed && !IsInitialized)
- {
- Debug.WriteLine (
- $"WARNING: Bounds is being accessed before the View has been initialized. This is likely a bug in {this}"
- );
- }
-#endif // DEBUG
-
- if (Margin is null || Border is null || Padding is null)
- {
- // CreateAdornments has not been called yet.
- return Rectangle.Empty with { Size = Frame.Size };
- }
-
- Thickness totalThickness = GetAdornmentsThickness ();
-
- return Rectangle.Empty with
- {
- Size = new (
- Math.Max (0, Frame.Size.Width - totalThickness.Horizontal),
- Math.Max (0, Frame.Size.Height - totalThickness.Vertical))
- };
- }
- set
- {
- // TODO: Should we enforce Bounds.X/Y == 0? The code currently ignores value.X/Y which is
- // TODO: correct behavior, but is silent. Perhaps an exception?
-#if DEBUG
- if (value.Location != Point.Empty)
- {
- Debug.WriteLine (
- $"WARNING: Bounds.Location must always be 0,0. Location ({value.Location}) is ignored. {this}"
- );
- }
-#endif // DEBUG
- Thickness totalThickness = GetAdornmentsThickness ();
-
- Frame = Frame with
- {
- Size = new (
- value.Size.Width + totalThickness.Horizontal,
- value.Size.Height + totalThickness.Vertical)
- };
- }
- }
-
- /// Converts a -relative rectangle to a screen-relative rectangle.
- public Rectangle BoundsToScreen (in Rectangle bounds)
- {
- // Translate bounds to Frame (our SuperView's Bounds-relative coordinates)
- Rectangle screen = FrameToScreen ();
- Point boundsOffset = GetBoundsOffset ();
- screen.Offset (boundsOffset.X + bounds.X, boundsOffset.Y + bounds.Y);
-
- return new (screen.Location, bounds.Size);
- }
-
- /// Converts a screen-relative coordinate to a bounds-relative coordinate.
- /// The coordinate relative to this view's .
- /// Screen-relative column.
- /// Screen-relative row.
- public Point ScreenToBounds (int x, int y)
- {
- Point boundsOffset = GetBoundsOffset ();
- Point screen = ScreenToFrame (x, y);
- screen.Offset (-boundsOffset.X, -boundsOffset.Y);
-
- return screen;
- }
-
- ///
- /// Helper to get the X and Y offset of the Bounds from the Frame. This is the sum of the Left and Top properties
- /// of , and .
- ///
- public Point GetBoundsOffset () { return Padding is null ? Point.Empty : Padding.Thickness.GetInside (Padding.Frame).Location; }
-
- #endregion Bounds
-
#region AutoSize
private bool _autoSize;
///
/// Gets or sets a flag that determines whether the View will be automatically resized to fit the
- /// within .
+ /// within .
///
/// The default is . Set to to turn on AutoSize. If
/// then and will be used if can
@@ -462,7 +412,7 @@ private bool ResizeView (bool autoSize)
if (ValidatePosDim)
{
// BUGBUG: This ain't right, obviously. We need to figure out how to handle this.
- boundsChanged = ResizeBoundsToFit (newFrameSize);
+ boundsChanged = ResizeViewportToFit (newFrameSize);
}
else
{
@@ -577,35 +527,35 @@ internal bool TrySetWidth (int desiredWidth, out int resultWidth)
/// Resizes the View to fit the specified size. Factors in the HotKey.
/// ResizeBoundsToFit can only be called when AutoSize is true (or being set to true).
///
- /// whether the Bounds was changed or not
- private bool ResizeBoundsToFit (Size size)
+ /// whether the Viewport was changed or not
+ private bool ResizeViewportToFit (Size size)
{
//if (AutoSize == false) {
- // throw new InvalidOperationException ("ResizeBoundsToFit can only be called when AutoSize is true");
+ // throw new InvalidOperationException ("ResizeViewportToFit can only be called when AutoSize is true");
//}
- var boundsChanged = false;
+ var changed = false;
bool canSizeW = TrySetWidth (size.Width - GetHotKeySpecifierLength (), out int rW);
bool canSizeH = TrySetHeight (size.Height - GetHotKeySpecifierLength (false), out int rH);
if (canSizeW)
{
- boundsChanged = true;
+ changed = true;
_width = rW;
}
if (canSizeH)
{
- boundsChanged = true;
+ changed = true;
_height = rH;
}
- if (boundsChanged)
+ if (changed)
{
- Bounds = new (Bounds.X, Bounds.Y, canSizeW ? rW : Bounds.Width, canSizeH ? rH : Bounds.Height);
+ Viewport = new (Viewport.X, Viewport.Y, canSizeW ? rW : Viewport.Width, canSizeH ? rH : Viewport.Height);
}
- return boundsChanged;
+ return changed;
}
#endregion AutoSize
@@ -651,25 +601,20 @@ public LayoutStyle LayoutStyle
#endregion Layout Engine
- internal bool LayoutNeeded { get; private set; } = true;
-
///
- /// Indicates whether the specified SuperView-relative coordinates are within the View's .
+ /// Indicates whether the specified SuperView-relative coordinates are within the View's .
///
/// SuperView-relative X coordinate.
/// SuperView-relative Y coordinate.
/// if the specified SuperView-relative coordinates are within the View.
- public virtual bool Contains (int x, int y)
- {
- return Frame.Contains (x, y);
- }
+ public virtual bool Contains (int x, int y) { return Frame.Contains (x, y); }
#nullable enable
/// Finds the first Subview of that is visible at the provided location.
///
- ///
- /// Used to determine what view the mouse is over.
- ///
+ ///
+ /// Used to determine what view the mouse is over.
+ ///
///
/// The view to scope the search by.
/// .SuperView-relative X coordinate.
@@ -682,57 +627,66 @@ public virtual bool Contains (int x, int y)
// CONCURRENCY: This method is not thread-safe. Undefined behavior and likely program crashes are exposed by unsynchronized access to InternalSubviews.
internal static View? FindDeepestView (View? start, int x, int y)
{
- if (start is null || !start.Visible || !start.Contains (x, y))
+ while (start is { Visible: true } && start.Contains (x, y))
{
- return null;
- }
-
- Adornment? found = null;
+ Adornment? found = null;
- if (start.Margin.Contains (x, y))
- {
- found = start.Margin;
- }
- else if (start.Border.Contains (x, y))
- {
- found = start.Border;
- }
- else if (start.Padding.Contains (x, y))
- {
- found = start.Padding;
- }
+ if (start.Margin.Contains (x, y))
+ {
+ found = start.Margin;
+ }
+ else if (start.Border.Contains (x, y))
+ {
+ found = start.Border;
+ }
+ else if (start.Padding.Contains (x, y))
+ {
+ found = start.Padding;
+ }
- Point boundsOffset = start.GetBoundsOffset ();
+ Point viewportOffset = start.GetViewportOffsetFromFrame ();
- if (found is { })
- {
- start = found;
- boundsOffset = found.Parent.Frame.Location;
- }
+ if (found is { })
+ {
+ start = found;
+ viewportOffset = found.Parent.Frame.Location;
+ }
- if (start.InternalSubviews is { Count: > 0 })
- {
- int startOffsetX = x - (start.Frame.X + boundsOffset.X);
- int startOffsetY = y - (start.Frame.Y + boundsOffset.Y);
+ int startOffsetX = x - (start.Frame.X + viewportOffset.X);
+ int startOffsetY = y - (start.Frame.Y + viewportOffset.Y);
+ View? subview = null;
for (int i = start.InternalSubviews.Count - 1; i >= 0; i--)
{
- View nextStart = start.InternalSubviews [i];
-
- if (nextStart.Visible && nextStart.Contains (startOffsetX, startOffsetY))
+ if (start.InternalSubviews [i].Visible
+ && start.InternalSubviews [i].Contains (startOffsetX + start.Viewport.X, startOffsetY + start.Viewport.Y))
{
- // TODO: Remove recursion
- return FindDeepestView (nextStart, startOffsetX, startOffsetY) ?? nextStart;
+ subview = start.InternalSubviews [i];
+ x = startOffsetX + start.Viewport.X;
+ y = startOffsetY + start.Viewport.Y;
+
+ // start is the deepest subview under the mouse; stop searching the subviews
+ break;
}
}
+
+ if (subview is null)
+ {
+ // No subview was found that's under the mouse, so we're done
+ return start;
+ }
+
+ // We found a subview of start that's under the mouse, continue...
+ start = subview;
}
- return start;
+ return null;
}
+
#nullable restore
///
- /// Gets a new location of the that is within the Bounds of the 's
+ /// Gets a new location of the that is within the Viewport of the 's
/// (e.g. for dragging a Window). The `out` parameters are the new X and Y coordinates.
///
///
@@ -761,6 +715,7 @@ out StatusBar statusBar
{
int maxDimension;
View superView;
+ statusBar = null;
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
@@ -769,8 +724,8 @@ out StatusBar statusBar
}
else
{
- // Use the SuperView's Bounds, not Frame
- maxDimension = viewToMove.SuperView.Bounds.Width;
+ // Use the SuperView's Viewport, not Frame
+ maxDimension = viewToMove.SuperView.Viewport.Width;
superView = viewToMove.SuperView;
}
@@ -795,7 +750,8 @@ out StatusBar statusBar
}
//System.Diagnostics.Debug.WriteLine ($"nx:{nx}, rWidth:{rWidth}");
- bool menuVisible, statusVisible;
+ bool menuVisible = false;
+ bool statusVisible = false;
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
@@ -805,12 +761,15 @@ out StatusBar statusBar
{
View t = viewToMove.SuperView;
- while (t is not Toplevel)
+ while (t is { } and not Toplevel)
{
t = t.SuperView;
}
- menuVisible = ((Toplevel)t).MenuBar?.Visible == true;
+ if (t is Toplevel toplevel)
+ {
+ menuVisible = toplevel.MenuBar?.Visible == true;
+ }
}
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
@@ -833,13 +792,16 @@ out StatusBar statusBar
{
View t = viewToMove.SuperView;
- while (t is not Toplevel)
+ while (t is { } and not Toplevel)
{
t = t.SuperView;
}
- statusVisible = ((Toplevel)t).StatusBar?.Visible == true;
- statusBar = ((Toplevel)t).StatusBar;
+ if (t is Toplevel toplevel)
+ {
+ statusVisible = toplevel.StatusBar?.Visible == true;
+ statusBar = toplevel.StatusBar;
+ }
}
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
@@ -848,7 +810,7 @@ out StatusBar statusBar
}
else
{
- maxDimension = statusVisible ? viewToMove.SuperView.Frame.Height - 1 : viewToMove.SuperView.Frame.Height;
+ maxDimension = statusVisible ? viewToMove.SuperView.Viewport.Height - 1 : viewToMove.SuperView.Viewport.Height;
}
if (superView.Margin is { } && superView == viewToMove.SuperView)
@@ -916,8 +878,7 @@ public virtual void LayoutSubviews ()
LayoutAdornments ();
- Rectangle oldBounds = Bounds;
- OnLayoutStarted (new () { OldBounds = oldBounds });
+ OnLayoutStarted (new (ContentSize));
SetTextFormatterSize ();
@@ -929,7 +890,7 @@ public virtual void LayoutSubviews ()
foreach (View v in ordered)
{
- LayoutSubview (v, new (GetBoundsOffset (), Bounds.Size));
+ LayoutSubview (v, ContentSize);
}
// If the 'to' is rooted to 'from' and the layoutstyle is Computed it's a special-case.
@@ -938,13 +899,19 @@ public virtual void LayoutSubviews ()
{
foreach ((View from, View to) in edges)
{
- LayoutSubview (to, from.Frame);
+ LayoutSubview (to, from.ContentSize);
}
}
LayoutNeeded = false;
- OnLayoutComplete (new () { OldBounds = oldBounds });
+ OnLayoutComplete (new (ContentSize));
+ }
+ private void LayoutSubview (View v, Size contentSize)
+ {
+ v.SetRelativeLayout (contentSize);
+ v.LayoutSubviews ();
+ v.LayoutNeeded = false;
}
/// Indicates that the view does not need to be laid out.
@@ -969,19 +936,19 @@ public virtual void LayoutSubviews ()
///
///
/// Determines the relative bounds of the and its s, and then calls
- /// to update the view.
+ /// to update the view.
///
///
internal void OnResizeNeeded ()
{
// TODO: Identify a real-world use-case where this API should be virtual.
// TODO: Until then leave it `internal` and non-virtual
- // First try SuperView.Bounds, then Application.Top, then Driver.Bounds.
+ // First try SuperView.Viewport, then Application.Top, then Driver.Viewport.
// Finally, if none of those are valid, use int.MaxValue (for Unit tests).
- Rectangle relativeBounds = SuperView is { IsInitialized: true } ? SuperView.Bounds :
- Application.Top is { } && Application.Top != this && Application.Top.IsInitialized ? Application.Top.Bounds :
- Application.Driver?.Bounds ?? new Rectangle (0, 0, int.MaxValue, int.MaxValue);
- SetRelativeLayout (relativeBounds);
+ Size contentSize = SuperView is { IsInitialized: true } ? SuperView.ContentSize :
+ Application.Top is { } && Application.Top != this && Application.Top.IsInitialized ? Application.Top.ContentSize :
+ Application.Driver?.Screen.Size ?? new (int.MaxValue, int.MaxValue);
+ SetRelativeLayout (contentSize);
// TODO: Determine what, if any of the below is actually needed here.
if (IsInitialized)
@@ -997,6 +964,7 @@ internal void OnResizeNeeded ()
SetNeedsLayout ();
}
}
+ internal bool LayoutNeeded { get; private set; } = true;
///
/// Sets the internal flag for this View and all of it's subviews and it's SuperView.
@@ -1021,15 +989,22 @@ internal void SetNeedsLayout ()
}
///
- /// Applies the view's position (, ) and dimension (, and
- /// ) to , given a rectangle describing the SuperView's Bounds (nominally the
- /// same as this.SuperView.Bounds).
+ /// Adjusts given the SuperView's ContentSize (nominally the same as
+ /// this.SuperView.ContentSize)
+ /// and the position (, ) and dimension (, and
+ /// ).
///
- ///
- /// The rectangle describing the SuperView's Bounds (nominally the same as
- /// this.SuperView.Bounds).
+ ///
+ ///
+ /// If , , , or are
+ /// absolute, they will be updated to reflect the new size and position of the view. Otherwise, they
+ /// are left unchanged.
+ ///
+ ///
+ ///
+ /// The size of the SuperView's content (nominally the same as this.SuperView.ContentSize).
///
- internal void SetRelativeLayout (Rectangle superviewBounds)
+ internal void SetRelativeLayout (Size superviewContentSize)
{
Debug.Assert (_x is { });
Debug.Assert (_y is { });
@@ -1051,13 +1026,13 @@ internal void SetRelativeLayout (Rectangle superviewBounds)
// TODO: View.AutoSize stuff is removed.
// Returns the new dimension (width or height) and location (x or y) for the View given
- // the superview's Bounds
+ // the superview's Viewport
// the current Pos (View.X or View.Y)
// the current Dim (View.Width or View.Height)
// This method is called recursively if pos is Pos.PosCombine
(int newLocation, int newDimension) GetNewLocationAndDimension (
bool width,
- Rectangle superviewBounds,
+ Size superviewContentSize,
Pos pos,
Dim dim,
int autosizeDimension
@@ -1119,7 +1094,7 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
}
int newDimension, newLocation;
- int superviewDimension = width ? superviewBounds.Width : superviewBounds.Height;
+ int superviewDimension = width ? superviewContentSize.Width : superviewContentSize.Height;
// Determine new location
switch (pos)
@@ -1143,7 +1118,7 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
(left, newDimension) = GetNewLocationAndDimension (
width,
- superviewBounds,
+ superviewContentSize,
combine._left,
dim,
autosizeDimension
@@ -1151,7 +1126,7 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
(right, newDimension) = GetNewLocationAndDimension (
width,
- superviewBounds,
+ superviewContentSize,
combine._right,
dim,
autosizeDimension
@@ -1193,10 +1168,10 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
}
// horizontal/width
- (newX, newW) = GetNewLocationAndDimension (true, superviewBounds, _x, _width, autosize.Width);
+ (newX, newW) = GetNewLocationAndDimension (true, superviewContentSize, _x, _width, autosize.Width);
// vertical/height
- (newY, newH) = GetNewLocationAndDimension (false, superviewBounds, _y, _height, autosize.Height);
+ (newY, newH) = GetNewLocationAndDimension (false, superviewContentSize, _y, _height, autosize.Height);
Rectangle r = new (newX, newY, newW, newH);
@@ -1204,7 +1179,7 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
{
// Set the frame. Do NOT use `Frame` as it overwrites X, Y, Width, and Height, making
// the view LayoutStyle.Absolute.
- _frame = r;
+ SetFrame (r);
if (_x is Pos.PosAbsolute)
{
@@ -1236,7 +1211,7 @@ int GetNewDimension (Dim d, int location, int dimension, int autosize)
{
// Set the frame. Do NOT use `Frame` as it overwrites X, Y, Width, and Height, making
// the view LayoutStyle.Absolute.
- _frame = _frame with { Size = autosize };
+ SetFrame (_frame with { Size = autosize });
if (autosize.Width == 0)
{
@@ -1417,17 +1392,6 @@ internal static List TopologicalSort (
return result;
} // TopologicalSort
- private void LayoutSubview (View v, Rectangle contentArea)
- {
- //if (v.LayoutStyle == LayoutStyle.Computed) {
- v.SetRelativeLayout (contentArea);
-
- //}
-
- v.LayoutSubviews ();
- v.LayoutNeeded = false;
- }
-
#region Diagnostics
// Diagnostics to highlight when Width or Height is read before the view has been initialized
@@ -1468,4 +1432,4 @@ private Pos VerifyIsInitialized (Pos pos, string member)
public bool ValidatePosDim { get; set; }
#endregion
-}
+}
\ No newline at end of file
diff --git a/Terminal.Gui/View/View.cs b/Terminal.Gui/View/View.cs
index 07235e638b..8a04e51702 100644
--- a/Terminal.Gui/View/View.cs
+++ b/Terminal.Gui/View/View.cs
@@ -52,7 +52,7 @@ namespace Terminal.Gui;
/// To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the
/// absolute position and size or simply set ). To create a View using Computed layout use
/// a constructor that does not take a Rect parameter and set the X, Y, Width and Height properties on the view to
-/// non-absolute values. Both approaches use coordinates that are relative to the of the
+/// non-absolute values. Both approaches use coordinates that are relative to the of the
/// the View is added to.
///
///
@@ -73,7 +73,7 @@ namespace Terminal.Gui;
/// a View can be accessed with the property.
///
///
-/// To flag a region of the View's to be redrawn call
+/// To flag a region of the View's to be redrawn call
/// .
/// To flag the entire view for redraw call .
///
@@ -234,7 +234,7 @@ public virtual void EndInit ()
// TODO: Move these into ViewText.cs as EndInit_Text() to consolodate.
// TODO: Verify UpdateTextDirection really needs to be called here.
- // These calls were moved from BeginInit as they access Bounds which is indeterminate until EndInit is called.
+ // These calls were moved from BeginInit as they access Viewport which is indeterminate until EndInit is called.
UpdateTextDirection (TextDirection);
UpdateTextFormatterText ();
OnResizeNeeded ();
diff --git a/Terminal.Gui/View/ViewAdornments.cs b/Terminal.Gui/View/ViewAdornments.cs
index 55445cef82..4efd92b526 100644
--- a/Terminal.Gui/View/ViewAdornments.cs
+++ b/Terminal.Gui/View/ViewAdornments.cs
@@ -39,7 +39,7 @@ private void DisposeAdornments ()
///
/// The that enables separation of a View from other SubViews of the same
- /// SuperView. The margin offsets the from the .
+ /// SuperView. The margin offsets the from the .
///
///
///
@@ -55,7 +55,7 @@ private void DisposeAdornments ()
public Margin Margin { get; private set; }
///
- /// The that offsets the from the .
+ /// The that offsets the from the .
/// The Border provides the space for a visual border (drawn using
/// line-drawing glyphs) and the Title. The Border expands inward; in other words if `Border.Thickness.Top == 2` the
/// border and title will take up the first row and the second row will be filled with spaces.
@@ -116,7 +116,7 @@ public LineStyle BorderStyle
}
///
- /// The inside of the view that offsets the
+ /// The inside of the view that offsets the
/// from the .
///
///
@@ -151,7 +151,7 @@ internal virtual void LayoutAdornments ()
if (Margin.Frame.Size != Frame.Size)
{
- Margin._frame = Rectangle.Empty with { Size = Frame.Size };
+ Margin.SetFrame (Rectangle.Empty with { Size = Frame.Size });
Margin.X = 0;
Margin.Y = 0;
Margin.Width = Frame.Size.Width;
@@ -170,7 +170,7 @@ internal virtual void LayoutAdornments ()
if (border != Border.Frame)
{
- Border._frame = border;
+ Border.SetFrame (border);
Border.X = border.Location.X;
Border.Y = border.Location.Y;
Border.Width = border.Size.Width;
@@ -189,7 +189,7 @@ internal virtual void LayoutAdornments ()
if (padding != Padding.Frame)
{
- Padding._frame = padding;
+ Padding.SetFrame (padding);
Padding.X = padding.Location.X;
Padding.Y = padding.Location.Y;
Padding.Width = padding.Size.Width;
diff --git a/Terminal.Gui/View/ViewContent.cs b/Terminal.Gui/View/ViewContent.cs
new file mode 100644
index 0000000000..90fa3ab4a5
--- /dev/null
+++ b/Terminal.Gui/View/ViewContent.cs
@@ -0,0 +1,483 @@
+using System.Diagnostics;
+
+namespace Terminal.Gui;
+
+///
+/// Settings for how the behaves relative to the View's Content area.
+///
+[Flags]
+public enum ViewportSettings
+{
+ ///
+ /// No settings.
+ ///
+ None = 0,
+
+ ///
+ /// If set, .X can be set to negative values enabling scrolling beyond the left of
+ /// the
+ /// content area.
+ ///
+ ///
+ ///
+ /// When not set, .X is constrained to positive values.
+ ///
+ ///
+ AllowNegativeX = 1,
+
+ ///
+ /// If set, .Y can be set to negative values enabling scrolling beyond the top of the
+ /// content area.
+ ///
+ ///
+ ///
+ /// When not set, .Y is constrained to positive values.
+ ///
+ ///
+ AllowNegativeY = 2,
+
+ ///
+ /// If set, .Size can be set to negative coordinates enabling scrolling beyond the
+ /// top-left of the
+ /// content area.
+ ///
+ ///
+ ///
+ /// When not set, .Size is constrained to positive coordinates.
+ ///
+ ///
+ AllowNegativeLocation = AllowNegativeX | AllowNegativeY,
+
+ ///
+ /// If set, .X can be set values greater than
+ /// .Width enabling scrolling beyond the right
+ /// of the content area.
+ ///
+ ///
+ ///
+ /// When not set, .X is constrained to
+ /// .Width - 1.
+ /// This means the last column of the content will remain visible even if there is an attempt to scroll the
+ /// Viewport past the last column.
+ ///
+ ///
+ /// The practical effect of this is that the last column of the content will always be visible.
+ ///
+ ///
+ AllowXGreaterThanContentWidth = 4,
+
+ ///
+ /// If set, .Y can be set values greater than
+ /// .Height enabling scrolling beyond the right
+ /// of the content area.
+ ///
+ ///
+ ///
+ /// When not set, .Y is constrained to
+ /// .Height - 1.
+ /// This means the last row of the content will remain visible even if there is an attempt to scroll the Viewport
+ /// past the last row.
+ ///
+ ///
+ /// The practical effect of this is that the last row of the content will always be visible.
+ ///
+ ///
+ AllowYGreaterThanContentHeight = 8,
+
+ ///
+ /// If set, .Size can be set values greater than
+ /// enabling scrolling beyond the bottom-right
+ /// of the content area.
+ ///
+ ///
+ ///
+ /// When not set, is constrained to -1.
+ /// This means the last column and row of the content will remain visible even if there is an attempt to
+ /// scroll the Viewport past the last column or row.
+ ///
+ ///
+ AllowLocationGreaterThanContentSize = AllowXGreaterThanContentWidth | AllowYGreaterThanContentHeight,
+
+ ///
+ /// By default, clipping is applied to the . Setting this flag will cause clipping to be
+ /// applied to the visible content area.
+ ///
+ ClipContentOnly = 16,
+
+ ///
+ /// If set will clear only the portion of the content
+ /// area that is visible within the . This is useful for views that have a
+ /// content area larger than the Viewport and want the area outside the content to be visually distinct.
+ ///
+ ///
+ /// must be set for this setting to work (clipping beyond the visible area must be
+ /// disabled).
+ ///
+ ClearContentOnly = 32
+}
+
+public partial class View
+{
+ #region Content Area
+
+ private Size _contentSize;
+
+ ///
+ /// Gets or sets the size of the View's content. If not set, the value will be the same as the size of ,
+ /// and Viewport.Location will always be 0, 0.
+ ///
+ ///
+ ///
+ /// If a positive size is provided, describes the portion of the content currently visible
+ /// to the view. This enables virtual scrolling.
+ ///
+ ///
+ /// Negative sizes are not supported.
+ ///
+ ///
+ public Size ContentSize
+ {
+ get => _contentSize == Size.Empty ? Viewport.Size : _contentSize;
+ set
+ {
+ if (value.Width < 0 || value.Height < 0)
+ {
+ throw new ArgumentException (@"ContentSize cannot be negative.", nameof (value));
+ }
+
+ if (value == _contentSize)
+ {
+ return;
+ }
+
+ _contentSize = value;
+ OnContentSizeChanged (new (_contentSize));
+ }
+ }
+
+ ///
+ /// Called when changes. Invokes the event.
+ ///
+ ///
+ ///
+ protected bool? OnContentSizeChanged (SizeChangedEventArgs e)
+ {
+ ContentSizeChanged?.Invoke (this, e);
+
+ if (e.Cancel != true)
+ {
+ SetNeedsLayout ();
+ SetNeedsDisplay ();
+ }
+
+ return e.Cancel;
+ }
+
+ ///
+ /// Event raised when the changes.
+ ///
+ public event EventHandler ContentSizeChanged;
+
+ ///
+ /// Converts a Content-relative location to a Screen-relative location.
+ ///
+ /// The Content-relative location.
+ /// The Screen-relative location.
+ public Point ContentToScreen (in Point location)
+ {
+ // Subtract the ViewportOffsetFromFrame to get the Viewport-relative location.
+ Point viewportOffset = GetViewportOffsetFromFrame ();
+ Point contentRelativeToViewport = location;
+ contentRelativeToViewport.Offset (-Viewport.X, -Viewport.Y);
+
+ // Translate to Screen-Relative (our SuperView's Viewport-relative coordinates)
+ Rectangle screen = ViewportToScreen (new (contentRelativeToViewport, Size.Empty));
+
+ return screen.Location;
+ }
+
+ /// Converts a Screen-relative coordinate to a Content-relative coordinate.
+ ///
+ /// Content-relative means relative to the top-left corner of the view's Content, which is
+ /// always at 0, 0.
+ ///
+ /// The Screen-relative location.
+ /// The coordinate relative to this view's Content.
+ public Point ScreenToContent (in Point location)
+ {
+ Point viewportOffset = GetViewportOffsetFromFrame ();
+ Point screen = ScreenToFrame (location.X, location.Y);
+ screen.Offset (Viewport.X - viewportOffset.X, Viewport.Y - viewportOffset.Y);
+
+ return screen;
+ }
+
+ #endregion Content Area
+
+ #region Viewport
+
+ private ViewportSettings _viewportSettings;
+
+ ///
+ /// Gets or sets how scrolling the on the View's Content Area is handled.
+ ///
+ public ViewportSettings ViewportSettings
+ {
+ get => _viewportSettings;
+ set
+ {
+ if (_viewportSettings == value)
+ {
+ return;
+ }
+
+ _viewportSettings = value;
+
+ if (IsInitialized)
+ {
+ // Force set Viewport to cause settings to be applied as needed
+ SetViewport (Viewport);
+ }
+ }
+ }
+
+ ///
+ /// The location of the viewport into the view's content (0,0) is the top-left corner of the content. The Content
+ /// area's size
+ /// is .
+ ///
+ private Point _viewportLocation;
+
+ ///
+ /// Gets or sets the rectangle describing the portion of the View's content that is visible to the user.
+ /// The viewport Location is relative to the top-left corner of the inner rectangle of .
+ /// If the viewport Size is the same as the Location will be 0, 0.
+ ///
+ ///
+ /// The rectangle describing the location and size of the viewport into the View's virtual content, described by
+ /// .
+ ///
+ ///
+ ///
+ /// Positive values for the location indicate the visible area is offset into (down-and-right) the View's virtual
+ /// . This enables scrolling down and to the right (e.g. in a .
+ ///
+ ///
+ /// Negative values for the location indicate the visible area is offset above (up-and-left) the View's virtual
+ /// . This enables scrolling up and to the left (e.g. in an image viewer that supports zoom
+ /// where the image stays centered).
+ ///
+ ///
+ /// The property controls how scrolling is handled.
+ ///
+ ///
+ /// If is the value of Viewport is indeterminate until
+ /// the view has been initialized ( is true) and has been
+ /// called.
+ ///
+ ///
+ /// Updates to the Viewport Size updates , and has the same impact as updating the
+ /// .
+ ///
+ ///
+ /// Altering the Viewport Size will eventually (when the view is next laid out) cause the
+ /// and methods to be called.
+ ///
+ ///
+ public virtual Rectangle Viewport
+ {
+ get
+ {
+#if DEBUG
+ if (LayoutStyle == LayoutStyle.Computed && !IsInitialized)
+ {
+ Debug.WriteLine (
+ $"WARNING: Viewport is being accessed before the View has been initialized. This is likely a bug in {this}"
+ );
+ }
+#endif // DEBUG
+
+ if (Margin is null || Border is null || Padding is null)
+ {
+ // CreateAdornments has not been called yet.
+ return new (_viewportLocation, Frame.Size);
+ }
+
+ Thickness thickness = GetAdornmentsThickness ();
+
+ return new (
+ _viewportLocation,
+ new (
+ Math.Max (0, Frame.Size.Width - thickness.Horizontal),
+ Math.Max (0, Frame.Size.Height - thickness.Vertical)
+ ));
+ }
+ set => SetViewport (value);
+ }
+
+ private void SetViewport (Rectangle viewport)
+ {
+ Rectangle oldViewport = viewport;
+ ApplySettings (ref viewport);
+
+ Thickness thickness = GetAdornmentsThickness ();
+
+ Size newSize = new (
+ viewport.Size.Width + thickness.Horizontal,
+ viewport.Size.Height + thickness.Vertical);
+
+ if (newSize == Frame.Size)
+ {
+ // The change is not changing the Frame, so we don't need to update it.
+ // Just call SetNeedsLayout to update the layout.
+ if (_viewportLocation != viewport.Location)
+ {
+ _viewportLocation = viewport.Location;
+ SetNeedsLayout ();
+ }
+
+ OnViewportChanged (new (IsInitialized ? Viewport : Rectangle.Empty, oldViewport));
+
+ return;
+ }
+
+ _viewportLocation = viewport.Location;
+
+ // Update the Frame because we made it bigger or smaller which impacts subviews.
+ Frame = Frame with
+ {
+ Size = newSize
+ };
+
+ void ApplySettings (ref Rectangle newViewport)
+ {
+ if (!ViewportSettings.HasFlag (ViewportSettings.AllowXGreaterThanContentWidth))
+ {
+ if (newViewport.X >= ContentSize.Width)
+ {
+ newViewport.X = ContentSize.Width - 1;
+ }
+ }
+
+ // IMPORTANT: Check for negative location AFTER checking for location greater than content width
+ if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeX))
+ {
+ if (newViewport.X < 0)
+ {
+ newViewport.X = 0;
+ }
+ }
+
+ if (!ViewportSettings.HasFlag (ViewportSettings.AllowYGreaterThanContentHeight))
+ {
+ if (newViewport.Y >= ContentSize.Height)
+ {
+ newViewport.Y = ContentSize.Height - 1;
+ }
+ }
+
+ // IMPORTANT: Check for negative location AFTER checking for location greater than content width
+ if (!ViewportSettings.HasFlag (ViewportSettings.AllowNegativeY))
+ {
+ if (newViewport.Y < 0)
+ {
+ newViewport.Y = 0;
+ }
+ }
+ }
+ }
+
+ ///
+ /// Fired when the changes. This event is fired after the has been updated.
+ ///
+ [CanBeNull]
+ public event EventHandler ViewportChanged;
+
+ ///
+ /// Called when the changes. Invokes the event.
+ ///
+ ///
+ protected virtual void OnViewportChanged (DrawEventArgs e) { ViewportChanged?.Invoke (this, e); }
+
+ ///
+ /// Converts a -relative location to a screen-relative location.
+ ///
+ ///
+ /// Viewport-relative means relative to the top-left corner of the inner rectangle of the .
+ ///
+ public Rectangle ViewportToScreen (in Rectangle location)
+ {
+ // Translate bounds to Frame (our SuperView's Viewport-relative coordinates)
+ Rectangle screen = FrameToScreen ();
+ Point viewportOffset = GetViewportOffsetFromFrame ();
+ screen.Offset (viewportOffset.X + location.X, viewportOffset.Y + location.Y);
+
+ return new (screen.Location, location.Size);
+ }
+
+ /// Converts a screen-relative coordinate to a Viewport-relative coordinate.
+ /// The coordinate relative to this view's .
+ ///
+ /// Viewport-relative means relative to the top-left corner of the inner rectangle of the .
+ ///
+ /// Column relative to the left side of the Viewport.
+ /// Row relative to the top of the Viewport
+ public Point ScreenToViewport (int x, int y)
+ {
+ Point viewportOffset = GetViewportOffsetFromFrame ();
+ Point screen = ScreenToFrame (x, y);
+ screen.Offset (-viewportOffset.X, -viewportOffset.Y);
+
+ return screen;
+ }
+
+ ///
+ /// Helper to get the X and Y offset of the Viewport from the Frame. This is the sum of the Left and Top properties
+ /// of , and .
+ ///
+ public Point GetViewportOffsetFromFrame () { return Padding is null ? Point.Empty : Padding.Thickness.GetInside (Padding.Frame).Location; }
+
+ ///
+ /// Scrolls the view vertically by the specified number of rows.
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// if the was changed.
+ public bool? ScrollVertical (int rows)
+ {
+ if (ContentSize == Size.Empty || ContentSize == Viewport.Size)
+ {
+ return false;
+ }
+
+ Viewport = Viewport with { Y = Viewport.Y + rows };
+
+ return true;
+ }
+
+ ///
+ /// Scrolls the view horizontally by the specified number of columns.
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ /// if the was changed.
+ public bool? ScrollHorizontal (int cols)
+ {
+ if (ContentSize == Size.Empty || ContentSize == Viewport.Size)
+ {
+ return false;
+ }
+
+ Viewport = Viewport with { X = Viewport.X + cols };
+
+ return true;
+ }
+
+ #endregion Viewport
+}
diff --git a/Terminal.Gui/View/ViewDrawing.cs b/Terminal.Gui/View/ViewDrawing.cs
index 37094bbaea..cc7109a5bb 100644
--- a/Terminal.Gui/View/ViewDrawing.cs
+++ b/Terminal.Gui/View/ViewDrawing.cs
@@ -1,4 +1,6 @@
-namespace Terminal.Gui;
+using System.Drawing;
+
+namespace Terminal.Gui;
public partial class View
{
@@ -54,67 +56,108 @@ public bool NeedsDisplay
public bool SubViewNeedsDisplay { get; private set; }
///
- /// Gets or sets whether this View will use it's SuperView's for rendering any border
- /// lines. If the rendering of any borders drawn by this Frame will be done by it's parent's
+ /// Gets or sets whether this View will use it's SuperView's for rendering any
+ /// lines. If the rendering of any borders drawn by this Frame will be done by its parent's
/// SuperView. If (the default) this View's method will be
/// called to render the borders.
///
public virtual bool SuperViewRendersLineCanvas { get; set; } = false;
- /// Displays the specified character in the specified column and row of the View.
- /// Column (view-relative).
- /// Row (view-relative).
- /// Ch.
- public void AddRune (int col, int row, Rune ch)
+ /// Draws the specified character in the specified viewport-relative column and row of the View.
+ ///
+ /// If the provided coordinates are outside the visible content area, this method does nothing.
+ ///
+ ///
+ /// The top-left corner of the visible content area is ViewPort.Location.
+ ///
+ /// Column (viewport-relative).
+ /// Row (viewport-relative).
+ /// The Rune.
+ public void AddRune (int col, int row, Rune rune)
{
- if (row < 0 || col < 0)
+ if (Move (col, row))
{
- return;
+ Driver.AddRune (rune);
}
+ }
- if (row > _frame.Height - 1 || col > _frame.Width - 1)
+ /// Clears with the normal background.
+ ///
+ ///
+ /// If has only
+ /// the portion of the content
+ /// area that is visible within the will be cleared. This is useful for views that have a
+ /// content area larger than the Viewport (e.g. when is
+ /// enabled) and want
+ /// the area outside the content to be visually distinct.
+ ///
+ ///
+ public void Clear ()
+ {
+ if (Driver is null)
{
return;
}
- Move (col, row);
- Driver.AddRune (ch);
- }
+ // Get screen-relative coords
+ Rectangle toClear = ViewportToScreen (Viewport with { Location = new (0, 0) });
+
+ Rectangle prevClip = Driver.Clip;
+
+ if (ViewportSettings.HasFlag (ViewportSettings.ClearContentOnly))
+ {
+ Rectangle visibleContent = ViewportToScreen (new (new (-Viewport.X, -Viewport.Y), ContentSize));
+ toClear = Rectangle.Intersect (toClear, visibleContent);
+ }
- /// Clears with the normal background.
- ///
- public void Clear () { Clear (Bounds); }
+ Attribute prev = Driver.SetAttribute (GetNormalColor());
+ Driver.FillRect (toClear);
+ Driver.SetAttribute (prev);
+
+ Driver.Clip = prevClip;
+ }
- /// Clears the specified -relative rectangle with the normal background.
- ///
- /// The Bounds-relative rectangle to clear.
- public void Clear (Rectangle contentArea)
+ /// Fills the specified -relative rectangle with the specified color.
+ /// The Viewport-relative rectangle to clear.
+ /// The color to use to fill the rectangle. If not provided, the Normal background color will be used.
+ public void FillRect (Rectangle rect, Color? color = null)
{
if (Driver is null)
{
return;
}
- Attribute prev = Driver.SetAttribute (GetNormalColor ());
+ // Get screen-relative coords
+ Rectangle toClear = ViewportToScreen (rect);
+
+ Rectangle prevClip = Driver.Clip;
+
+ Driver.Clip = Rectangle.Intersect (prevClip, ViewportToScreen (Viewport with { Location = new (0, 0) }));
- // Clamp the region to the bounds of the view
- contentArea = Rectangle.Intersect (contentArea, Bounds);
- Driver.FillRect (BoundsToScreen (contentArea));
+ Attribute prev = Driver.SetAttribute (new (color ?? GetNormalColor().Background));
+ Driver.FillRect (toClear);
Driver.SetAttribute (prev);
+
+ Driver.Clip = prevClip;
}
- /// Expands the 's clip region to include .
+ /// Sets the 's clip region to .
+ ///
+ ///
+ /// By default, the clip rectangle is set to the intersection of the current clip region and the
+ /// . This ensures that drawing is constrained to the viewport, but allows
+ /// content to be drawn beyond the viewport.
+ ///
+ ///
+ /// If has set, clipping will be
+ /// applied to just the visible content area.
+ ///
+ ///
///
/// The current screen-relative clip region, which can be then re-applied by setting
/// .
///
- ///
- ///
- /// If and do not intersect, the clip region will be set to
- /// .
- ///
- ///
- public Rectangle ClipToBounds ()
+ public Rectangle SetClip ()
{
if (Driver is null)
{
@@ -122,7 +165,18 @@ public Rectangle ClipToBounds ()
}
Rectangle previous = Driver.Clip;
- Driver.Clip = Rectangle.Intersect (previous, BoundsToScreen (Bounds));
+
+ // Clamp the Clip to the entire visible area
+ Rectangle clip = Rectangle.Intersect (ViewportToScreen (Viewport with { Location = Point.Empty }), previous);
+
+ if (ViewportSettings.HasFlag (ViewportSettings.ClipContentOnly))
+ {
+ // Clamp the Clip to the just content area that is within the viewport
+ Rectangle visibleContent = ViewportToScreen (new (new (-Viewport.X, -Viewport.Y), ContentSize));
+ clip = Rectangle.Intersect (clip, visibleContent);
+ }
+
+ Driver.Clip = clip;
return previous;
}
@@ -133,7 +187,7 @@ public Rectangle ClipToBounds ()
///
///
///
- /// Always use (view-relative) when calling , NOT
+ /// Always use (view-relative) when calling , NOT
/// (superview-relative).
///
///
@@ -142,7 +196,8 @@ public Rectangle ClipToBounds ()
///
///
/// Overrides of must ensure they do not set Driver.Clip to a clip
- /// region larger than the