//-----------------------------------------------------------------------
// <copyright file="PluginCommand.cs" company="Craig Sutherland">
//     Copyright (c) 2009 Craig Sutherland. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/* 
 * Copyright (c) 2009 Craig Sutherland
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

namespace FastForward.WinCore
{
    using System;
    using System.ComponentModel;
    using System.Drawing;

    /// <summary>
    /// A command that has been added from a plug-in.
    /// </summary>
    public class PluginCommand
        : INotifyPropertyChanged
    {
        #region Private fields
        /// <summary>
        /// The text of the command.
        /// </summary>
        private string text;

        /// <summary>
        /// The tooltip for the command.
        /// </summary>
        private string tooltip;

        /// <summary>
        /// The icon for the command.
        /// </summary>
        private Image icon;

        /// <summary>
        /// The type of the command.
        /// </summary>
        private PluginCommandType type;

        /// <summary>
        /// The command to run.
        /// </summary>
        private EventHandler command;
        #endregion

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="PluginCommand"/> class.
        /// </summary>
        /// <param name="text">The text of the command.</param>
        /// <param name="icon">The icon of the command.</param>
        /// <param name="type">The type of the command.</param>
        /// <param name="command">The command to run.</param>
        public PluginCommand(string text, Image icon, PluginCommandType type, EventHandler command)
        {
            this.text = text;
            this.icon = icon;
            this.type = type;
            this.command = command;
        }
        #endregion

        #region Public events
        #region PropertyChanged()
        /// <summary>
        /// A property has been changed.
        /// </summary>
        public event PropertyChangedEventHandler PropertyChanged;
        #endregion

        #region Removed()
        /// <summary>
        /// This command has been removed.
        /// </summary>
        public event EventHandler Removed;
        #endregion
        #endregion

        #region Public properties
        #region Text
        /// <summary>
        /// Gets or sets the text of the command.
        /// </summary>
        public string Text
        {
            get
            {
                return this.text;
            }

            set
            {
                this.text = value;
                this.FirePropertyChanged("Text");
            }
        }
        #endregion

        #region Tooltip
        /// <summary>
        /// Gets or sets the tooltip for the command.
        /// </summary>
        public string Tooltip
        {
            get
            {
                return this.tooltip;
            }

            set
            {
                this.tooltip = value;
                this.FirePropertyChanged("Tooltip");
            }
        }
        #endregion

        #region Icon
        /// <summary>
        /// Gets or sets the icon for the command.
        /// </summary>
        public Image Icon
        {
            get
            {
                return this.icon;
            }

            set
            {
                this.icon = value;
                this.FirePropertyChanged("Icon");
            }
        }
        #endregion

        #region Type
        /// <summary>
        /// Gets the type of the command.
        /// </summary>
        public PluginCommandType Type
        {
            get { return this.type; }
        }
        #endregion

        #region Command
        /// <summary>
        /// Gets or sets the command that will be run.
        /// </summary>
        public EventHandler Command
        {
            get { return this.command; }
            set { this.command = value; }
        }
        #endregion
        #endregion

        #region Public methods
        #region Run()
        /// <summary>
        /// Runs the command.
        /// </summary>
        public void Run()
        {
            this.command(this, EventArgs.Empty);
        }
        #endregion

        #region Remove()
        /// <summary>
        /// Remove the command.
        /// </summary>
        public void Remove()
        {
            if (this.Removed != null)
            {
                this.Removed(this, EventArgs.Empty);
            }
        }
        #endregion
        #endregion

        #region Protected methods
        #region FirePropertyChanged()
        /// <summary>
        /// Firs the <see cref="PropertyChanged"/> event.
        /// </summary>
        /// <param name="property">The property that was changed.</param>
        protected void FirePropertyChanged(string property)
        {
            if (this.PropertyChanged != null)
            {
                var args = new PropertyChangedEventArgs(property);
                this.PropertyChanged(this, args);
            }
        }
        #endregion
        #endregion
    }
}