/*
* Copyright � 2005, Mathew Hall
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*/
using System;
using System.Drawing;
using System.Windows.Forms;
using XPTable.Models;
namespace XPTable.Events
{
#region Delegates
/// <summary>
/// Represents the method that will handle the CellKeyDown and CellKeyUp
/// events of a Table
/// </summary>
public delegate void CellKeyEventHandler(object sender, CellKeyEventArgs e);
#endregion
#region CellKeyEventArgs
/// <summary>
/// Provides data for the CellKeyDown and CellKeyUp events of a Table
/// </summary>
public class CellKeyEventArgs : KeyEventArgs
{
#region Class Data
/// <summary>
/// The Cell that Raised the event
/// </summary>
private Cell cell;
/// <summary>
/// The Table the Cell belongs to
/// </summary>
private Table table;
/// <summary>
/// The Row index of the Cell
/// </summary>
private int row;
/// <summary>
/// The Column index of the Cell
/// </summary>
private int column;
/// <summary>
/// The Cells bounding rectangle
/// </summary>
private Rectangle cellRect;
#endregion
#region Constructor
/// <summary>
/// Initializes a new instance of the CellKeyEventArgs class with
/// the specified source Cell, table, row index, column index, cell
/// bounds and KeyEventArgs
/// </summary>
/// <param name="cell">The Cell that Raised the event</param>
/// <param name="table">The Table the Cell belongs to</param>
/// <param name="row">The Row index of the Cell</param>
/// <param name="column">The Column index of the Cell</param>
/// <param name="cellRect">The Cell's bounding rectangle</param>
/// <param name="kea"></param>
public CellKeyEventArgs(Cell cell, Table table, int row, int column, Rectangle cellRect, KeyEventArgs kea) : base(kea.KeyData)
{
this.cell = cell;
this.table = table;
this.row = row;
this.column = column;
this.cellRect = cellRect;
}
/// <summary>
/// Initializes a new instance of the CellKeyEventArgs class with
/// the specified source Cell, table, row index, column index and
/// cell bounds
/// </summary>
/// <param name="cell">The Cell that Raised the event</param>
/// <param name="table">The Table the Cell belongs to</param>
/// <param name="cellPos"></param>
/// <param name="cellRect">The Cell's bounding rectangle</param>
/// <param name="kea"></param>
public CellKeyEventArgs(Cell cell, Table table, CellPos cellPos, Rectangle cellRect, KeyEventArgs kea) : base(kea.KeyData)
{
this.cell = cell;
this.table = table;
this.row = cellPos.Row;
this.column = cellPos.Column;
this.cellRect = cellRect;
}
#endregion
#region Properties
/// <summary>
/// Gets the Cell that Raised the event
/// </summary>
public Cell Cell
{
get
{
return this.cell;
}
}
/// <summary>
/// Gets the Table the Cell belongs to
/// </summary>
public Table Table
{
get
{
return this.table;
}
}
/// <summary>
/// Gets the Row index of the Cell
/// </summary>
public int Row
{
get
{
return this.row;
}
}
/// <summary>
/// Gets the Column index of the Cell
/// </summary>
public int Column
{
get
{
return this.column;
}
}
/// <summary>
/// Gets the Cells bounding rectangle
/// </summary>
public Rectangle CellRect
{
get
{
return this.cellRect;
}
}
/// <summary>
/// Gets the position of the Cell
/// </summary>
public CellPos CellPos
{
get
{
return new CellPos(this.Row, this.Column);
}
}
#endregion
}
#endregion
}