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

TLazDockTree

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

TLazDockTree - a tree of TLazDockZones found in a docked window.

Declaration

Source position: ldocktree.pas line 72

type TLazDockTree = class(TDockTree)

protected

  procedure AnchorDockLayout();

  

AnchorDockLayout - sets up anchors between all docked controls and helper controls.

  procedure CreateDockLayoutHelperControls();

  

CreateDockLayoutHelperControls - creates any splitters and pages needed for the dock layout, including recursive creation for child controls.

  procedure ResetSizes();

  

ResetSizes - splits available size of Zone between children.

  procedure BreakAnchors();

  

BreakAnchors - detach the anchors of all child controls.

  procedure PaintDockFrame(); override;

  

PaintDockFrame - finds the cursor position and paints the dock frame of the specified size on the nominated canvas.

  procedure UndockControlForDocking();

  

UndockControlForDocking - frees anchors from parent and sibling controls.

  function DefaultDockGrabberSize;

  

DefaultDockGrabberSize - returns the default size for the dock grabber.

public

  constructor Create(); override;

  

Create - constructor for TLazDockTree: creates a docking form if required, sets up a dock manager then calls inherited Create.

  destructor Destroy; override;

  

Destroy - destructor for TLazDockTree: frees the dock site, annuls the Docksite manager, destroys any images then calls inherited Destroy.

  procedure AdjustDockRect(); override;

  

AdjustDockRect - offset one of the borders of control rect in order to get space for frame.

  procedure InsertControl(); override;

  

InsertControl - undocks AControl and docks it into the tree.

  procedure RemoveControl(); override;

  

RemoveControl - destroy child zone and all parents if they does not contain anything else, then removes the dock control.

  procedure BuildDockLayout();

  

BuildDockLayout - breaks the current anchors, forms the appropriate helper controls then re-establishes the anchors.

  procedure FindBorderControls();

  

FindBorderControls - makes splitters for all bordering controls along the specified Side.

  function FindBorderControl();

  

Gets the control with the specified dock zone and anchor side.

  function GetAnchorControl();

  

GetAnchorControl - find a control to anchor the Zone's Side.

  procedure PaintSite(); override;

  

PaintSite - paint bounds for each control and close button (using the supplied handle).

  procedure MessageHandler(); override;

  

MessageHandler - checks the state of the mouse and takes the appropriate action. Checks whether redraw is needed because of mouse move or change in mouse button status, text needs to be added, etc.

  procedure DumpLayout(); override;

  

DumpLayout - writes layout of Zone to a file, for debugging purposes etc.

  property AutoFreeDockSite: Boolean; [rw]

  

AutoFreeDockSite - determines whether the dock site is free.

end;

Inheritance

TLazDockTree

  

TLazDockTree - a tree of TLazDockZones found in a docked window.

|

TDockTree

  

A docking manager for tree-style layouts.

|

TDockManager

  

The layout manager for a docksite.

|

TPersistent

?

TObject

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