Simplified FindDeepestVieew

Terminal.Gui/Application.cs

@@ -1374,7 +1374,7 @@ public static partial class Application
             return;
         }
 
-        var view = View.FindDeepestView (Current, a.MouseEvent.X, a.MouseEvent.Y, out int screenX, out int screenY);
+        var view = View.FindDeepestView (Current, a.MouseEvent.X, a.MouseEvent.Y);
 
         if (view is { WantContinuousButtonPressed: true })
         {
@@ -1437,7 +1437,7 @@ public static partial class Application
             && a.MouseEvent.Flags != 0)
         {
             View? top = FindDeepestTop (Top, a.MouseEvent.X, a.MouseEvent.Y);
-            view = View.FindDeepestView (top, a.MouseEvent.X, a.MouseEvent.Y, out screenX, out screenY);
+            view = View.FindDeepestView (top, a.MouseEvent.X, a.MouseEvent.Y);
 
             if (view is { } && view != OverlappedTop && top != Current)
             {
@@ -1450,6 +1450,8 @@ public static partial class Application
             return;
         }
 
+        var screen = view.FrameToScreen ();
+
         // Work inside-out (Padding, Border, Margin)
         // TODO: Debate whether inside-out or outside-in is the right strategy
         if (AdornmentHandledMouseEvent (view.Padding, a))
@@ -1469,11 +1471,11 @@ public static partial class Application
 
             var me = new MouseEvent
             {
-                X = screenX,
-                Y = screenY,
+                X = a.MouseEvent.X - screen.X,
+                Y = a.MouseEvent.Y - screen.Y,
                 Flags = a.MouseEvent.Flags,
-                OfX = screenX,
-                OfY = screenY,
+                OfX = a.MouseEvent.X - screen.X,
+                OfY = a.MouseEvent.Y - screen.Y,
                 View = view
             };
 

Terminal.Gui/Input/Responder.cs

@@ -57,6 +57,9 @@ public class Responder : IDisposable
     public event EventHandler Disposing;
 
     /// <summary>Method invoked when a mouse event is generated</summary>
+    /// <remarks>
+    /// The coordinates are relative to <see cref="View.Bounds"/>.
+    /// </remarks>
     /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
     /// <param name="mouseEvent">Contains the details about the mouse event.</param>
     public virtual bool MouseEvent (MouseEvent mouseEvent) { return false; }
@@ -81,6 +84,9 @@ public class Responder : IDisposable
     ///     Called when the mouse first enters the view; the view will now receives mouse events until the mouse leaves
     ///     the view. At which time, <see cref="OnMouseLeave(Gui.MouseEvent)"/> will be called.
     /// </summary>
+    /// <remarks>
+    /// The coordinates are relative to <see cref="View.Bounds"/>.
+    /// </remarks>
     /// <param name="mouseEvent"></param>
     /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
     public virtual bool OnMouseEnter (MouseEvent mouseEvent) { return false; }
@@ -89,6 +95,9 @@ public class Responder : IDisposable
     ///     Called when the mouse has moved outside of the view; the view will no longer receive mouse events (until the
     ///     mouse moves within the view again and <see cref="OnMouseEnter(Gui.MouseEvent)"/> is called).
     /// </summary>
+    /// <remarks>
+    /// The coordinates are relative to <see cref="View.Bounds"/>.
+    /// </remarks>
     /// <param name="mouseEvent"></param>
     /// <returns><c>true</c>, if the event was handled, <c>false</c> otherwise.</returns>
     public virtual bool OnMouseLeave (MouseEvent mouseEvent) { return false; }

Terminal.Gui/View/Layout/ViewLayout.cs

@@ -550,18 +550,14 @@ public partial class View
     /// <param name="start">The superview where to look for.</param>
     /// <param name="x">The column location in the superview.</param>
     /// <param name="y">The row location in the superview.</param>
-    /// <param name="resultX">The found view screen relative column location.</param>
-    /// <param name="resultY">The found view screen relative row location.</param>
     /// <returns>
     ///     The view that was found at the <paramref name="x"/> and <paramref name="y"/> coordinates.
     ///     <see langword="null"/> if no view was found.
     /// </returns>
     // CONCURRENCY: This method is not thread-safe.
     // Undefined behavior and likely program crashes are exposed by unsynchronized access to InternalSubviews.
-    public static View? FindDeepestView (View? start, int x, int y, out int resultX, out int resultY)
+    public static View? FindDeepestView (View? start, int x, int y)
     {
-        resultY = resultX = 0;
-
         if (start is null || !start.Frame.Contains (x, y))
         {
             return null;
@@ -579,16 +575,11 @@ public partial class View
 
                 if (v.Visible && v.Frame.Contains (rx, ry))
                 {
-                    View? deep = FindDeepestView (v, rx, ry, out resultX, out resultY);
-
+                    View? deep = FindDeepestView (v, rx, ry);
                     return deep ?? v;
                 }
             }
         }
-
-        resultX = x - start.Frame.X;
-        resultY = y - start.Frame.Y;
-
         return start;
     }
     #nullable restore

