Skip to main content
Table of Contents

TTMSFNCDataGridMouseInfo Record

Mouse event data passed by reference to TTMSFNCDataGridCell.HandleMouse.

API unit family: TMSFNCDataGridCell

Syntax

GeneratedPascalC++
TTMSFNCDataGridMouseInfo = record
struct DECLSPEC_DRECORD TTMSFNCDataGridMouseInfo

Remarks

The grid passes a copy of its own mouse event with Blocked reset to False. When the cell sets Blocked, the grid repaints and skips its default handling (selection, editing, anchor detection) for that event. Start from DefaultMouseInfo when building an instance yourself.

Fields and properties

Name Type Description
Blocked Boolean Set to True in HandleMouse to stop the grid from performing its default mouse action for this event.
Button TMouseButton Mouse button involved in the event; mbLeft in DefaultMouseInfo.
Cursor TCursor Cursor to show while the mouse moves over the cell.
Handled Boolean Set to True inside HandleMouse to mark the event as fully consumed.
Kind TTMSFNCDataGridMouseKind Phase of the mouse event (down, move, up, wheel, enter, leave, double-click, drag).
Shift TShiftState Modifier keys (Shift, Ctrl, Alt) active at the time of the mouse event.
WheelDelta Integer Scroll-wheel delta for gmkWheel events; a positive value scrolls towards the previous row.
X Single Mouse position in the grid's local coordinate space, the same space as TTMSFNCDataGridCell.Rect; -1 in DefaultMouseInfo.
Y Single Mouse position in the grid's local coordinate space, the same space as TTMSFNCDataGridCell.Rect; -1 in DefaultMouseInfo.