aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
blob: 6963892fa0a5596010377564a90ec77f661cd361 (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
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.BL.Entities;
using Tango.BL.Enumerations;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a Machine Studio module.
    /// </summary>
    /// <seealso cref="System.IDisposable" />
    public interface IStudioModule : IDisposable
    {
        /// <summary>
        /// Gets the module name.
        /// </summary>
        String Name { get; }

        /// <summary>
        /// Gets the module description.
        /// </summary>
        String Description { get; }

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

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

        /// <summary>
        /// Gets or sets a value indicating whether this module is shown under a new window.
        /// </summary>
        bool InNewWindow { get; set; }

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

        /// <summary>
        /// Gets a value indicating whether this module has been initialized.
        /// </summary>
        bool IsInitialized { get; }

        /// <summary>
        /// Perform any operations required to initialize this module.
        /// </summary>
        void Initialize();

        /// <summary>
        /// Sets a value indicating whether this module is loaded.
        /// </summary>
        bool IsLoaded { set; get; }
    }
}