Terminal.Gui/Views/Menu/Menu.cs

@@ -727,13 +727,7 @@ internal sealed class Menu : View
             locationOffset.Y += SuperView.Border.Thickness.Top;
         }
 
-        View view = FindDeepestView (
-                                     this,
-                                     a.MouseEvent.X + locationOffset.X,
-                                     a.MouseEvent.Y + locationOffset.Y,
-                                     out int rx,
-                                     out int ry
-                                    );
+        View view = FindDeepestView (this, a.MouseEvent.X + locationOffset.X, a.MouseEvent.Y + locationOffset.Y);
 
         if (view == this)
         {
@@ -742,7 +736,13 @@ internal sealed class Menu : View
                 throw new InvalidOperationException ("This shouldn't running on a invisible menu!");
             }
 
-            var nme = new MouseEvent { X = rx, Y = ry, Flags = a.MouseEvent.Flags, View = view };
+            var screen = view.FrameToScreen ();
+            var nme = new MouseEvent {
+                X = a.MouseEvent.X - screen.X,
+                Y = a.MouseEvent.Y - screen.Y,
+                Flags = a.MouseEvent.Flags,
+                View = view
+            };
 
             if (MouseEvent (nme) || a.MouseEvent.Flags == MouseFlags.Button1Pressed || a.MouseEvent.Flags == MouseFlags.Button1Released)
             {

UnitTests/View/FindDeepestViewTests.cs

@@ -21,7 +21,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
             Width = 10, Height = 10,
         };
 
-        Assert.Same (view, View.FindDeepestView (view, testX, testY, out _, out _));
+        Assert.Same (view, View.FindDeepestView (view, testX, testY));
     }
 
     // Test that FindDeepestView returns null if the start view has no subviews and coords are outside the view
@@ -37,7 +37,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
             Width = 10, Height = 10,
         };
 
-        Assert.Null(View.FindDeepestView (view, testX, testY, out _, out _));
+        Assert.Null(View.FindDeepestView (view, testX, testY));
     }
 
     // Test that FindDeepestView returns the correct view if the start view has subviews
@@ -64,7 +64,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
         };
         view.Add (subview);
 
-        var found = View.FindDeepestView (view, testX, testY, out _, out _);
+        var found = View.FindDeepestView (view, testX, testY);
 
         Assert.Equal (expectedSubViewFound, found == subview);
     }
@@ -97,7 +97,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
         };
         view.Add (subview);
 
-        var found = View.FindDeepestView (view, testX, testY, out _, out _);
+        var found = View.FindDeepestView (view, testX, testY);
 
         Assert.Equal (expectedSubViewFound, found == subview);
     }
@@ -130,7 +130,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
         subview.Margin.Thickness = new Thickness (1);
         view.Add (subview);
 
-        var found = View.FindDeepestView (view, testX, testY, out _, out _);
+        var found = View.FindDeepestView (view, testX, testY);
 
         Assert.Equal (expectedSubViewFound, found == subview);
     }
