TerminalGui.Extensions/Extensions/ViewExtensions/WizardExtensions.cs at main · tyy-dev/TerminalGui.Extensions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
using System.ComponentModel;

using Terminal.Gui.App;
using Terminal.Gui.Views;

namespace TerminalGui.Extensions.Extensions.ViewExtensions;

/// <summary>
///     Extension methods for <see cref="Wizard" />.
/// </summary>
public static class WizardExtensions
{
    extension(Wizard wizard)
    {
        /// <summary>
        ///     Subscribes to the <see cref="Wizard.MovingBack" /> event.
        ///     Set <see cref="CancelEventArgs.Cancel" /> to <see langword="true" /> to prevent navigating back.
        /// </summary>
        /// <param name="callback">The callback to invoke with the <see cref="CancelEventArgs" />.</param>
        /// <returns>The <see cref="Wizard" /> instance.</returns>
        public Wizard OnMovingBack(Action<CancelEventArgs> callback)
        {
            wizard.MovingBack += (_, e) => callback(e);
            return wizard;
        }

        /// <summary>
        ///     Subscribes to the <see cref="Wizard.MovingNext" /> event.
        ///     Set <see cref="CancelEventArgs.Cancel" /> to <see langword="true" /> to prevent navigating forward.
        /// </summary>
        /// <param name="callback">The callback to invoke with the <see cref="CancelEventArgs" />.</param>
        /// <returns>The <see cref="Wizard" /> instance.</returns>
        public Wizard OnMovingNext(Action<CancelEventArgs> callback)
        {
            wizard.MovingNext += (_, e) => callback(e);
            return wizard;
        }

        /// <summary>
        ///     Subscribes to the <see cref="Wizard.StepChanged" /> event.
        /// </summary>
        /// <param name="callback">The callback to invoke with the <see cref="ValueChangedEventArgs{T}" /> containing the old and new <see cref="WizardStep" />.</param>
        /// <returns>The <see cref="Wizard" /> instance.</returns>
        public Wizard OnStepChanged(Action<ValueChangedEventArgs<WizardStep>> callback)
        {
            wizard.StepChanged += (_, e) => callback(e);
            return wizard;
        }

        /// <summary>
        ///     Subscribes to the <see cref="Wizard.StepChanging" /> event.
        ///     Set <see cref="ValueChangingEventArgs{T}.Handled" /> to <see langword="true" /> to cancel the step change.
        /// </summary>
        /// <param name="callback">The callback to invoke with the <see cref="ValueChangingEventArgs{T}" /> containing the current and proposed <see cref="WizardStep" />.</param>
        /// <returns>The <see cref="Wizard" /> instance.</returns>
        public Wizard OnStepChanging(Action<ValueChangingEventArgs<WizardStep>> callback)
        {
            wizard.StepChanging += (_, e) => callback(e);
            return wizard;
        }
    }
}