Catel - Part 4 of n: Unit testing with Catel

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="IPleaseWaitService.cs" company="Catel development team">
//   Copyright (c) 2008 - 2011 Catel development team. All rights reserved.
// </copyright>
// <summary>
//   Interface for the Please Wait service.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Catel.MVVM.Services
{
    /// <summary>
    /// Please wait work delegate.
    /// </summary>
    public delegate void PleaseWaitWorkDelegate();

    /// <summary>
    /// Interface for the Please Wait service.
    /// </summary>
    public interface IPleaseWaitService
    {
        #region Methods
        /// <summary>
        /// Shows the please wait window with the default status text.
        /// </summary>
        /// <remarks>
        /// When this method is used, the <see cref="Hide"/> method must be called to hide the window again.
        /// </remarks>
        void Show();

        /// <summary>
        /// Shows the please wait window with the specified status text.
        /// </summary>
        /// <param name="status">The status.</param>
        /// <remarks>
        /// When this method is used, the <see cref="Hide"/> method must be called to hide the window again.
        /// </remarks>
        void Show(string status);

        /// <summary>
        /// Shows the please wait window with the default status text and executes the work delegate (in a background thread). When the work
        /// is finished, the please wait window will be automatically closed.
        /// </summary>
        /// <param name="workDelegate">The work delegate.</param>
        void Show(PleaseWaitWorkDelegate workDelegate);

        /// <summary>
        /// Shows the please wait window with the specified status text and executes the work delegate (in a background thread). When the work 
        /// is finished, the please wait window will be automatically closed.
        /// </summary>
        /// <param name="workDelegate">The work delegate.</param>
        /// <param name="status">The status.</param>
        void Show(PleaseWaitWorkDelegate workDelegate, string status);

        /// <summary>
        /// Updates the status text.
        /// </summary>
        /// <param name="status">The status.</param>
        void UpdateStatus(string status);

        /// <summary>
        /// Updates the status.
        /// </summary>
        /// <param name="status">The status.</param>
        /// <param name="width">The width.</param>
        void UpdateStatus(string status, int width);

        /// <summary>
        /// Hides this please wait window.
        /// </summary>
        void Hide();
        #endregion
    }
}