@@ -172,7 +172,7 @@ public class FindDeepestViewTests (ITestOutputHelper output)
 
         start.Add (subviews [0]);
 
-        var found = View.FindDeepestView (start, testX, testY, out _, out _);
+        var found = View.FindDeepestView (start, testX, testY);
         Assert.Equal (expectedSubViewFound, subviews.IndexOf(found));
     }
 }

UnitTests/View/Layout/LayoutTests.cs

@@ -1,4 +1,5 @@
 using Xunit.Abstractions;
+using static Unix.Terminal.Curses;
 
 // Alias Console to MockConsole so we don't accidentally use Console
 
@@ -549,7 +550,7 @@ public class LayoutTests
         Assert.Equal (new Rectangle (0, 2, 10, 3), win2.Frame);
         Assert.Equal (new Rectangle (0, 0, 8, 1), view2.Frame);
         Assert.Equal (new Rectangle (0, 0, 7, 1), view3.Frame);
-        var foundView = View.FindDeepestView (top, 9, 4, out int rx, out int ry);
+        var foundView = View.FindDeepestView (top, 9, 4);
         Assert.Equal (foundView, view2);
 
         Application.OnMouseEvent (

UnitTests/View/NavigationTests.cs

@@ -856,39 +856,46 @@ public class NavigationTests
         top.BoundsToScreen (-1, -1, out col, out row);
         Assert.Equal (0, col);
         Assert.Equal (0, row);
-        Assert.Equal (top, View.FindDeepestView (top, 0, 0, out int rx, out int ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        var found = View.FindDeepestView (top, 0, 0);
+        Assert.Equal (top, found);
+ 
+        Assert.Equal (0, found.Frame.X);
+        Assert.Equal (0, found.Frame.Y);
         Assert.Equal (new Point (3, 2), top.ScreenToFrame (3, 2));
         top.BoundsToScreen (3, 2, out col, out row);
         Assert.Equal (4, col);
         Assert.Equal (3, row);
-        Assert.Equal (view, View.FindDeepestView (top, col, row, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
-        Assert.Equal (top, View.FindDeepestView (top, 3, 2, out rx, out ry));
-        Assert.Equal (3, rx);
-        Assert.Equal (2, ry);
+        found = View.FindDeepestView (top, col, row);
+        Assert.Equal (view, found);
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
+        found = View.FindDeepestView (top, 3, 2);
+        Assert.Equal (top, found);
+        //Assert.Equal (3, found.FrameToScreen ().X);
+        //Assert.Equal (2, found.FrameToScreen ().Y);
         Assert.Equal (new Point (13, 2), top.ScreenToFrame (13, 2));
         top.BoundsToScreen (12, 2, out col, out row);
         Assert.Equal (13, col);
         Assert.Equal (3, row);
-        Assert.Equal (view, View.FindDeepestView (top, col, row, out rx, out ry));
-        Assert.Equal (9, rx);
-        Assert.Equal (0, ry);
+        found = View.FindDeepestView (top, col, row);
+        Assert.Equal (view, found);
+        //Assert.Equal (9, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         top.BoundsToScreen (13, 2, out col, out row);
         Assert.Equal (14, col);
         Assert.Equal (3, row);
-        Assert.Equal (top, View.FindDeepestView (top, 13, 2, out rx, out ry));
-        Assert.Equal (13, rx);
-        Assert.Equal (2, ry);
+        found = View.FindDeepestView (top, 13, 2);
+        Assert.Equal (top, found);
+        //Assert.Equal (13, found.FrameToScreen ().X);
+        //Assert.Equal (2, found.FrameToScreen ().Y);
         Assert.Equal (new Point (14, 3), top.ScreenToFrame (14, 3));
         top.BoundsToScreen (14, 3, out col, out row);
         Assert.Equal (15, col);
         Assert.Equal (4, row);
-        Assert.Equal (top, View.FindDeepestView (top, 14, 3, out rx, out ry));
-        Assert.Equal (14, rx);
-        Assert.Equal (3, ry);
+        found = View.FindDeepestView (top, 14, 3);
+        Assert.Equal (top, found);
+        //Assert.Equal (14, found.FrameToScreen ().X);
+        //Assert.Equal (3, found.FrameToScreen ().Y);
 
         // view
         Assert.Equal (new Point (-4, -3), view.ScreenToFrame (0, 0));
@@ -907,30 +914,34 @@ public class NavigationTests
         view.BoundsToScreen (-4, -3, out col, out row);
         Assert.Equal (0, col);
         Assert.Equal (0, row);
-        Assert.Equal (top, View.FindDeepestView (top, 0, 0, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        found = View.FindDeepestView (top, 0, 0);
+        Assert.Equal (top, found);
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (-1, -1), view.ScreenToFrame (3, 2));
         view.BoundsToScreen (0, 0, out col, out row);
         Assert.Equal (4, col);
         Assert.Equal (3, row);
-        Assert.Equal (view, View.FindDeepestView (top, 4, 3, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        found = View.FindDeepestView (top, 4, 3);
+        Assert.Equal (view, found);
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (9, -1), view.ScreenToFrame (13, 2));
         view.BoundsToScreen (10, 0, out col, out row);
         Assert.Equal (14, col);
         Assert.Equal (3, row);
-        Assert.Equal (top, View.FindDeepestView (top, 14, 3, out rx, out ry));
-        Assert.Equal (14, rx);
-        Assert.Equal (3, ry);
+        found = View.FindDeepestView (top, 14, 3);
+        Assert.Equal (top, found);
+        //Assert.Equal (14, found.FrameToScreen ().X);
+        //Assert.Equal (3, found.FrameToScreen ().Y);
         Assert.Equal (new Point (10, 0), view.ScreenToFrame (14, 3));
         view.BoundsToScreen (11, 1, out col, out row);
         Assert.Equal (15, col);
         Assert.Equal (4, row);
-        Assert.Equal (top, View.FindDeepestView (top, 15, 4, out rx, out ry));
-        Assert.Equal (15, rx);
-        Assert.Equal (4, ry);
+        found = View.FindDeepestView (top, 15, 4);
+        Assert.Equal (top, found);
+        //Assert.Equal (15, found.FrameToScreen ().X);
+        //Assert.Equal (4, found.FrameToScreen ().Y);
     }
 
     [Fact]
@@ -1004,30 +1015,31 @@ public class NavigationTests
         top.BoundsToScreen (-4, -3, out col, out row);
         Assert.Equal (0, col);
         Assert.Equal (0, row);
-        Assert.Null (View.FindDeepestView (top, -4, -3, out int rx, out int ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        var found = View.FindDeepestView (top, -4, -3);
+        Assert.Null (found);
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (Point.Empty, top.ScreenToFrame (3, 2));
         top.BoundsToScreen (0, 0, out col, out row);
         Assert.Equal (4, col);
         Assert.Equal (3, row);
-        Assert.Equal (top, View.FindDeepestView (top, 3, 2, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        Assert.Equal (top, View.FindDeepestView (top, 3, 2));
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (10, 0), top.ScreenToFrame (13, 2));
         top.BoundsToScreen (10, 0, out col, out row);
         Assert.Equal (14, col);
         Assert.Equal (3, row);
-        Assert.Equal (top, View.FindDeepestView (top, 13, 2, out rx, out ry));
-        Assert.Equal (10, rx);
-        Assert.Equal (0, ry);
+        Assert.Equal (top, View.FindDeepestView (top, 13, 2));
+        //Assert.Equal (10, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (11, 1), top.ScreenToFrame (14, 3));
         top.BoundsToScreen (11, 1, out col, out row);
         Assert.Equal (15, col);
         Assert.Equal (4, row);
-        Assert.Equal (top, View.FindDeepestView (top, 14, 3, out rx, out ry));
-        Assert.Equal (11, rx);
-        Assert.Equal (1, ry);
+        Assert.Equal (top, View.FindDeepestView (top, 14, 3));
+        //Assert.Equal (11, found.FrameToScreen ().X);
+        //Assert.Equal (1, found.FrameToScreen ().Y);
 
         // view
         Assert.Equal (new Point (-7, -5), view.ScreenToFrame (0, 0));
@@ -1043,44 +1055,44 @@ public class NavigationTests
         view.BoundsToScreen (-6, -4, out col, out row);
         Assert.Equal (1, col);
         Assert.Equal (1, row);
-        Assert.Null (View.FindDeepestView (top, 1, 1, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        Assert.Null (View.FindDeepestView (top, 1, 1));
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (-4, -3), view.ScreenToFrame (3, 2));
         view.BoundsToScreen (-3, -2, out col, out row);
         Assert.Equal (4, col);
         Assert.Equal (3, row);
-        Assert.Equal (top, View.FindDeepestView (top, 4, 3, out rx, out ry));
-        Assert.Equal (1, rx);
-        Assert.Equal (1, ry);
+        Assert.Equal (top, View.FindDeepestView (top, 4, 3));
+        //Assert.Equal (1, found.FrameToScreen ().X);
+        //Assert.Equal (1, found.FrameToScreen ().Y);
         Assert.Equal (new Point (-1, -1), view.ScreenToFrame (6, 4));
         view.BoundsToScreen (0, 0, out col, out row);
         Assert.Equal (7, col);
         Assert.Equal (5, row);
-        Assert.Equal (view, View.FindDeepestView (top, 7, 5, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        Assert.Equal (view, View.FindDeepestView (top, 7, 5));
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (6, -1), view.ScreenToFrame (13, 4));
         view.BoundsToScreen (7, 0, out col, out row);
         Assert.Equal (14, col);
         Assert.Equal (5, row);
-        Assert.Equal (view, View.FindDeepestView (top, 14, 5, out rx, out ry));
-        Assert.Equal (7, rx);
-        Assert.Equal (0, ry);
+        Assert.Equal (view, View.FindDeepestView (top, 14, 5));
+        //Assert.Equal (7, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
         Assert.Equal (new Point (7, -2), view.ScreenToFrame (14, 3));
         view.BoundsToScreen (8, -1, out col, out row);
         Assert.Equal (15, col);
         Assert.Equal (4, row);
-        Assert.Equal (top, View.FindDeepestView (top, 15, 4, out rx, out ry));
-        Assert.Equal (12, rx);
-        Assert.Equal (2, ry);
+        Assert.Equal (top, View.FindDeepestView (top, 15, 4));
+        //Assert.Equal (12, found.FrameToScreen ().X);
+        //Assert.Equal (2, found.FrameToScreen ().Y);
         Assert.Equal (new Point (16, -2), view.ScreenToFrame (23, 3));
         view.BoundsToScreen (17, -1, out col, out row);
         Assert.Equal (24, col);
         Assert.Equal (4, row);
-        Assert.Null (View.FindDeepestView (top, 24, 4, out rx, out ry));
-        Assert.Equal (0, rx);
-        Assert.Equal (0, ry);
+        Assert.Null (View.FindDeepestView (top, 24, 4));
+        //Assert.Equal (0, found.FrameToScreen ().X);
+        //Assert.Equal (0, found.FrameToScreen ().Y);
     }
 
     [Fact]

UnitTests/Views/MenuBarTests.cs

@@ -518,7 +518,7 @@ public class MenuBarTests
 
         Application.OnMouseEvent (
                                   new MouseEventEventArgs (
-                                                           new MouseEvent { X = 20, Y = 4, Flags = MouseFlags.Button1Clicked }
+                                                           new MouseEvent { X = 20, Y = 5, Flags = MouseFlags.Button1Clicked }
                                                           )
                                  );
 
@@ -555,7 +555,7 @@ public class MenuBarTests
 
             Application.OnMouseEvent (
                                       new MouseEventEventArgs (
-                                                               new MouseEvent { X = 20, Y = 4 + i, Flags = MouseFlags.Button1Clicked }
+                                                               new MouseEvent { X = 20, Y = 5 + i, Flags = MouseFlags.Button1Clicked }
                                                               )
                                      );