//------------------------------------------------------------------------------
// <copyright file="DataGridViewHitTestInfo.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>            
//------------------------------------------------------------------------------
 
using System.Globalization;
 
namespace System.Windows.Forms
{
    public partial class DataGridView
    {
        /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo"]/*' />
        public sealed class HitTestInfo 
        {
            internal DataGridViewHitTestType type = DataGridViewHitTestType.None;
            //internal DataGridViewHitTestTypeCloseEdge edge = DataGridViewHitTestTypeCloseEdge.None;
            internal DataGridViewHitTestTypeInternal typeInternal = DataGridViewHitTestTypeInternal.None;
            internal int row;
            internal int col;
            internal int adjacentRow;
            internal int adjacentCol;
            internal int mouseBarOffset;
            internal int rowStart;
            internal int colStart;
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.Nowhere"]/*' />
            /// <devdoc>
            /// <para>Allows the <see cref='System.Windows.Forms.DataGridView.HitTestInfo'/> object to inform you the 
            ///    extent of the grid.</para>
            /// </devdoc>
            public static readonly HitTestInfo Nowhere = new HitTestInfo();
 
            internal HitTestInfo()
            {
                this.type = DataGridViewHitTestType.None;
                this.typeInternal = DataGridViewHitTestTypeInternal.None;
                //this.edge = DataGridViewHitTestTypeCloseEdge.None;
                this.row = this.col = -1;
                this.rowStart = this.colStart = -1;
                this.adjacentRow = this.adjacentCol = -1;
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.ColumnIndex"]/*' />
            /// <devdoc>
            ///    <para>Gets the number of the clicked column.</para>
            /// </devdoc>
            public int ColumnIndex
            {
                get 
                {
                    return this.col;
                }
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.RowIndex"]/*' />
            /// <devdoc>
            ///    <para>Gets the
            ///       number of the clicked row.</para>
            /// </devdoc>
            public int RowIndex
            {
                get 
                {
                    return this.row;
                }
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.ColumnX"]/*' />
            /// <devdoc>
            ///    <para>Gets the left edge of the column.</para>
            /// </devdoc>
            public int ColumnX
            {
                get 
                {
                    return this.colStart;
                }
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.RowY"]/*' />
            /// <devdoc>
            ///    <para>Gets the top edge of the row.</para>
            /// </devdoc>
            public int RowY
            {
                get 
                {
                    return this.rowStart;
                }
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.Type"]/*' />
            /// <devdoc>
            /// <para>Gets the part of the <see cref='System.Windows.Forms.DataGridView'/> control, other than the row or column, that was 
            ///    clicked.</para>
            /// </devdoc>
            public DataGridViewHitTestType Type
            {
                get 
                {
                    return this.type;
                }
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.Equals"]/*' />
            /// <devdoc>
            ///    <para>Indicates whether two objects are identical.</para>
            /// </devdoc>
            public override bool Equals(object value) 
            {
                HitTestInfo hti = value as HitTestInfo;
                if (hti != null) 
                {
                    return (this.type == hti.type &&
                            this.row  == hti.row &&
                            this.col  == hti.col);
                }
                return false;
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.GetHashCode"]/*' />
            /// <devdoc>
            /// <para>Gets the hash code for the <see cref='System.Windows.Forms.DataGridView.HitTestInfo'/> instance.</para>
            /// </devdoc>
            public override int GetHashCode() 
            {
                return WindowsFormsUtils.GetCombinedHashCodes((int) this.type,
                                                                  this.row,
                                                                  this.col);
            }
 
            /// <include file='doc\DataGridViewHitTestInfo.uex' path='docs/doc[@for="DataGridView.HitTestInfo.ToString"]/*' />
            /// <devdoc>
            ///    <para>Gets the type, column number and row number.</para>
            /// </devdoc>
            public override string ToString() 
            {
                return "{ Type:" + type.ToString() + ", Column:" + col.ToString(CultureInfo.CurrentCulture) + ", Row:" + row.ToString(CultureInfo.CurrentCulture) + " }";
            }
        }
    }
}