mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-30 09:47:58 +01:00
36 lines
1.5 KiB
C#
36 lines
1.5 KiB
C#
#nullable enable
|
|
using System.ComponentModel;
|
|
|
|
namespace Terminal.Gui;
|
|
|
|
#pragma warning disable CS1711
|
|
|
|
/// <summary>
|
|
/// <see cref="EventArgs"/> for events that convey changes to a property of type <typeparamref name="T"/>.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type of the value that was part of the change being canceled.</typeparam>
|
|
/// <remarks>
|
|
/// Events that use this class can be cancellable. Where applicable, the <see cref="CancelEventArgs.Cancel"/> property
|
|
/// should be set to
|
|
/// <see langword="true"/> to prevent the state change from occurring.
|
|
/// </remarks>
|
|
public class CancelEventArgs<T> : CancelEventArgs where T : notnull
|
|
{
|
|
/// <summary>Initializes a new instance of the <see cref="CancelEventArgs{T}"/> class.</summary>
|
|
/// <param name="currentValue">The current (old) value of the property.</param>
|
|
/// <param name="newValue">The value the property will be set to if the event is not cancelled.</param>
|
|
/// <param name="cancel">Whether the event should be canceled or not.</param>
|
|
/// <typeparam name="T">The type of the value for the change being canceled.</typeparam>
|
|
public CancelEventArgs (ref readonly T currentValue, ref T newValue, bool cancel = false) : base (cancel)
|
|
{
|
|
CurrentValue = currentValue;
|
|
NewValue = newValue;
|
|
}
|
|
|
|
/// <summary>The current value of the property.</summary>
|
|
public T CurrentValue { get; }
|
|
|
|
/// <summary>The value the property will be set to if the event is not cancelled.</summary>
|
|
public T NewValue { get; set; }
|
|
}
|