Sign in Join
FPDoc Onlineexperiment

TCustomTreeView.DoMouseWheelHorz function

Member of TCustomTreeViewprotectedIn unit ComCtrls

Performs actions to handle a horizontal mouse wheel message.

Declaration

pascal
function DoMouseWheelHorz(Shift: TShiftState; WheelDelta: Integer; 
 MousePos: TPoint): Boolean; override

Arguments

Shift

Shift, Alt, or Ctrl modifier for the mouse wheel message.

WheelDelta

Number of "clicks" that the mouse wheel was moved.

MousePos

Coordinates for the mouse pointer when the wheel event was detected.

Function result

Returns True if the wheel message was handled in an assigned event handler or internally in the method.

Description

DoMouseWheelHorz is an overridden method used to perform actions needed to handle a horizontal mouse wheel message. It calls the inherited method to signal the OnMouseWheelHorz event handler (when assigned), or other chtOnMouseWheelHorz handlers registered in the application.

If the message is not handled in the ancestor, the value in ScrolledLeft is updated to apply the delta value in WheelDelta. The position for a tool tip (or hint) is also updated using the coordinates in Mouse.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.