From 97684e4d648fc9c39838e4fac34cf0402b953901 Mon Sep 17 00:00:00 2001 From: Tig Date: Mon, 7 Oct 2024 08:56:18 -0400 Subject: [PATCH] api docs --- Terminal.Gui/View/View.Command.cs | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/Terminal.Gui/View/View.Command.cs b/Terminal.Gui/View/View.Command.cs index 473692da3..1f0fcab3b 100644 --- a/Terminal.Gui/View/View.Command.cs +++ b/Terminal.Gui/View/View.Command.cs @@ -49,7 +49,7 @@ public partial class View // Command APIs } /// - /// Called when the View's state has been accepted by the user. Calls which can be cancelled; if not cancelled raises . + /// Called when the user is accepting the state of the View and the has been invoked. Calls which can be cancelled; if not cancelled raises . /// event. The default handler calls this method. /// /// @@ -97,16 +97,16 @@ public partial class View // Command APIs } /// - /// Called when the View's state has been accepted by the user. Set to - /// to stop processing. + /// Called when the user is accepting the state of the View and the has been invoked. Set to + /// and return to stop processing. /// /// /// to stop processing. protected virtual bool OnAccepted (CommandEventArgs args) { return false; } /// - /// Cancelable event raised when the View's state has been accepted by the user. Set - /// to cancel the event. + /// Cancelable event raised when the user is accepting the state of the View and the has been invoked. Set + /// to cancel the event. /// public event EventHandler? Accepted; @@ -154,9 +154,8 @@ public partial class View // Command APIs /// public event EventHandler? Selecting; - // TODO: What does this event really do? "Called when the user has pressed the View's hot key or otherwise invoked the View's hot key command.???" /// - /// Called when the View is handlingthe user pressing the View's s. Calls which can be cancelled; if not cancelled raises . + /// Called when the View is handling the user pressing the View's s. Calls which can be cancelled; if not cancelled raises . /// event. The default handler calls this method. /// /// @@ -181,7 +180,7 @@ public partial class View // Command APIs } /// - /// Called when the View has handled the user pressing the View's . Set to + /// Called when the View is handling the user pressing the View's . Set to /// to stop processing. /// /// @@ -189,7 +188,7 @@ public partial class View // Command APIs protected virtual bool OnHandlingHotKey (CommandEventArgs args) { return false; } /// - /// Cancelable event raised when the command is invoked. Set + /// Cancelable event raised when the View is handling the user pressing the View's . Set /// /// to cancel the event. ///