nuclex-shared-dotnet/Nuclex.Windows.Forms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

The ProgressReporterForm was still referring to "progressions" (old name for the request class) in some places - fixed; improved code documentation

Browse Source 
git-svn-id: file:///srv/devel/repo-conversion/nuwi@25 d2e56fa2-650e-0410-a79f-9358c0239efd
This commit is contained in:
Markus Ewald 2008-10-29 20:50:55 +00:00
parent 39f1e6a4c9
commit 4c24b82836
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Source/ProgressReporter/ProgressReporterForm.cs
View File

@ -14,7 +14,7 @@ namespace Nuclex.Windows.Forms {
/// <summary> /// <summary>
/// Blocking progress dialog that prevents the user from accessing the application /// Blocking progress dialog that prevents the user from accessing the application
/// window during all-blocking background processes. /// window during a modal asynchronous processes.
/// </summary> /// </summary>
/// <example> /// <example>
/// class Test : Nuclex.Support.Scheduling.ThreadOperation { /// class Test : Nuclex.Support.Scheduling.ThreadOperation {
@ -58,25 +58,27 @@ namespace Nuclex.Windows.Forms {
/// <param name="windowTitle"> /// <param name="windowTitle">
/// Text to be shown in the progress reporter's title bar /// Text to be shown in the progress reporter's title bar
/// </param> /// </param>
/// <param name="progression"> /// <param name="waitable">
/// Progression for whose duration to show the progress reporter /// Process for whose duration to show the progress reporter
/// </param> /// </param>
public static void Track(string windowTitle, Waitable progression) { public static void Track(string windowTitle, Waitable waitable) {
// Small optimization to avoid the lengthy control creation when // Small optimization to avoid the lengthy control creation when the waitable
// the progression has already ended // process has already ended. This is an accepted race condition: If the process
if(progression.Ended) // finishes right after this line, it doesn't change the outcome, it just
// causes the progress dialog to be constructed needlessly.
if(waitable.Ended)
return; return;
// Open the form and let it monitor the progression's state // Open the form and let it monitor the progression's state
using(ProgressReporterForm theForm = new ProgressReporterForm()) { using(ProgressReporterForm theForm = new ProgressReporterForm()) {
theForm.track(windowTitle, progression); theForm.track(windowTitle, waitable);
} }
} }
/// <summary>Called when the user tries to close the form manually</summary> /// <summary>Called when the user tries to close the form manually</summary>
/// <param name="e">Contains flag that can be used to abort the close attempt</param> /// <param name="e">Contains a flag that can be used to abort the close attempt</param>
protected override void OnClosing(CancelEventArgs e) { protected override void OnClosing(CancelEventArgs e) {
base.OnClosing(e); base.OnClosing(e);
@ -91,40 +93,42 @@ namespace Nuclex.Windows.Forms {
/// <param name="windowTitle"> /// <param name="windowTitle">
/// Text to be shown in the progress reporter's title bar /// Text to be shown in the progress reporter's title bar
/// </param> /// </param>
/// <param name="progression"> /// <param name="waitable">
/// Progression for whose duration to show the progress reporter /// Waitable for whose duration to show the progress reporter
/// </param> /// </param>
private void track(string windowTitle, Waitable progression) { private void track(string windowTitle, Waitable waitable) {
// Set the window title if the user wants to use a custom one // Set the window title if the user wants to use a custom one
if(windowTitle != null) if(windowTitle != null)
Text = windowTitle; Text = windowTitle;
// Only enable the cancel button if the progression can be aborted // Only enable the cancel button if the progression can be aborted
this.abortReceiver = (progression as IAbortable); this.abortReceiver = (waitable as IAbortable);
this.cancelButton.Enabled = (this.abortReceiver != null); this.cancelButton.Enabled = (this.abortReceiver != null);
// Make sure the progress bar control has been created (otherwise, we've got // Make sure the progress bar control has been created (otherwise, we've got
// a chance that BeginInvoke() would fail if the first progress notification // a chance that BeginInvoke() would fail if the first progress notification
// arrived before we called ShowDialog()!) // arrived before we called ShowDialog()!)
IntPtr tempDummy = this.progressBar.Handle; { IntPtr tempDummy = this.progressBar.Handle; }
// Subscribe the form to the progression it is supposed to monitor // Subscribe the form to the progression it is supposed to monitor.
progression.AsyncEnded += this.asyncEndedDelegate; // Careful: With the new 'Waitable' design, this can cause the asyncEndedDelegate
IProgressReporter progressReporter = progression as IProgressReporter; // callback to be called immediately and synchronously!
waitable.AsyncEnded += this.asyncEndedDelegate;
IProgressReporter progressReporter = waitable as IProgressReporter;
if(progressReporter != null) if(progressReporter != null)
progressReporter.AsyncProgressChanged += this.asyncProgressChangedDelegate; progressReporter.AsyncProgressChanged += this.asyncProgressChangedDelegate;
// The progression might have ended before this line was reached, if that's // The progression might have ended before this line was reached, if that's
// the case, we don't show the dialog at all. // the case, we don't show the dialog at all.
if(!progression.Ended) if(!waitable.Ended)
ShowDialog(); ShowDialog();
// We're done, unsubscribe from the progression's events again // We're done, unsubscribe from the progression's events again
progressReporter = progression as IProgressReporter; progressReporter = waitable as IProgressReporter;
if(progressReporter != null) if(progressReporter != null)
progressReporter.AsyncProgressChanged -= this.asyncProgressChangedDelegate; progressReporter.AsyncProgressChanged -= this.asyncProgressChangedDelegate;
progression.AsyncEnded -= this.asyncEndedDelegate; waitable.AsyncEnded -= this.asyncEndedDelegate;
} }