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

TCustomLazDockingManager

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

TCustomLazDockingManager - base class for TLazDockingManager, a class for managing docking controls

Declaration

Source position: ldockctrl.pas line 168

type TCustomLazDockingManager = class(TComponent)

protected

  procedure Remove();

  

Remove - detaches any controls attached to the specified docker, then nullifies the docker

  function Add();

  

Add - provided the specified Docker is of the correct type, sets up the control to use a docking manager and returns an integer pointer

public

  constructor Create(); override;

  

Create - constructor for TCustomLazDockingManager: calls inherited Create then sets up lists, managers and configurations

  destructor Destroy; override;

  

Destroy - destructor for TCustomLazDockingManager: frees dockers, managers and configs, then calls inherited Destroy

  function FindDockerByName();

  

FindDockerByName - returns the identity of a Control Docker given the Docker name

  function FindControlByDockerName();

  

FindControlByDockerName - returns the identity of a control given its docker name

  function FindDockerByControl();

  

FindDockerByControl - returns the identity of a Control Docker given its control identity

  function CreateUniqueName();

  

CreateUniqueName - returns a unique name given a string name

  function GetControlConfigName();

  

GetControlConfigName - returns a config name for the nominated control

  procedure DisableLayout();

  

DisableLayout - finds whether the docker control exists then disables its layout

  procedure EnableLayout();

  

EnableLayout - finds whether the docker control exists then enables its layout

  procedure SaveToConfig();

  

SaveToConfig - saves details to a config storage file

  procedure LoadFromConfig();

  

LoadFromConfig - loads details from a config storage file

  procedure AddOrReplaceConfig();

  

AddOrReplaceConfig adds a new docker config, or replace if it already exists

  procedure ClearConfigs;

  

ClearConfigs - free all the docking configurations

  function GetConfigWithDockerName();

  

GetConfigWithDockerName - returns the configuration detail for the named docker

  function CreateLayout();

  

CreateLayout - returns a layout configuration node for the named docker

  function ConfigIsCompatible();

  

ConfigIsCompatible - checks that the nominated root node has a compatible configuration

  procedure WriteDebugReport;

  

WriteDebugReport - produces a formatted report of status for debugging

  property Manager: TAnchoredDockManager; [r]

  

Manager - the TAnchoredDockManager for the current class

  property DockerCount: Integer; [r]

  

DockerCount - the number of dockers in the list

  property Dockers: TCustomLazControlDocker; default; [r]

  

Dockers - the indexed list of dockers

  property ConfigCount: Integer; [r]

  

ConfigCount - the number of configuration nodes

  property Configs: TLazDockerConfig; [r]

  

Configs - the indexed list of config nodes

end;

Inheritance

TCustomLazDockingManager

  

TCustomLazDockingManager - base class for TLazDockingManager, a class for managing docking controls

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

TObject

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