//-----------------------------------------------------------------------
// <copyright file="MyMessageBox.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 UserInterface.GUI
{
    using System;
    using System.Windows.Forms;

    /// <summary>
    /// Customized message box.
    /// </summary>
    public partial class MyMessageBox : Form
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="MyMessageBox" /> class.
        /// </summary>
        public MyMessageBox()
        {
            this.InitializeComponent();
        }

        /// <summary>
        /// Show the customized message box.
        /// </summary>
        /// <param name="formTitle">Title of form.</param>
        /// <param name="extraHeading">Extra heading.</param>
        /// <param name="text">Message text.</param>
        /// <returns>DialogResult state.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1500:VariableNamesShouldNotMatchFieldNames", MessageId = "extraHeading", Justification = "Reviewed, intentional.")]
        public DialogResult Show(string formTitle, string extraHeading, string text)
        {
            this.Text = formTitle;
            this.extraHeading.Text = extraHeading;
            this.textBox1.Text = text;

            this.yesButton.Focus();

            return this.ShowDialog();
        }

        /// <summary>
        /// No button clicked.
        /// </summary>
        /// <param name="sender">Sending object.</param>
        /// <param name="e">Event data.</param>
        private void noButton_Click(object sender, EventArgs e)
        {
            this.DialogResult = DialogResult.No;
            this.Close();
        }

        /// <summary>
        /// Yes button clicked.
        /// </summary>
        /// <param name="sender">Sending object.</param>
        /// <param name="e">Event data.</param>
        private void yesButton_Click(object sender, EventArgs e)
        {
            this.DialogResult = DialogResult.Yes;
            this.Close();
        }
    }
}