TDragDockObject class

In unit Controls

A drag object for drag-dock.

Declaration

pascal

TDragDockObject = class(TDragObject)

Inheritance

TDragDockObject
TDragObject

Descends from it: TDragDockObjectEx

Description

This object type serves two main purposes: it allows one to distinguish between drag-drop and drag-dock operations, and it implements docking specific information and behavior.

The primary use is for tree docking, as assumed by methods in TControl and TWinControl.

Properties

`DockOffset`	public	The hotspot offset of the dragged DockRect.
`DockRect`	public	Screen coordinates for a possible drop location.
`DropAlign`	public	How the dragged control will be docked, relative to the target control.
`DropOnControl`	public	The already docked control, relative to which the dragged control will be docked. Nil for an empty docksite.
`Floating`	public	The final state of the dragged control (after drop).
`IncreaseDockArea`	public	Indicates whether the dock site is enlarged after a Control has been docked.
`EraseDockRect`	public	Area to be erased when refreshing the display for the docking rectangle.

Methods

`AdjustDockRect`	protected	Adjust the DockRect relative to the dragging hotspot (DockOffset).
`GetDragCursor`	protected	Gets the drag cursor shape for the class instance.
`EndDrag`	protected	Finish docking.
`InitDock`	protected	Initializes the dragging coordinates.
`ShowDockImage`	protected	Shows the DockRect, and remembers the coordinates in EraseDockRect.
`HideDockImage`	protected	Hides the DockRect, and invalidates EraseDockRect to prevent further erases.
`MoveDockImage`	protected	Moves an already visible DockRect.
`HasOnDrawImage`	protected	Checks for an assigned OnDrawDockImage event handler.

Inherited

From TDragObject (13)

AlwaysShowDragImages AutoCreate AutoCreated AutoFree Control Create DragPos DragTarget DragTargetPos Dropped GetDragImages HideDragImage ShowDragImage

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