TCustomLazControlDocker

type TCustomLazControlDocker = class(TComponent)

protected

  procedure UpdatePopupMenu; virtual;

UpdatePopupMenu - alters the popup menu to reflect changes

  procedure Loaded; override;

Loaded - calls inherited method then calls UpdatePopupMenu

  function GetLocalizedName;

GetLocalizedName - returns a string with the localised name for the docker

  procedure ControlVisibleChanging();

ControlVisibleChanging - debugging method to indicate if Visible state of the control is changing

  procedure ControlVisibleChanged();

  function CreateFormAndDockWithSplitter();

CreateFormAndDockWithSplitter - add a splitter to Side and dock to it. Returns True if successful

  function DockAsPage();

DockAsPage - dock as a page as specified in Layout. Returns True if successful

  procedure FixControlBounds();

FixControlBounds - fix bounds after inserting AddedControl

  procedure ShrinkNeighbourhood();

ShrinkNeighbourhood - shrink neighbour controls according to Layout

  function FindPageNeighbours();

FindPageNeighbours - returns a list of the neighbour controls for the docker

  procedure Notification(); override;

Notification - calls inherited method, then performs specified operation depending on type of component, usually involving removal

  function FindLCDMenuItem();

FindLCDMenuItem - returns an item from the specified menu

public

  constructor Create(); override;

Create - constructor for TCustomLazControlDocker: calls inherited Create then extends the popup menu

  destructor Destroy; override;

Destroy - destructor for TCustomLazControlDocker: calls inherited Destroy and removes all associated controls

  procedure ShowDockingEditor; virtual;

ShowDockingEditor - makes a popup docking editor dialog appear

  function GetLayoutFromControl;

GetLayoutFromControl - returns a dock config node containing the control's layout

  procedure SaveLayout;

SaveLayout - stores the layout, usually just before hiding a control or closing a form

  procedure RestoreLayout;

RestoreLayout from its stored location, when the control is unhidden or the form is re-loaded

  procedure DisableLayout;

DisableLayout and increment the count of locked layouts

  procedure EnableLayout;

EnableLayout and decrement the count of locked layouts

  function ControlIsDocked;

ControlIsDocked - checks that the control and its parent actually exist and at least one of them is a dock form or a dock page

  function GetControlName();

GetControlName - returns the string name of the specified control

  procedure AddPopupMenu();

AddPopupMenu - if the menu does not yet exist, creates the structure and menu items for a popup menu

  procedure RemovePopupMenu();

RemovePopupMenu - removes menu, usually during the process of removing the docking control

  property Control: TControl; [rw]

The Control that is to be docked

  property Manager: TCustomLazDockingManager; [rw]

The docking Manager that is to be used to dock the current control

  property ExtendPopupMenu: Boolean; [rw]

ExtendPopupMenu - True if the popup menuis to be extended

  property PopupMenuItem: TMenuItem; [r]

PopupMenuItem - an item in the popup menu

  property LocalizedName: String; [rw]

The LocalizedName of the current docker

  property DockerName: String; [rw]

DockerName - the name of the current docker

  property Enabled: Boolean; [rw]

Enabled - true if layout is to be automatically restored on show

  property LayoutLock: Integer; [r]

LayoutLock - the number of layouts that are locked

end;

TCustomLazControlDocker

TComponent,IUnknown,IInterfaceComponentReference

TPersistent

TObject