TCustomGrid.DoMouseWheelLeft function

Member of TCustomGridprotectedIn unit Grids

Handles a mouse wheel scroll left message for the control.

Declaration

pascal

function DoMouseWheelLeft(Shift: TShiftState; MousePos: TPoint)
: Boolean; override

Arguments

`Shift`	Shift, Alt, Ctrl modifier for the mouse wheel action.
`MousePos`	TPoint instance with the coordinates for the mouse pointer.

Function result

True if the mouse wheel message is handled in the method.

Description

DoMouseWheelLeft is an overridden method in TCustomGrid which handles a horizontal mouse wheel scroll message towards the left of the grid control. DoMouseWheelLeft is called from the inherited DoMouseWheelHorz method when an unhandled scroll wheel message with a negative WheelDelta value occurs.

DoMouseWheelLeft calls the inherited method on entry to signal the OnMouseWheelLeft event handler (when assigned). The return value is set to True if the message is handled in the method.

If the message is not handled in the inherited method, the GridMouseWheel method is called using the ssCtrl modifier and the current mouse position as arguments. This is the equivalent of a Ctrl+MouseWheelUp message. The return value is set to True when the message is handled in this manner.

See DoMouseWheelRight for the actions performed for a Ctrl+MouseWheelDown scroll message.

Use MouseWheelOption to specify whether mouse wheel operations are applied to the grid cursor (selection / editing) or the visible area for the control.

TCustomGrid.DoMouseWheelLeft function

Declaration

Arguments

Function result

Description

See also