Changeset 16317 for branches/2845_EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs

Timestamp:

11/22/18 12:37:04 (5 years ago)

Author:

pfleck

Message:

#2845 Combined separate Show methods into single one with enum parameter specifying the ProgressMode. Renamed Continuous and Marquee to Determinate and Indeterminate.

File:

• branches/2845_EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs (modified) (1 diff)

branches/2845_EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs

@@ -25 +25 @@
 namespace HeuristicLab.MainForm {
   public enum ProgressState { Started, Finished, StopRequested, CancelRequested }
-  public enum ProgressBarMode { Continuous, Marquee }
+  public enum ProgressMode { Determinate, Indeterminate }
 
   public interface IProgress : IContent {
     ProgressState ProgressState { get; }
+
     string Message { get; set; }
-    ProgressBarMode ProgressBarMode { get; set; }
+
+    ProgressMode ProgressMode { get; set; }
     /// <summary>
     /// Gets or sets the currently associated progress value in the range [0;1] (values outside the range are truncated).
-    /// Changing the ProgressValue when ProgressBarMode is Marquee raises an Exception.
+    /// Changing the ProgressValue when <c>ProgressMode</c> is <c>Indeterminate</c> raises an Exception.
     /// </summary>
-    /// <exception cref="InvalidOperationException">Setting the ProgressValue-property while in the Marquee state is invalid.</exception>
+    /// <exception cref="InvalidOperationException">Setting the ProgressValue-property while in the Indeterminate state is invalid.</exception>
     double ProgressValue { get; set; }
-    bool CanBeStopped { get; }
-    bool CanBeCanceled { get; }
 
-    /// <summary>
-    /// Start (or Restart) a progress in ProgressBarMode Continues to display specific progress values (from 0 to 1).
-    /// A new progress value is reported by setting the ProgressValue-property.
-    /// </summary>
-    void Start(string message, double progressValue = 0);
+    bool CanBeStopped { get; set; }
+    bool CanBeCanceled { get; set; }
 
-    /// <summary>
-    /// Start (or Restart) a progress in ProgressBarMode Marquee to define an "unknown" progress state.
-    /// Consider using marquee when the progress is not measurable but the user should be notified that something is still happening.
-    /// Setting the ProgressValue-property in the Marquee state throws an exception.
-    /// </summary>
-    void StartMarquee(string message);
-
+    void Start(string message, ProgressMode mode = ProgressMode.Determinate);
     void Finish();
     void Stop();