Code cleanup

Terminal.Gui/App/Application.cd

@@ -94,7 +94,7 @@
     <Position X="6.25" Y="6.5" Width="2" />
     <TypeIdentifier>
       <HashCode>BAAgAAAAAAAAAgAAAAAAABAAACEAAAAAAAAAAgAAAAA=</HashCode>
-      <FileName>App\IGrabMouse.cs</FileName>
+      <FileName>App\IMouseGrabHandler.cs</FileName>
     </TypeIdentifier>
   </Interface>
   <Font Name="Segoe UI" Size="9" />

Terminal.Gui/App/IGrabMouse.cs → Terminal.Gui/App/IMouseGrabHandler.cs

@@ -1,32 +1,38 @@
 namespace Terminal.Gui.App;
 
+/// <summary>
+///     Interface for class that tracks which <see cref="View"/> (if any) has 'grabbed' the mouse
+///     and wants priority updates about its activity e.g. where it moves to, when it is released
+///     etc. Example use case is a button on a scroll bar being held down by the mouse - resulting
+///     in continuous scrolling.
+/// </summary>
 public interface IMouseGrabHandler
 {
     /// <summary>
     ///     Gets the view that grabbed the mouse (e.g. for dragging). When this is set, all mouse events will be routed to
     ///     this view until the view calls <see cref="UngrabMouse"/> or the mouse is released.
     /// </summary>
     public View? MouseGrabView { get; }
 
     /// <summary>Invoked when a view wants to grab the mouse; can be canceled.</summary>
     public event EventHandler<GrabMouseEventArgs>? GrabbingMouse;
 
     /// <summary>Invoked when a view wants un-grab the mouse; can be canceled.</summary>
     public event EventHandler<GrabMouseEventArgs>? UnGrabbingMouse;
 
     /// <summary>Invoked after a view has grabbed the mouse.</summary>
     public event EventHandler<ViewEventArgs>? GrabbedMouse;
 
     /// <summary>Invoked after a view has un-grabbed the mouse.</summary>
     public event EventHandler<ViewEventArgs>? UnGrabbedMouse;
 
     /// <summary>
     ///     Grabs the mouse, forcing all mouse events to be routed to the specified view until <see cref="UngrabMouse"/>
     ///     is called.
     /// </summary>
     /// <param name="view">View that will receive all mouse events until <see cref="UngrabMouse"/> is invoked.</param>
     public void GrabMouse (View? view);
 
     /// <summary>Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.</summary>
     public void UngrabMouse ();
-}
+}

Terminal.Gui/App/MouseGrabHandler.cs

@@ -2,7 +2,6 @@
 
 internal class MouseGrabHandler : IMouseGrabHandler
 {
-
     /// <summary>
     ///     Gets the view that grabbed the mouse (e.g. for dragging). When this is set, all mouse events will be routed to
     ///     this view until the view calls <see cref="UngrabMouse"/> or the mouse is released.
@@ -10,37 +9,37 @@
     public View? MouseGrabView { get; private set; }
 
     /// <summary>Invoked when a view wants to grab the mouse; can be canceled.</summary>
     public event EventHandler<GrabMouseEventArgs>? GrabbingMouse;
 
     /// <summary>Invoked when a view wants un-grab the mouse; can be canceled.</summary>
     public event EventHandler<GrabMouseEventArgs>? UnGrabbingMouse;
 
     /// <summary>Invoked after a view has grabbed the mouse.</summary>
     public event EventHandler<ViewEventArgs>? GrabbedMouse;
 
     /// <summary>Invoked after a view has un-grabbed the mouse.</summary>
     public event EventHandler<ViewEventArgs>? UnGrabbedMouse;
 
     /// <summary>
     ///     Grabs the mouse, forcing all mouse events to be routed to the specified view until <see cref="UngrabMouse"/>
     ///     is called.
     /// </summary>
     /// <param name="view">View that will receive all mouse events until <see cref="UngrabMouse"/> is invoked.</param>
-    public void GrabMouse(View? view)
+    public void GrabMouse (View? view)
     {
-        if (view is null || RaiseGrabbingMouseEvent(view))
+        if (view is null || RaiseGrabbingMouseEvent (view))
         {
             return;
         }
 
-        RaiseGrabbedMouseEvent(view);
+        RaiseGrabbedMouseEvent (view);
 
         // MouseGrabView is a static; only set if the application is initialized.
         MouseGrabView = view;
     }
 
     /// <summary>Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.</summary>
-    public void UngrabMouse()
+    public void UngrabMouse ()
     {
         if (MouseGrabView is null)
         {
@@ -50,66 +49,65 @@
 #if DEBUG_IDISPOSABLE
         if (View.EnableDebugIDisposableAsserts)
         {
-            ObjectDisposedException.ThrowIf(MouseGrabView.WasDisposed, MouseGrabView);
+            ObjectDisposedException.ThrowIf (MouseGrabView.WasDisposed, MouseGrabView);
         }
 #endif
 
-        if (!RaiseUnGrabbingMouseEvent(MouseGrabView))
+        if (!RaiseUnGrabbingMouseEvent (MouseGrabView))
         {
             View view = MouseGrabView;
             MouseGrabView = null;
-            RaiseUnGrabbedMouseEvent(view);
+            RaiseUnGrabbedMouseEvent (view);
         }
     }
 
     /// <exception cref="Exception">A delegate callback throws an exception.</exception>
-    private bool RaiseGrabbingMouseEvent(View? view)
+    private bool RaiseGrabbingMouseEvent (View? view)
     {
         if (view is null)
         {
             return false;
         }
 
-        var evArgs = new GrabMouseEventArgs(view);
-        GrabbingMouse?.Invoke(view, evArgs);
+        var evArgs = new GrabMouseEventArgs (view);
+        GrabbingMouse?.Invoke (view, evArgs);
 
         return evArgs.Cancel;
     }
 
     /// <exception cref="Exception">A delegate callback throws an exception.</exception>
-    private bool RaiseUnGrabbingMouseEvent(View? view)
+    private bool RaiseUnGrabbingMouseEvent (View? view)
     {
         if (view is null)
         {
             return false;
         }
 
-        var evArgs = new GrabMouseEventArgs(view);
-        UnGrabbingMouse?.Invoke(view, evArgs);
+        var evArgs = new GrabMouseEventArgs (view);
+        UnGrabbingMouse?.Invoke (view, evArgs);
 
         return evArgs.Cancel;
     }
 
     /// <exception cref="Exception">A delegate callback throws an exception.</exception>
-    private void RaiseGrabbedMouseEvent(View? view)
+    private void RaiseGrabbedMouseEvent (View? view)
     {
         if (view is null)
         {
             return;
         }
 
-        GrabbedMouse?.Invoke(view, new(view));
+        GrabbedMouse?.Invoke (view, new (view));
     }
 
     /// <exception cref="Exception">A delegate callback throws an exception.</exception>
-    private void RaiseUnGrabbedMouseEvent(View? view)
+    private void RaiseUnGrabbedMouseEvent (View? view)
     {
         if (view is null)
         {
             return;
         }
 
-        UnGrabbedMouse?.Invoke(view, new(view));
+        UnGrabbedMouse?.Invoke (view, new (view));
     }
-
 }