aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioViewModel.cs
blob: 30e96bd0afaa22d03e7dc33483980baa70d9efc7 (plain)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.SharedUI;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a Machine Studio view model
    /// </summary>
    /// <typeparam name="Module">The type of the module.</typeparam>
    /// <seealso cref="Tango.SharedUI.ViewModel" />
    /// <seealso cref="Tango.MachineStudio.Common.IStudioViewModel" />
    public abstract class StudioViewModel<Module> : ViewModel, IStudioViewModel where Module : IStudioModule
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="StudioViewModel{Module}"/> class.
        /// </summary>
        public StudioViewModel() : base()
        {

        }

        /// <summary>
        /// Called when another module has wants to navigate to this module with some arguments.
        /// </summary>
        /// <param name="args">The arguments.</param>
        public virtual void OnModuleRequest(params object[] args)
        {

        }

        /// <summary>
        /// Called when the user has navigated out of the module.
        /// </summary>
        public virtual void OnNavigatedFrom()
        {

        }

        /// <summary>
        /// Called when the user has navigated in to the module.
        /// </summary>
        public virtual void OnNavigatedTo()
        {

        }

        /// <summary>
        /// Called before the application is shutting down.
        /// Return false to cancel the shutdown in case an important process is in progress.
        /// </summary>
        /// <returns></returns>
        public virtual Task<bool> OnShutdownRequest()
        {
            return Task.FromResult(true);
        }

        /// <summary>
        /// Called when application is shutting down.
        /// </summary>
        public virtual void OnShuttingDown()
        {

        }
    }

    /// <summary>
    /// Represents a Machine Studio view model.
    /// </summary>
    /// <typeparam name="Module">The type of the module.</typeparam>
    /// <typeparam name="T"></typeparam>
    /// <seealso cref="Tango.SharedUI.ViewModel" />
    /// <seealso cref="Tango.MachineStudio.Common.IStudioViewModel" />
    public abstract class StudioViewModel<Module, T> : ViewModel<T>, IStudioViewModel where Module : IStudioModule where T : IView
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="StudioViewModel{Module, T}"/> class.
        /// </summary>
        /// <param name="view">The view.</param>
        public StudioViewModel(T view) : base(view)
        {

        }

        /// <summary>
        /// Called when another module has wants to navigate to this module with some arguments.
        /// </summary>
        /// <param name="args">The arguments.</param>
        public virtual void OnModuleRequest(params object[] args)
        {

        }

        /// <summary>
        /// Called when the user has navigated out of the module.
        /// </summary>
        public virtual void OnNavigatedFrom()
        {

        }

        /// <summary>
        /// Called when the user has navigated in to the module.
        /// </summary>
        public virtual void OnNavigatedTo()
        {

        }

        /// <summary>
        /// Called before the application is shutting down.
        /// Return false to cancel the shutdown in case an important process is in progress.
        /// </summary>
        /// <returns></returns>
        public virtual Task<bool> OnShutdownRequest()
        {
            return Task.FromResult(true);
        }

        /// <summary>
        /// Called when application is shutting down.
        /// </summary>
        public virtual void OnShuttingDown()
        {

        }
    }
}