aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs')
-rw-r--r--Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs25
1 files changed, 25 insertions, 0 deletions
diff --git a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
index 902a45a2f..21377fb5f 100644
--- a/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
+++ b/Software/Visual_Studio/MachineStudio/Tango.MachineStudio.Common/IStudioModule.cs
@@ -9,20 +9,45 @@ using Tango.DAL.Observables;
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.
+ /// </summary>
FrameworkElement MainView { get; }
+ /// <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();
}
}