Changeset 16318 for branches/2845_EnhancedProgress/HeuristicLab.MainForm.WindowsForms

Timestamp:

11/22/18 15:17:42 (6 years ago)

Author:

pfleck

Message:

#2845 Add optional stop and cancel handler to the Show helpers. Replaced the AddProgressTo... and RemoveProgressFrom... methods with the existing Show and Hide methods.

Location:

branches/2845_EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3

Files:

• MainForms/MainForm.cs (modified) (3 diffs)
• Progress.cs (modified) (2 diffs)

branches/2845_EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3/MainForms/MainForm.cs

@@ -353 +353 @@
     /// Adds a <see cref="ProgressView"/> to the <see cref="ContentView"/>s showing the specified content.
     /// </summary>
-    internal void AddProgressToContent(IContent content, IProgress progress, bool addToObjectGraphObjects = true) {
+    internal void AddProgressToContent(IContent content, IProgress progress, bool addToObjectGraphObjects) {
       if (InvokeRequired) {
         Invoke((Action<IContent, IProgress, bool>)AddProgressToContent, content, progress, addToObjectGraphObjects);
@@ -405 +405 @@
     /// Removes an existing <see cref="ProgressView"/> from the <see cref="ContentView"/>s showing the specified content.
     /// </summary>
-    internal void RemoveProgressFromContent(IContent content, bool finishProgress = true) {
+    internal void RemoveProgressFromContent(IContent content, bool finishProgress) {
       if (InvokeRequired) {
         Invoke((Action<IContent, bool>)RemoveProgressFromContent, content, finishProgress);
@@ -426 +426 @@
     /// Removes an existing <see cref="ProgressView"/> from the specified view.
     /// </summary>
-    internal void RemoveProgressFromControl(Control control, bool finishProgress = true) {
+    internal void RemoveProgressFromControl(Control control, bool finishProgress) {
       if (InvokeRequired) {
         Invoke((Action<Control, bool>)RemoveProgressFromControl, control, finishProgress);

branches/2845_EnhancedProgress/HeuristicLab.MainForm.WindowsForms/3.3/Progress.cs

@@ -129 +129 @@
     }
 
-    #region Show/Hide Progress
+    #region Show and Hide Progress
     /// <summary>
     /// Shows a started Progress on all Views of the specified content.
     /// </summary>
-    public static IProgress Show(IContent content, string progressMessage, ProgressMode mode = ProgressMode.Determinate, bool addToObjectGraphObjects = true) {
+    public static IProgress Show(IContent content, string progressMessage, ProgressMode mode = ProgressMode.Determinate, Action stopRequestHandler = null, Action cancelRequestHandler = null, bool addToObjectGraphObjects = true) {
+      var progress = CreateAndStartProgress(progressMessage, mode, stopRequestHandler, cancelRequestHandler);
+      Show(content, progress, addToObjectGraphObjects);
+      return progress;
+    }
+
+    /// <summary>
+    /// Shows a started Progress on the specified view.
+    /// </summary>
+    public static IProgress Show(IView view, string progressMessage, ProgressMode mode = ProgressMode.Determinate, Action stopRequestHandler = null, Action cancelRequestHandler = null) {
+      var progress = CreateAndStartProgress(progressMessage, mode, stopRequestHandler, cancelRequestHandler);
+      Show(view, progress);
+      return progress;
+    }
+    /// <summary>
+    /// Shows a started Progress on the specified control.
+    /// </summary>
+    /// <remarks>For backwards compatibility. Use Progress.Show(IView, ...) if possible.</remarks>
+    public static IProgress ShowOnControl(Control control, string progressMessage, ProgressMode mode = ProgressMode.Determinate, Action stopRequestHandler = null, Action cancelRequestHandler = null) {
+      var progress = CreateAndStartProgress(progressMessage, mode, stopRequestHandler, cancelRequestHandler);
+      ShowOnControl(control, progress);
+      return progress;
+    }
+
+    private static IProgress CreateAndStartProgress(string progressMessage, ProgressMode mode, Action stopRequestHandler, Action cancelRequestHandler) {
       var progress = new Progress();
+      if (stopRequestHandler != null) {
+        progress.CanBeStopped = true;
+        progress.StopRequested += (s, a) => stopRequestHandler();
+      }
+      if (cancelRequestHandler != null) {
+        progress.CanBeCanceled = true;
+        progress.CancelRequested += (s, a) => cancelRequestHandler();
+      }
       progress.Start(progressMessage, mode);
-      AddProgressToContent(content, progress, addToObjectGraphObjects);
-      return progress;
-    }
-
-    /// <summary>
-    /// Shows a started Progress on the specified view.
-    /// </summary>
-    public static IProgress Show(IView view, string progressMessage, ProgressMode mode = ProgressMode.Determinate) {
-      var progress = new Progress();
-      progress.Start(progressMessage, mode);
-      AddProgressToView(view, progress);
-      return progress;
-    }
-    /// <summary>
-    /// Shows a started Progress on the specified control.
-    /// </summary>
-    /// <remarks>Use Progress.Show(IView, ...) if possible.</remarks>
-    public static IProgress ShowOnControl(Control control, string progressMessage, ProgressMode mode = ProgressMode.Determinate) {
-      var progress = new Progress();
-      progress.Start(progressMessage, mode);
-      AddProgressToControl(control, progress);
+      return progress;
+    }
+
+    /// <summary>
+    /// Shows an existing progress on all Views of the specified content.
+    /// </summary>
+    public static IProgress Show(IContent content, IProgress progress, bool addToObjectGraphObjects = true) {
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToContent(content, progress, addToObjectGraphObjects);
+      return progress;
+    }
+    /// <summary>
+    /// Shows an existing progress on the specified View.
+    /// </summary>
+    public static IProgress Show(IView view, IProgress progress) {
+      return ShowOnControl((Control)view, progress);
+    }
+    /// <summary>
+    /// Shows an existing progress on the specified control.
+    /// </summary>
+    /// <remarks>For backwards compatibility. Use Progress.Show(IView, ...) if possible.</remarks>
+    public static IProgress ShowOnControl(Control control, IProgress progress) {
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToControl(control, progress);
       return progress;
     }
@@ -163 +196 @@
     /// Hides the Progress from all Views of the specified content.
     /// </summary>
-    public static void Hide(IContent content) {
-      RemoveProgressFromContent(content);
+    public static void Hide(IContent content, bool finishProgress = true) {
+      MainFormManager.GetMainForm<WindowsForms.MainForm>().RemoveProgressFromContent(content, finishProgress);
     }
     /// <summary>
     /// Hides the Progress from the specified view.
     /// </summary>
-    public static void Hide(IView view) {
-      RemoveProgressFromView(view);
+    public static void Hide(IView view, bool finishProgress = true) {
+      HideFromControl((Control)view, finishProgress);
     }
     /// <summary>
     /// Hides the Progress from the specified control.
     /// </summary>
-    /// <remarks>Use Progress.Hide(IView) if possible.</remarks>
-    public static void HideFromControl(Control control) {
-      RemoveProgressFromControl(control);
-    }
-    #endregion
-
-    #region Interface to MainForm
-    public static IProgress AddProgressToContent(IContent content, IProgress progress, bool addToObjectGraphObjects = true) {
-      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToContent(content, progress, addToObjectGraphObjects);
-      return progress;
-    }
-    public static IProgress AddProgressToView(IView view, IProgress progress) {
-      //return AddProgressToControl(MainFormManager.GetMainForm<WindowsForms.MainForm>().GetForm(view), progress);
-      return AddProgressToControl((Control)view, progress);
-    }
-    public static IProgress AddProgressToControl(Control control, IProgress progress) {
-      MainFormManager.GetMainForm<WindowsForms.MainForm>().AddProgressToControl(control, progress);
-      return progress;
-    }
-
-    public static void RemoveProgressFromContent(IContent content, bool finishProgress = true) {
-      MainFormManager.GetMainForm<WindowsForms.MainForm>().RemoveProgressFromContent(content, finishProgress);
-    }
-    public static void RemoveProgressFromView(IView view, bool finishProgress = true) {
-      //RemoveProgressFromControl(MainFormManager.GetMainForm<WindowsForms.MainForm>().GetForm(view), finishProgress);
-      RemoveProgressFromControl((Control)view, finishProgress);
-    }
-    public static void RemoveProgressFromControl(Control control, bool finishProgress = true) {
+    /// <remarks>For backwards compatibility. Use Progress.Hide(IView) if possible.</remarks>
+    public static void HideFromControl(Control control, bool finishProgress = true) {
       MainFormManager.GetMainForm<WindowsForms.MainForm>().RemoveProgressFromControl(control, finishProgress);
     }