Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/StudioViewModel.cs

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 StudioViewModelInternal : ViewModel, IStudioViewModel
    {
        public bool IsVisible { get; private set; }

        /// <summary>
        /// Gets or sets a value indicating whether this view model studio module is currently loaded.
        /// </summary>
        public bool IsModuleLoaded { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="StudioViewModel{Module}"/> class.
        /// </summary>
        public StudioViewModelInternal() : 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()
        {
            IsVisible = false;
            IsModuleLoaded = false;
        }

        /// <summary>
        /// Called when the user has navigated in to the module.
        /// </summary>
        public virtual void OnNavigatedTo()
        {
            IsVisible = true;
            IsModuleLoaded = 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>
    /// 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
    {
        public bool IsVisible { get; private set; }

        /// <summary>
        /// Gets or sets a value indicating whether this view model studio module is currently loaded.
        /// </summary>
        public bool IsModuleLoaded { get; private set; }

        /// <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()
        {
            IsVisible = false;
            IsModuleLoaded = false;
        }

        /// <summary>
        /// Called when the user has navigated in to the module.
        /// </summary>
        public virtual void OnNavigatedTo()
        {
            IsVisible = true;
            IsModuleLoaded = 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>
    /// 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 the application has been started
        /// </summary>
        public virtual void OnApplicationStarted()
        {

        }

        /// <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()
        {

        }
    }
}