/* 
 * 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.
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;

namespace FastForward.WinCore
{
    /// <summary>
    /// A plugin node for a server.
    /// </summary>
    public class PluginServerNode
        : TreeNode
    {
        #region Constructors
        /// <summary>
        /// Initialise a new <see cref="PluginServerNode"/>.
        /// </summary>
        public PluginServerNode()
        {
            Key = Guid.NewGuid();
        }
        #endregion

        #region Public properties
        #region Key
        /// <summary>
        /// The unique key for this node.
        /// </summary>
        public Guid Key { get; private set; }
        #endregion
        #endregion

        #region Public methods
        #region FireSelected()
        /// <summary>
        /// Fire the <see cref="Selected"/> event.
        /// </summary>
        public void FireSelected()
        {
            if (Selected != null) Selected(this, EventArgs.Empty);
        }
        #endregion

        #region FireUnselected()
        /// <summary>
        /// Fire the <see cref="Unselected"/> event.
        /// </summary>
        public void FireUnselected()
        {
            if (Unselected != null) Unselected(this, EventArgs.Empty);
        }
        #endregion

        #region ContextMenuOpened
        /// <summary>
        /// Populate the context menu with any required items.
        /// </summary>
        /// <param name="menu"></param>
        /// <returns></returns>
        public virtual bool ContextMenuOpened(ContextMenuStrip menu)
        {
            return false;
        }
        #endregion
        #endregion

        #region Public events
        #region Selected
        /// <summary>
        /// The node has been selected.
        /// </summary>
        public event EventHandler Selected;
        #endregion

        #region Unselected
        /// <summary>
        /// The node has been unselected.
        /// </summary>
        public event EventHandler Unselected;
        #endregion
        #endregion
    }
}