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

Updated docs and made MouseEvent fields into properties for futureproofing and consistency

Browse Source
This commit is contained in:
tznind
2022-10-19 15:47:57 +01:00
committed by BDisp
parent 46694ffa69
commit e7efa4058b
2 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Terminal.Gui/Core/Event.cs
View File

@@ -706,38 +706,42 @@ namespace Terminal.Gui {
}
/// <summary>
/// Describes a mouse event
/// Low-level construct that conveys the details of mouse events, such
/// as coordinates and button state, from ConsoleDrivers up to <see cref="Application"/> and
/// Views.
/// </summary>
/// <remarks>The <see cref="Application"/> class includes the <see cref="Application.RootMouseEvent"/>
/// Action which takes a MouseEvent argument.</remarks>
public class MouseEvent {
/// <summary>
/// The X (column) location for the mouse event.
/// </summary>
public int X;
public int X { get; set; }
/// <summary>
/// The Y (column) location for the mouse event.
/// </summary>
public int Y;
public int Y { get; set; }
/// <summary>
/// Flags indicating the kind of mouse event that is being posted.
/// </summary>
public MouseFlags Flags;
public MouseFlags Flags { get; set; }
/// <summary>
/// The offset X (column) location for the mouse event.
/// </summary>
public int OfX;
public int OfX { get; set; }
/// <summary>
/// The offset Y (column) location for the mouse event.
/// </summary>
public int OfY;
public int OfY { get; set; }
/// <summary>
/// The current view at the location for the mouse event.
/// </summary>
public View View;
public View View { get; set; }
/// <summary>
/// Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.

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

@@ -2743,7 +2743,9 @@ namespace Terminal.Gui {
}
/// <summary>
/// Specifies the event arguments for <see cref="MouseEvent"/>
/// 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>
@@ -2760,6 +2762,8 @@ namespace Terminal.Gui {
/// 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;