source: branches/2965_CancelablePersistence/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs @ 16433

Last change on this file since 16433 was 16433, checked in by pfleck, 8 months ago

#2965 Merged recent trunk changes.
Enabled the prepared hooks that allows to cancel the save file using the recently introduced cancelable progressbars (in FileManager).

File size: 2.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using HeuristicLab.Common;
24
25namespace HeuristicLab.MainForm {
26  public enum ProgressState { Started, Finished, StopRequested, CancelRequested }
27  public enum ProgressMode { Determinate, Indeterminate }
28
29  public interface IProgress : IContent {
30    ProgressState ProgressState { get; }
31
32    string Message { get; set; }
33
34    ProgressMode ProgressMode { get; set; }
35    /// <summary>
36    /// Gets or sets the currently associated progress value in the range [0;1] (values outside the range are truncated).
37    /// Changing the ProgressValue when <c>ProgressMode</c> is <c>Indeterminate</c> raises an Exception.
38    /// </summary>
39    /// <exception cref="InvalidOperationException">Setting the ProgressValue-property while in the Indeterminate state is invalid.</exception>
40    double ProgressValue { get; set; }
41
42    bool CanBeStopped { get; set; }
43    bool CanBeCanceled { get; set; }
44
45    void Start(string message, ProgressMode mode = ProgressMode.Determinate);
46    void Finish();
47    void Stop();
48    void Cancel();
49
50    event EventHandler ProgressStateChanged;
51    event EventHandler MessageChanged;
52    event EventHandler ProgressBarModeChanged;
53    event EventHandler ProgressValueChanged;
54    event EventHandler CanBeStoppedChanged;
55    event EventHandler CanBeCanceledChanged;
56    event EventHandler StopRequested;
57    event EventHandler CancelRequested;
58  }
59}
Note: See TracBrowser for help on using the repository browser.