aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioViewModel.cs
blob: 9ce79703fb5a2e7e371ad2d6b398d60230f2d2a5 (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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.Core.DI;
using Tango.SharedUI;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a Machine Studio view model
    /// </summary>
    /// <seealso cref="Tango.SharedUI.ViewModel" />
    /// <seealso cref="Tango.MachineStudio.Common.IStudioViewModel" />
    public abstract class StudioViewModel : ViewModel, IStudioViewModel
    {
        private bool _isVisible;
        /// <summary>
        /// Gets or sets a value indicating whether this view model view's is visible.
        /// </summary>
        public bool IsVisible
        {
            get { return _isVisible; }
            set { _isVisible = value; RaisePropertyChangedAuto(); }
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="StudioViewModel{Module}"/> class.
        /// </summary>
        public StudioViewModel() : base()
        {

        }

        /// <summary>
        /// Called when the user has navigated out of this view model.
        /// </summary>
        public virtual void OnNavigatedFrom()
        {
            IsVisible = false;
        }

        /// <summary>
        /// Called when the user has navigated in to this view model.
        /// </summary>
        public virtual void OnNavigatedTo()
        {
            IsVisible = true;
        }

        /// <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>
        /// Called when the application has been started
        /// </summary>
        public virtual void OnApplicationStarted()
        {

        }

        /// <summary>
        /// Called when the application is ready and all modules are loaded.
        /// </summary>
        public abstract void OnApplicationReady();
    }

    /// <summary>
    /// Represents a Machine Studio view model with a support for a view contract.
    /// </summary>
    /// <typeparam name="TView"></typeparam>
    /// <seealso cref="Tango.SharedUI.ViewModel" />
    public abstract class StudioViewModel<TView> : StudioViewModel where TView : IView
    {
        /// <summary>
        /// Gets the view model's view.
        /// </summary>
        public TView View { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="StudioViewModel{TView}"/> class.
        /// </summary>
        public StudioViewModel() : base()
        {
            TangoIOC.Default.GetInstanceWhenAvailable<TView>((view) => 
            {
                View = view;
                OnViewAttached(view);
            });
        }

        /// <summary>
        /// Called when the view has been attached
        /// </summary>
        /// <param name="view">The view.</param>
        protected virtual void OnViewAttached(TView view)
        {
            //Do Nothing.
        }
    }
}