Sign in Join
FPDoc Onlineexperiment

TGetSiteInfoEvent procedure type

In unit Controls

An OnGetSiteInfo handler returns information about a docksite.

Declaration

pascal
TGetSiteInfoEvent = procedure(Sender: TObject; DockClient: TControl; 
 var InfluenceRect: TRect; 
 MousePos: TPoint; var CanDock: Boolean)
 of object

Arguments

Sender

The dock site near the mouse pointer.

DockClient

The dragged control.

InfluenceRect

The screen rectangle where a drop or mouse move is directed to this docksite.

MousePos

The current position of the mouse.

CanDock

Set CanDock to False to reject docking.

Description

An OnGetSiteInfo event is sent by the DragManager to all docksites. The handler can adjust the snapping rectangle (InfluenceRect), and can reject an drop.

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