Sign in Join
FPDoc Onlineexperiment

TDockZone class

In unit Controls

Represents a node in a TDockTree

Declaration

pascal
TDockZone = class

Descends from it: TLazDockZone

Description

It encapsulates a dock zone, containing either other zones or a single control.

This implementation is specific to TDockTree. Another DockManager can (and should) use its own class instead.

See also

Properties

ChildControlpublicThe control docked in this zone.
ChildCountpublicThe number of child zones.
FirstChildpublicThe first child zone.
HeightpublicThe height of the zone.
LeftpublicThe left coordinate of the zone.
LimitBeginpublicThe free coordinate of the DockZone (Left or Top).
LimitSizepublicThe free size of the DockZone (Width or Height).
OrientationpublicWhether docking is oriented vertically, horizontally, in pages, or not at all.
ParentpublicThe parent zone in the DockTree.
ToppublicThe top coordinate for the dock zone.
TreepublicThe dock tree of which this dock zone is a part.
VisiblepublicA zone is visible if it contains a visible control, or if any child zone is visible.
VisibleChildCountpublicThe number of visible child zones.
WidthpublicThe width of this zone.
NextSiblingpublicThe next sibling zone.
PrevSiblingpublicThe preceding sibling zone.

Methods

GetHeightprotectedGets the value for the Height property.
GetLeftprotectedGets the value for the Left property.
GetLimitBeginprotectedGets the value for the LimitBegin property.
GetLimitSizeprotectedGets the value for the LimitSize property.
GetTopprotectedGets the value for the Top property.
GetVisibleprotectedGets the value for the Visible property.
GetVisibleChildCountprotectedGets the value for the VisibleChildCount property.
GetWidthprotectedGets the value for the Width property.
SetLimitBeginprotectedSets the value for the LimitBegin property.
SetLimitSizeprotectedNew value for the LimitSize property.
SetHeightprotectedSets the value for the Height property.
SetLeftprotectedSets the value for the Left property.
SetTopprotectedSets the value for the Top property.
SetWidthprotectedSets the value for the Width property.
CreatepublicConstructor for the class instance.
FindZonepublicReturns the dock zone containing the given control.
FirstVisibleChildpublicThe first visible child zone.
GetNextVisibleZonepublicThe next visible zone.
NextVisiblepublicThe next visible zone.
PrevVisiblepublicThe preceding visible zone.
AddSiblingpublicInserts NewZone as preceding or following sibling.
AddAsFirstChildpublicAdds the given zone as the first child.
AddAsLastChildpublicAdds the given zone as the last child.
ReplaceChildpublicReplace the OldChild zone by NewChild.
GetLastChildpublicThe last child zone.
GetIndexpublicCalculates the index of the zone within its parent zone.
RemovepublicUnlinks the given child zone.

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