//-----------------------------------------------------------------------
// <copyright file="PluginHost.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.Collections.Generic;
    using System.Drawing;
    using System.Windows.Forms;
    using ThoughtWorks.CruiseControl.Remote.Monitor;

    /// <summary>
    /// Defines a host for the plugins.
    /// </summary>
    public abstract class PluginHost
    {
        #region Public methods
        #region Show()
        /// <summary>
        /// Show the host.
        /// </summary>
        public abstract void Show();
        #endregion

        #region ShutDown()
        /// <summary>
        /// Shut down the host.
        /// </summary>
        public abstract void ShutDown();
        #endregion

        #region AddServerNode()
        /// <summary>
        /// Adds a new node for a server.
        /// </summary>
        /// <param name="server">The server the node is for.</param>
        /// <returns>The new node.</returns>
        public abstract PluginServerNode AddServerNode(Server server);
        #endregion

        #region AddTab()
        /// <summary>
        /// Adds a new tab page.
        /// </summary>
        /// <returns>The new tab.</returns>
        public abstract PluginTab AddTab(Plugin plugin, string text);
        #endregion

        #region AddImage()
        /// <summary>
        /// Adds a new image.
        /// </summary>
        /// <param name="image">The image to add.</param>
        /// <returns>The identifier of the image.</returns>
        public abstract string AddImage(Image image);
        #endregion

        #region ChangeSelectedControl()
        /// <summary>
        /// Change the currently selected control.
        /// </summary>
        /// <param name="control">The new control to be selected.</param>
        public abstract void ChangeSelectedControl(Control control);
        #endregion

        #region ShowProjectContextMenu()
        /// <summary>
        /// Display the project context menu.
        /// </summary>
        /// <param name="container">The container for the menu.</param>
        /// <param name="x">The x location.</param>
        /// <param name="y">The y location.</param>
        public abstract void ShowProjectContextMenu(Control container, int x, int y);
        #endregion

        #region AddCommand()
        /// <summary>
        /// Adds a new command.
        /// </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>
        /// <returns>The new <see cref="PluginCommand"/> instance.</returns>
        public abstract PluginCommand AddCommand(string text, Image icon, PluginCommandType type, EventHandler command);
        #endregion

        #region GetSelectedProjects()
        /// <summary>
        /// Gets the currently selected projects.
        /// </summary>
        /// <returns>The selected projects.</returns>
        public abstract IEnumerable<Project> GetSelectedProjects();
        #endregion

        #region PerformDefaultProjectAction()
        /// <summary>
        /// Performs the default project action on a project.
        /// </summary>
        /// <param name="value">The project to perform the action on.</param>
        public abstract void PerformDefaultProjectAction(Project value);
        #endregion
        #endregion
    }
}