aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Scripting/Tango.Scripting/GlobalObject.cs
blob: 4cac65ef652d097bcc69ccd62c4d3a7c7474cfec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Scripting
{
    public class GlobalObject : IDisposable
    {
        public GlobalObject()
        {
           
        }

        public virtual void Dispose()
        {
            
        }
    }
}
background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Media.Imaging;
using Tango.Core;
using Tango.BL.Entities;
using Tango.BL.Enumerations;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a base class for studio modules.
    /// </summary>
    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
    public abstract class StudioModuleBase : ExtendedObject, IStudioModule
    {
        private bool _isInitialized;
        private bool _isLoaded;

        /// <summary>
        /// Occurs when the user has navigated into or out of this module.
        /// </summary>
        public event EventHandler<bool> IsLoadedChanged;

        /// <summary>
        /// Gets the module name.
        /// </summary>
        public abstract string Name { get; }

        /// <summary>
        /// Gets the module description.
        /// </summary>
        public abstract string Description { get; }

        /// <summary>
        /// Gets the module cover image.
        /// </summary>
        public abstract BitmapSource Image { get; }

        /// <summary>
        /// Gets the module entry point view type.
        /// </summary>
        public abstract Type MainViewType { get; }

        /// <summary>
        /// Gets the permission required to see and load this module.
        /// </summary>
        public abstract Permissions Permission { get; }

        /// <summary>
        /// Gets a value indicating whether this module has been initialized.
        /// </summary>
        public bool IsInitialized
        {
            get
            {
                return _isInitialized;
            }
            private set
            {
                _isInitialized = value;
            }
        }

        /// <summary>
        /// Sets a value indicating whether this module is loaded.
        /// </summary>
        public bool IsLoaded
        {
            get
            {
                return _isLoaded;
            }
            set
            {
                _isLoaded = value;
                IsLoadedChanged?.Invoke(this, value);
            }
        }

        private bool _inNewWindow;
        /// <summary>
        /// Gets or sets a value indicating whether this module is shown under a new window.
        /// </summary>
        public bool InNewWindow
        {
            get { return _inNewWindow; }
            set { _inNewWindow = value; RaisePropertyChangedAuto(); }
        }

        /// <summary>
        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
        /// </summary>
        public abstract void Dispose();

        /// <summary>
        /// Perform any operations required to initialize this module.
        /// </summary>
        public void Initialize()
        {
            OnInitialized();
            IsInitialized = true;
        }

        /// <summary>
        /// Called when machine studio initializes this module.
        /// </summary>
        protected virtual void OnInitialized()
        {

        }

        /// <summary>
        /// Raises the <see cref="IsLoadedChanged"/> event.
        /// </summary>
        /// <param name="loaded">if set to <c>true</c> the module is loaded.</param>
        protected virtual void OnLoadedChanged(bool loaded)
        {

        }
    }
}