[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Controls' (#lcl)

TDragDockObject

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

A drag object for drag-dock.

Declaration

Source position: controls.pp line 484

type TDragDockObject = class(TDragObject) end;

protected

  procedure AdjustDockRect(); virtual;

  

Adjust the DockRect relative to the dragging hotspot (DockOffset).

  function GetDragCursor(); override;

  

Returns the dragging cursor type (shape).

  procedure EndDrag(); override;

  

Finish docking.

  procedure InitDock(); virtual;

  

Initializes the dragging coordinates.

  procedure ShowDockImage; virtual;

  

Shows the DockRect, remembers the coordinates in EraseDockRect

  procedure HideDockImage; virtual;

  

Hides the DockRect, invalidates EraseDockRect to prevent further erases.

  procedure MoveDockImage; virtual;

  

Moves an already visible DockRect.

  function HasOnDrawImage; virtual;

public

  property DockOffset: TPoint; [rw]

  

The hotspot offset of the dragged DockRect.

  property DockRect: TRect; [rw]

  

Screen coordinates of a possible drop location.

  property DropAlign: TAlign; [rw]

  

How the dragged control will be docked, relative to the target control.

  property DropOnControl: TControl; [rw]

  

The already docked control, relative to which the dragged control will be docked. Nil for an empty docksite.

  property Floating: Boolean; [rw]

  

The final state of the dragged control (after drop).

  property IncreaseDockArea: Boolean; [r]

  

Determines whether the dock site shall be enlarged.

  property EraseDockRect: TRect; [rw]

  

The currently visible DockRect, to be removed later.

Inheritance

TDragDockObject

  

A drag object for drag-dock.

|

TDragObject

  

Base class for managing drag operations and user feedback.

|

TObject

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 behaviour.

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

[entire review DoDi 2011-09-10]

See also

TDragObject

  

Base class for managing drag operations and user feedback.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.