//-----------------------------------------------------------------------
// <copyright file="ISimpleData.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.OBD
{
    using System.Collections.Generic;
    using System.IO;
    using System.Windows.Forms;
    using global::SharedObjects.Protocol.OBD;

    /// <summary>
    /// Interface to class for displaying data in a formatted style.
    /// </summary>
    public interface ISimpleData
    {
        /// <summary>
        /// Gets DataGridView instance in simple data panel.
        /// </summary>
        DataGridView simpleDataDgv { get; }

        /// <summary>
        /// Gets or sets width of item.
        /// <para>
        /// Accessed when the window is resized to get a decent presentation.
        /// </para>
        /// </summary>
        int Width { get; set; }

        /// <summary>
        /// Add data to the table including unit text.
        /// </summary>
        /// <param name="presentationData">Presentation data wrapper.</param>
        void add(IPresentationData presentationData);

        /// <summary>
        /// Add printable controls to the list.
        /// <para>
        /// The table will be broken up to one table per page printed.
        /// </para>
        /// </summary>
        /// <param name="printControls">List with printable controls.</param>
        void addPrintControls(IList<Control> printControls);

        /// <summary>
        /// Clear the table with simple data.
        /// </summary>
        void clearTable();

        /// <summary>
        /// Save table data to CSV file for later review.
        /// </summary>
        /// <param name="fileName">Name of file to save data to.</param>
        void saveData(string fileName);
    }
}