//-----------------------------------------------------------------------
// <copyright file="IInterfacePanel.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace SharedObjects.GUI
{
    using System.Windows.Forms;
    using global::SharedObjects.Api;

    /// <summary>
    /// Interface to panel for interface data.
    /// </summary>
    public interface IInterfacePanel
    {
        /// <summary>
        /// Close device (and all other opened/allocated items)
        /// </summary>
        void closeDevice();

        /// <summary>
        /// Gets current PassThru instance.
        /// </summary>
        IPassThru iPassThru { get; }

        /// <summary>
        /// Gets a value indicating whether the protocols panel is activated.
        /// </summary>
        bool protocolsEnabled { get; }

        /// <summary>
        /// Update and populate the combo boxes for serial port data.
        /// </summary>
        /// <param name="newPort">Name of port that triggered the change, 'null' value permitted.</param>
        void refreshSerialPortInfo(string newPort);

        /// <summary>
        /// Reload the vehicles drop-down with fresh data.
        /// </summary>
        void reloadVehicles();

        /// <summary>
        /// Set the mapping of tree node to this instance.
        /// </summary>
        /// <param name="panelTreeNode">Tree node instance to map to this interface.</param>
        void setPanelTreeNode(TreeNode panelTreeNode);
    }
}