Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-28 08:47:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Grouping views events in the ViewEventArgs.cs file.

Browse Source
This commit is contained in:
BDisp
2023-03-17 16:46:08 +00:00
parent 69a1c6ebde
commit 3960ff4e7a
4 changed files with 64 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
Terminal.Gui/Core/FocusEventArgs.cs
View File

@@ -1,25 +0,0 @@
using System;
namespace Terminal.Gui {
/// <summary>
/// Defines the event arguments for <see cref="View.SetFocus(View)"/>
/// </summary>
public class FocusEventArgs : EventArgs {
/// <summary>
/// Constructs.
/// </summary>
/// <param name="view">The view that gets or loses focus.</param>
public FocusEventArgs (View view) { View = view; }
/// <summary>
/// Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
/// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
/// </summary>
public bool Handled { get; set; }
/// <summary>
/// Indicates the current view that gets or loses focus.
/// </summary>
public View View { get; set; }
}
}

60
Terminal.Gui/Core/View.cs
View File

@@ -139,17 +139,17 @@ namespace Terminal.Gui {
/// <summary>
/// Event fired when the view receives the mouse event for the first time.
/// </summary>
public event EventHandler<MouseEventArgs> MouseEnter;
public event EventHandler<MouseEventEventArgs> MouseEnter;
/// <summary>
/// Event fired when the view receives a mouse event for the last time.
/// </summary>
public event EventHandler<MouseEventArgs> MouseLeave;
public event EventHandler<MouseEventEventArgs> MouseLeave;
/// <summary>
/// Event fired when a mouse event is generated.
/// </summary>
public event EventHandler<MouseEventArgs> MouseClick;
public event EventHandler<MouseEventEventArgs> MouseClick;
/// <summary>
/// Event fired when the <see cref="CanFocus"/> value is being changed.
@@ -827,7 +827,7 @@ namespace Terminal.Gui {
void TextFormatter_HotKeyChanged (object sender, KeyChangedEventArgs e)
{
HotKeyChanged?.Invoke (this,e);
HotKeyChanged?.Invoke (this, e);
}
/// <summary>
@@ -942,7 +942,7 @@ namespace Terminal.Gui {
}
SetNeedsLayout ();
SetNeedsDisplay ();
OnAdded (new SuperViewChangedEventArgs (this,view));
OnAdded (new SuperViewChangedEventArgs (this, view));
if (IsInitialized) {
view.BeginInit ();
view.EndInit ();
@@ -1344,7 +1344,7 @@ namespace Terminal.Gui {
view.width ??= view.frame.Width;
view.height ??= view.frame.Height;
view.Added?.Invoke (this,e);
view.Added?.Invoke (this, e);
}
/// <summary>
@@ -1593,7 +1593,7 @@ namespace Terminal.Gui {
/// </remarks>
public virtual void OnDrawContent (Rect viewport)
{
DrawContent?.Invoke (this, new DrawEventArgs(viewport));
DrawContent?.Invoke (this, new DrawEventArgs (viewport));
}
/// <summary>
@@ -2239,16 +2239,6 @@ namespace Terminal.Gui {
}
}
/// <summary>
/// Event arguments for the <see cref="LayoutComplete"/> event.
/// </summary>
public class LayoutEventArgs : EventArgs {
/// <summary>
/// The view-relative bounds of the <see cref="View"/> before it was laid out.
/// </summary>
public Rect OldBounds { get; set; }
}
/// <summary>
/// Fired after the View's <see cref="LayoutSubviews"/> method has completed.
/// </summary>
@@ -2795,34 +2785,6 @@ namespace Terminal.Gui {
frame.Size.Height + GetHotKeySpecifierLength (false));
}
/// <summary>
/// Specifies the event arguments for <see cref="MouseEvent"/>. This is a higher-level construct
/// than the wrapped <see cref="MouseEvent"/> class and is used for the events defined on <see cref="View"/>
/// and subclasses of View (e.g. <see cref="View.MouseEnter"/> and <see cref="View.MouseClick"/>).
/// </summary>
public class MouseEventArgs : EventArgs {
/// <summary>
/// Constructs.
/// </summary>
/// <param name="me"></param>
public MouseEventArgs (MouseEvent me) => MouseEvent = me;
/// <summary>
/// The <see cref="MouseEvent"/> for the event.
/// </summary>
public MouseEvent MouseEvent { get; set; }
/// <summary>
/// Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
/// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
/// </summary>
/// <remarks>This property forwards to the <see cref="MouseEvent.Handled"/> property and is provided as a convenience and for
/// backwards compatibility</remarks>
public bool Handled {
get => MouseEvent.Handled;
set => MouseEvent.Handled = value;
}
}
/// <inheritdoc/>
public override bool OnMouseEnter (MouseEvent mouseEvent)
{
@@ -2834,7 +2796,7 @@ namespace Terminal.Gui {
return false;
}
var args = new MouseEventArgs (mouseEvent);
var args = new MouseEventEventArgs (mouseEvent);
MouseEnter?.Invoke (this, args);
return args.Handled || base.OnMouseEnter (mouseEvent);
@@ -2851,7 +2813,7 @@ namespace Terminal.Gui {
return false;
}
var args = new MouseEventArgs (mouseEvent);
var args = new MouseEventEventArgs (mouseEvent);
MouseLeave?.Invoke (this, args);
return args.Handled || base.OnMouseLeave (mouseEvent);
@@ -2872,7 +2834,7 @@ namespace Terminal.Gui {
return false;
}
var args = new MouseEventArgs (mouseEvent);
var args = new MouseEventEventArgs (mouseEvent);
if (OnMouseClick (args))
return true;
if (MouseEvent (mouseEvent))
@@ -2892,7 +2854,7 @@ namespace Terminal.Gui {
/// <summary>
/// Invokes the MouseClick event.
/// </summary>
protected bool OnMouseClick (MouseEventArgs args)
protected bool OnMouseClick (MouseEventEventArgs args)
{
if (!Enabled) {
return true;

59
Terminal.Gui/Core/ViewEventArgs.cs
View File

@@ -1,17 +1,13 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Terminal.Gui {
/// <summary>
/// Args for events that relate to specific <see cref="View"/>
/// </summary>
public class ViewEventArgs :EventArgs{
public class ViewEventArgs : EventArgs {
/// <summary>
/// Creates a new instance of the <see cref="ViewEventArgs"/> class.
/// Creates a new instance of the <see cref="Terminal.Gui.View"/> class.
/// </summary>
/// <param name="view"></param>
public ViewEventArgs (View view)
@@ -30,4 +26,55 @@ namespace Terminal.Gui {
/// </remarks>
public View View { get; }
}
/// <summary>
/// Event arguments for the <see cref="View.LayoutComplete"/> event.
/// </summary>
public class LayoutEventArgs : EventArgs {
/// <summary>
/// The view-relative bounds of the <see cref="View"/> before it was laid out.
/// </summary>
public Rect OldBounds { get; set; }
}
/// <summary>
/// Event args for draw events
/// </summary>
public class DrawEventArgs : EventArgs {
/// <summary>
/// Creates a new instance of the <see cref="DrawEventArgs"/> class.
/// </summary>
/// <param name="rect">Gets the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.</param>
public DrawEventArgs (Rect rect)
{
Rect = rect;
}
/// <summary>
/// Gets the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
/// </summary>
public Rect Rect { get; }
}
/// <summary>
/// Defines the event arguments for <see cref="View.SetFocus(View)"/>
/// </summary>
public class FocusEventArgs : EventArgs {
/// <summary>
/// Constructs.
/// </summary>
/// <param name="view">The view that gets or loses focus.</param>
public FocusEventArgs (View view) { View = view; }
/// <summary>
/// Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
/// Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
/// </summary>
public bool Handled { get; set; }
/// <summary>
/// Indicates the current view that gets or loses focus.
/// </summary>
public View View { get; set; }
}
}

28
Terminal.Gui/Views/DrawEventArgs.cs
View File

@@ -1,28 +0,0 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Terminal.Gui {
/// <summary>
/// Event args for draw events
/// </summary>
public class DrawEventArgs : EventArgs{
/// <summary>
/// Creates a new instance of the <see cref="DrawEventArgs"/> class.
/// </summary>
/// <param name="rect">Gets the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.</param>
public DrawEventArgs (Rect rect)
{
Rect = rect;
}
/// <summary>
/// Gets the view-relative rectangle describing the currently visible viewport into the <see cref="View"/>.
/// </summary>
public Rect Rect { get; }
}
}