source: branches/2845_EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs @ 16311

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using HeuristicLab.Common;

namespace HeuristicLab.MainForm {
  public enum ProgressState { Started, Finished, StopRequested, CancelRequested }
  public enum ProgressBarMode { Continuous, Marquee }

  public interface IProgress : IContent {
    ProgressState ProgressState { get; }
    string Message { get; set; }
    ProgressBarMode ProgressBarMode { 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.
    /// </summary>
    /// <exception cref="InvalidOperationException">Setting the ProgressValue-property while in the Marquee 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);

    /// <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 Finish();
    void Stop();
    void Cancel();

    event EventHandler ProgressStateChanged;
    event EventHandler MessageChanged;
    event EventHandler ProgressBarModeChanged;
    event EventHandler ProgressValueChanged;
    event EventHandler CanBeStoppedChanged;
    event EventHandler CanBeCanceledChanged;
    event EventHandler StopRequested;
    event EventHandler CancelRequested;
  }
}