Changeset 15477 for branches/EnhancedProgress/HeuristicLab.MainForm.WindowsForms

Timestamp:

11/16/17 10:30:21 (6 years ago)

Author:

pfleck

Message:

#2845

• Added an explicit method for StartMarquee.
• Renamed Add/RemoveOperationProgress methods.
• Moved progress helpers from MainForm into static Progress methods named Show and Hide.

Location:

branches/EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3

Files:

• HeuristicLab.MainForm.WindowsForms-3.3.csproj (modified) (1 diff)
• MainForms/MainForm.cs (modified) (5 diffs)
• Progress.cs (moved) (moved from branches/EnhancedProgress/HeuristicLab.MainForm/3.3/Progress.cs) (3 diffs)

branches/EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3/HeuristicLab.MainForm.WindowsForms-3.3.csproj

@@ -151 +151 @@
     </Compile>
     <Compile Include="Plugin.cs" />
+    <Compile Include="Progress.cs" />
     <Compile Include="Views\AsynchronousContentView.cs">
       <SubType>UserControl</SubType>

branches/EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3/MainForms/MainForm.cs

@@ -350 +350 @@
     private readonly List<ProgressView> progressViews = new List<ProgressView>();
 
-    public IProgress AddOperationProgressToContent(IContent content, string progressMessage, double? initialProgressValue = null, bool addToObjectGraphObjects = true) {
-      var progress = new Progress();
-      if (initialProgressValue.HasValue)
-        progress.Start(progressMessage, initialProgressValue.Value);
-      else
-        progress.Start(progressMessage);
-      AddOperationProgressToContent(content, progress, addToObjectGraphObjects);
-      return progress;
-    }
     /// <summary>
     /// Adds a <see cref="ProgressView"/> to the <see cref="ContentView"/>s showing the specified content.
     /// </summary>
-    public void AddOperationProgressToContent(IContent content, IProgress progress, bool addToObjectGraphObjects = true) {
+    public void AddProgressToContent(IContent content, IProgress progress, bool addToObjectGraphObjects = true) {
       if (InvokeRequired) {
-        Invoke((Action<IContent, IProgress, bool>)AddOperationProgressToContent, content, progress, addToObjectGraphObjects);
+        Invoke((Action<IContent, IProgress, bool>)AddProgressToContent, content, progress, addToObjectGraphObjects);
         return;
       }
@@ -387 +378 @@
     }
 
-    public IProgress AddOperationProgressToView(Control control, string progressMessage, double? initialProgressValue = null) {
-      var progress = new Progress();
-      if (initialProgressValue.HasValue)
-        progress.Start(progressMessage, initialProgressValue.Value);
-      else
-        progress.Start(progressMessage);
-      AddOperationProgressToView(control, progress);
-      return progress;
-    }
     /// <summary>
     /// Adds a <see cref="ProgressView"/> to the specified view.
     /// </summary>
-    public void AddOperationProgressToView(Control control, IProgress progress) {
+    public void AddProgressToView(Control control, IProgress progress) {
       if (InvokeRequired) {
-        Invoke((Action<Control, IProgress>)AddOperationProgressToView, control, progress);
+        Invoke((Action<Control, IProgress>)AddProgressToView, control, progress);
         return;
       }
@@ -423 +405 @@
     /// Removes an existing <see cref="ProgressView"/> from the <see cref="ContentView"/>s showing the specified content.
     /// </summary>
-    public void RemoveOperationProgressFromContent(IContent content, bool finishProgress = true) {
+    public void RemoveProgressFromContent(IContent content, bool finishProgress = true) {
       if (InvokeRequired) {
-        Invoke((Action<IContent, bool>)RemoveOperationProgressFromContent, content, finishProgress);
+        Invoke((Action<IContent, bool>)RemoveProgressFromContent, content, finishProgress);
         return;
       }
@@ -439 +421 @@
       }
       contentProgressLookup.Remove(content);
-
     }
 
@@ -445 +426 @@
     /// Removes an existing <see cref="ProgressView"/> from the specified view.
     /// </summary>
-    public void RemoveOperationProgressFromView(Control control, bool finishProgress = true) {
+    public void RemoveProgressFromView(Control control, bool finishProgress = true) {
       if (InvokeRequired) {
-        Invoke((Action<Control, bool>)RemoveOperationProgressFromView, control, finishProgress);
+        Invoke((Action<Control, bool>)RemoveProgressFromView, control, finishProgress);
         return;
       }

branches/EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3/Progress.cs

@@ -21 +21 @@
 
 using System;
+using System.Windows.Forms;
+using HeuristicLab.Common;
 
 namespace HeuristicLab.MainForm {
@@ -100 +102 @@
     }
 
-    /// <summary>
-    /// Starts or restarts an "undefined" progress in marquee-mode
-    /// </summary>
-    public void Start(string message) {
-      ProgressState = ProgressState.Started;
-      ProgressBarMode = ProgressBarMode.Marquee;
-      Message = message;
-    }
-    /// <summary>
-    /// Starts or restarts a progress in continuous-mode
-    /// </summary>
-    public void Start(string message, double progressValue) {
+    public void Start(string message, double progressValue = 0) {
       ProgressState = ProgressState.Started;
       ProgressBarMode = ProgressBarMode.Continuous;
       ProgressValue = progressValue;
+      Message = message;
+    }
+    public void StartMarquee(string message) {
+      ProgressState = ProgressState.Started;
+      ProgressBarMode = ProgressBarMode.Marquee;
       Message = message;
     }
@@ -137 +133 @@
     }
 
+    #region Show/Hide Progress
+    /// <summary>
+    /// Shows a started Progress in Continuous-mode on all Views of the specified content.
+    /// </summary>
+    public static IProgress Show(IContent content, string progressMessage, double initialProgressValue = 0, bool addToObjectGraphObjects = true) {
+      var progress = new Progress();
+      progress.Start(progressMessage, initialProgressValue);
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToContent(content, progress, addToObjectGraphObjects);
+      return progress;
+    }
+    /// <summary>
+    /// Shows a started Progress in Marquee-mode on all Views of the specified content.
+    /// </summary>
+    public static IProgress ShowMarquee(IContent content, string progressMessage, bool addToObjectGraphObjects = true) {
+      var progress = new Progress();
+      progress.StartMarquee(progressMessage);
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToContent(content, progress, addToObjectGraphObjects);
+      return progress;
+    }
+
+    /// <summary>
+    /// Shows a started Progress in Continuous-mode on the specified view.
+    /// </summary>
+    public static IProgress Show(Control control, string progressMessage, double initialProgressValue = 0) {
+      var progress = new Progress();
+      progress.Start(progressMessage, initialProgressValue);
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToView(control, progress);
+      return progress;
+    }
+    /// <summary>
+    /// Shows a started Progress in Marquee-mode on the specified view.
+    /// </summary>
+    public static IProgress ShowMarquee(Control control, string progressMessage) {
+      var progress = new Progress();
+      progress.StartMarquee(progressMessage);
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToView(control, progress);
+      return progress;
+    }
+
+    /// <summary>
+    /// Hides the Progress fom all Views of the specified content.
+    /// </summary>
+    public static void Hide(IContent content) {
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().RemoveProgressFromContent(content);
+    }
+    /// <summary>
+    /// Hides the Progress fom the specified view.
+    /// </summary>
+    public static void Hide(Control control) {
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().RemoveProgressFromView(control);
+    }
+    #endregion
+
     #region Event Handler
     public event EventHandler ProgressStateChanged;