AViD

#region Using Statements

using System;
using System.Collections.Generic;
using System.Text;

#endregion Using Statements

namespace AViD
{
  /// <summary>
  ///   The <see cref="IWorker"/> interface is used to interact with a
  ///   threaded operation.
  /// </summary>
  public interface IWorker
  {
    #region Public Properties

    /// <summary>
    ///   Gets/sets whether or not the events are enabled.
    /// </summary>
    bool EnableEvents
    {
      get;
      set;
    }
    /// <summary>
    ///   Gets whether or not the IWorker is working.
    /// </summary>
    bool IsWorking
    {
      get;
    }

    #endregion Public Properties

    #region Public Methods

    /// <summary>
    ///   Attempts to abort the current task.
    /// </summary>
    void Abort();
    /// <summary>
    ///   Performs the work asynchronously.
    /// </summary>
    void Work();

    #endregion Public Methods

    #region Events/Delegates

    /// <summary>
    ///   Handles the event at which the IWorker is done.
    /// </summary>
    event EventHandler Complete;
    /// <summary>
    ///   Handles the event at which the IWorker has a progress message for an external body.
    /// </summary>
    event EventHandler<ProgressEventArgs> Progress;

    #endregion Events/Delegates
  }
}