//Except where stated all code and programs in this project are the copyright of Jim Blackler, 2008.
//jimblackler@gmail.com
//
//This is free software. Libraries and programs are distributed under the terms of the GNU Lesser
//General Public License. Please see the files COPYING and COPYING.LESSER.

using System;
using System.ComponentModel;
using System.Windows.Forms;

namespace MiscControls
{
    /// <summary>
    /// Provides background worker functionality combined with a progress bar and status message.
    /// </summary>
    public partial class VisualBackgroundWorker : UserControl
    {
        /// <summary>
        /// Gets a value indicating whether the application has requested cancellation
        /// of the background operation.
        /// </summary>
        [Browsable(false)]
        public bool CancellationPending
        {
            get
            {
                return backgroundWorker1.CancellationPending;
            }
        }

        /// <summary>
        /// Gets a value indicating whether the System.ComponentModel.BackgroundWorker
        /// is running an asynchronous operation.
        /// </summary>
        [Browsable(false)]
        public bool IsBusy
        {
            get
            {
                return backgroundWorker1.IsBusy;
            }
        }

        /// <summary>
        /// Gets or sets a value indicating whether the System.ComponentModel.BackgroundWorker
        /// supports asynchronous cancellation.
        /// </summary>
        [Category("Worker")]
        [DefaultValue(false)]
        public bool WorkerSupportsCancellation
        {
            get
            {
                return backgroundWorker1.WorkerSupportsCancellation;
            }

            set
            {
                backgroundWorker1.WorkerSupportsCancellation = value;
            }
        }

        /// <summary>
        /// Perform the background worker's async operation.
        /// </summary>
        [Category("Worker")]
        public event DoWorkEventHandler DoWork
        {
            add
            {
                doWork += value;
            }
            remove
            {
                doWork -= value;
            }
        }

        private DoWorkEventHandler doWork;

        private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            if (doWork != null)
            {
                doWork.Invoke(this, e);
            }
        }

        /// <summary>
        /// Fires when the progress on the background worker is changed.
        /// </summary>
        [Category("Worker")]
        public event ProgressChangedEventHandler ProgressChanged
        {
            add
            {
                progressChanged += value;
            }
            remove
            {
                progressChanged -= value;
            }
        }

        private ProgressChangedEventHandler progressChanged;

        private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            progressBar1.Value = e.ProgressPercentage;
            label1.Text = (string)e.UserState;
            if (progressChanged != null)
            {
                progressChanged.Invoke(this, e);
            }
        }

        /// <summary>
        /// The text currently displayed by the visual background worker (read only, set with ReportProgress).
        /// </summary>
        public override string Text
        {
            get { return label1.Text; }
        }
	
        /// <summary>
        /// Fires when the background event is reported complete.
        /// </summary>
        [Category("Worker")]
        public event RunWorkerCompletedEventHandler RunWorkerCompleted
        {
            add
            {
                runWorkerCompleted += value;
            }
            remove
            {
                runWorkerCompleted -= value;
            }
        }

        private RunWorkerCompletedEventHandler runWorkerCompleted;

        private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            if (runWorkerCompleted != null)
            {
                runWorkerCompleted.Invoke(this, e);
            }
        }

        /// <summary>
        /// Requests cancellation of a pending background operation.
        /// </summary>
        public void CancelAsync()
        {
            backgroundWorker1.CancelAsync();
        }

        /// <summary>
        /// Raises the System.ComponentModel.BackgroundWorker.ProgressChanged event.
        /// </summary>
        /// <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
        public void ReportProgress(int percentProgress)
        {
            backgroundWorker1.ReportProgress(percentProgress);
        }

        /// <summary>
        /// Raises the System.ComponentModel.BackgroundWorker.ProgressChanged event.
        /// </summary>
        /// <param name="percentProgress">The percentage, from 0 to 100, of the background operation that is complete.</param>
        /// <param name="userState">The state object passed to System.ComponentModel.BackgroundWorker.RunWorkerAsync(System.Object).</param>
        public void ReportProgress(int percentProgress, object userState)
        {
            backgroundWorker1.ReportProgress(percentProgress, userState);
        }

        /// <summary>
        /// Starts execution of a background operation.
        /// </summary>
        public void RunWorkerAsync()
        {
            backgroundWorker1.RunWorkerAsync();
        }

        /// <summary>
        /// Starts execution of a background operation.
        /// </summary>
        /// <param name="argument">A parameter for use by the background operation to be executed in the System.ComponentModel.BackgroundWorker.DoWork
        /// event handler</param>
        public void RunWorkerAsync(object argument)
        {
            backgroundWorker1.RunWorkerAsync(argument);
        }

        
        
        /// <summary>
        /// The object as BackgroundWorker
        /// </summary>
        public BackgroundWorker BackgroundWorker
        {
        	get
        	{
            	return backgroundWorker1;
        	}
        }

        /// <summary>
        /// Constructor for the control.
        /// </summary>
        public VisualBackgroundWorker()
        {
            InitializeComponent();
            label1.Text = "";
        }

        /// <summary>
        /// Provide access to the progress bar control that forms part of the visual background worker.
        /// </summary>
        public ProgressBar GetProgressBar()
        {
            return progressBar1;
        }
    }
}