FPDoc Onlineexperiment

TLazDockForm class

In unit LDockTree

TLazDockForm - the default DockSite for a TLazDockTree and for TCustomAnchoredDockManager.

Declaration

pascal

TLazDockForm = class(TCustomForm)

Inheritance

Description

TLazDockForm - the default DockSite for a TLazDockTree and for TCustomAnchoredDockManager

Note: There are two docking managers: TLazDockTree uses TLazDockZone to allow docking in rows and columns. TCustomAnchoredDockManager does not use TLazDockZone and allows arbitrary layouts.

Properties

MainControl public The identity of the MainControl in the docked form (used for the default caption).

Methods

`Notification`	protected	Notification - if the required operation is removal, sets MainControl to nil, then calls inherited Notification.
`UpdateMainControl`	protected	UpdateMainControl - sets MainControl to a new value.
`MouseUp`	protected	MouseUp - calls inherited MouseUp then finds position and appropriate header.
`MouseDown`	protected	MouseDown - performs inherited MouseDown, then finds position and appropriate header.
`MouseMove`	protected	MouseMove - performs inherited MouseMove, then finds position and appropriate header.
`MouseLeave`	protected	MouseLeave - performs inherited MouseLeave, and sets the local store of position to indicate absence of the mouse.
`PaintWindow`	protected	PaintWindow - calls inherited PaintWindow, then creates new canvas and handle at cursor position, inserts header caption, title and images.
`TrackMouse`	protected	TrackMouse - finds position of the mouse, which part of the control it occupies (whether header or main part of control), and state of buttons.
`Create`	public	Create - constructor for TLazDocForm: calls inherited Create, then fills in the header.
`Destroy`	public	Destroy - destructor for TLazDockForm: removes header then calls inherited Destroy.
`CloseQuery`	public	CloseQuery - calls inherited method, then asks all top level forms if form can close.
`UpdateCaption`	public	UpdateCaption - brings caption up-to-date if there have been changes.
`UpdateMainControlInParents`	public	UpdateMainControlInParents - make sure all parents recognize the presence of MainControl.
`FindMainControlCandidate`	public	FindMainControlCandidate - finds forms and controls in the docktree hierarchy that could act as the MainControl.
`FindHeader`	public	FindHeader - identifies the part of the dock form that is the header, and returns a TControl.
`InsertControl`	public	InsertControl - calls inherited method then updates the main control.
`IsDockedControl`	public	IsDockedControl - checks if control is a child, not a TLazDockSplitter and properly anchor docked; returns True if OK.
`ControlHasTitle`	public	ControlHasTitle - returns True if nominated control is visible, is a docked control and has a border spacing greater than zero.
`GetTitleRect`	public	GetTitleRect - returns the coordinates of the title rectangle for the nominated control.
`GetTitleOrientation`	public	GetTitleOrientation - returns the orientation (horizontal or vertical) of the title in the nominated control.

Inherited

From TCustomForm (174)

Activate Active ActiveChanged ActiveControl ActiveDefaultControl ActiveMDIChild AddHandlerClose AddHandlerCreate AddHandlerFirstShow AdjustClientRect AfterConstruction AllAutoSized AllowDropFiles AlphaBlend AlphaBlendValue AutoScale AutoScroll AutoSizeDelayedHandle BeforeDestruction BeginAutoDrag BeginFormUpdate BigIconHandle BorderIcons BorderStyle CalculatePreferredSize CancelControl CanFocus Caption ChildHandlesCreated ClientHandle Close CMActionExecute CMActionUpdate CMActivate CMAppShowBtnGlyphChanged CMAppShowMenuGlyphChanged CMBiDiModeChanged CMDeactivate CMIconChanged CMParentBiDiModeChanged CMRelease CMShowingChanged Color ColorIsStored ConstrainedResize CreateNew CreateParams CreateWnd Deactivate DefaultControl DefaultMonitor DefocusControl Designer DestroyWnd DoAddActionList DoAutoSize Dock DoClose DoCreate DoDestroy DoDock DoExecuteAction DoFirstShow DoHide DoOnChangeBounds DoOnResize DoRemoveActionList DoShow DoShowWindow DoUpdateAction EffectiveShowInTaskBar EndFormUpdate EnsureVisible FocusControl FormIsUpdating FormState FormStyle GetChildren GetControlClassDefaultSize GetDefaultDockCaption GetFloating GetFormImage GetMDIChildren GetPreferredSize GetRealPopupParent GetRolesForControl HandleCreateException HandleDestroyException HandleShowHideException HelpFile Hide Icon InitializeWnd IntfDropFiles IntfHelp IsShortcut KeyPreview LastActiveControl Loaded MakeFullyVisible MDIChildCount MDIChildren Menu ModalResult Monitor MoveToDefaultPosition OnActivate OnClose OnCloseQuery OnCreate OnDeactivate OnDestroy OnDropFiles OnHelp OnHide OnResize OnShortcut OnShow OnShowModalFinished OnWindowStateChange ParentFont PopupMode PopupParent Position ProcessResource Release RemoveAllHandlersOfObject RemoveHandlerClose RemoveHandlerCreate RemoveHandlerFirstShow RequestAlign Resizing RestoredHeight RestoredLeft RestoredTop RestoredWidth ScreenSnap SetAutoScroll SetAutoSize SetFocus SetFocusedControl SetParent SetRestoredBounds SetScaled SetVisible SetZOrder Show ShowInTaskBar ShowModal ShowOnTop SmallIconHandle SnapBuffer SnapOptions TileMode UpdateActions UpdateDockCaption UpdateShowing UpdateWindowState Visible VisibleChanged VisibleChanging VisibleIsStored WantChildKey WindowState WMActivate WMCloseQuery WMDPIChanged WMHelp WMShowWindow WMSize WMWindowPosChanged WMWindowPosChanging WndProc WSRegisterClass

From TCustomDesignControl (5)

AutoAdjustLayout DesignTimePPI DoAutoAdjustLayout PixelsPerInch Scaled

From TScrollingWinControl (16)

AlignControls AutoScrollEnabled CalculateAutoRanges ClientToScreen ComputeScrollbars GetClientScrollOffset GetLogicalClientRect GetPreferredSizeClientFrame HorzScrollBar ScreenToClient ScrollBy ScrollInView UpdateScrollbars VertScrollBar WMHScroll WMVScroll

From TCustomControl (6)

Canvas FontChanged OnPaint Paint SetColor WMPaint

From TWinControl (211)

AddControl AutoSizeDelayed AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BorderWidth BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CanSetFocus CanTab ChangeScale ChildClassAllowed ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParented CreateParentedControl CreateSubClass CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoDragMsg DoEnter DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds EraseBackground FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren Focused FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded IntfGetDropFilesTarget IntfUTF8KeyPress Invalidate InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDown KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnEnter OnExit OnGetDockCaption OnGetSiteInfo OnKeyDown OnKeyPress OnKeyUp OnUnDock OnUTF8KeyPress PaintControls PaintHandler PaintTo ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab RealGetText ReAlign RealizeBounds RealizeBoundsRecursive RealSetText ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetShape SetTempCursor ShowControl Showing TabOrder TabStop UnlockRealizeBounds Update UpdateControlState UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMKillFocus WMMove WMNotify WMSetFocus WMSysChar WMSysKeyDown WMSysKeyUp WriteLayoutDebugReport WSSetText

From TControl (328)

AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize Align AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel Anchors AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSize AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDragStart BeginAutoSizing BeginDrag BiDiMode BorderSpacing BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds Click ClientHeight ClientOrigin ClientRect ClientToParent ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged Constraints ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DblClick DefineProperties DesktopFont DisableAutoSizing DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Docked DockOrientation DockTrackNoTarget DoContextPopup DoEndDock DoEndDrag DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheel DoMouseWheelDown DoMouseWheelHorz DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnParentHandleDestruction DoOnShowHint DoScaleFontPPI DoStartDock DoStartDrag DragCanceled DragCursor DragDrop Dragging DragKind DragMode DragOver EditingDone EnableAutoSizing Enabled EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass Font ForeignAnchorSideChanged GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetChildAccessibleObjectAtPos GetColorResolvingParent GetCursor GetDefaultColor GetDefaultHeight GetDefaultWidth GetDockEdge GetDragImages GetEnabled GetFloatingDockSiteClass GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetRGBColorResolvingParent GetScrolledClientRect GetSelectedChildAccessibleObject GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseEnter MouseInClient OnChangeBounds OnClick OnConstrainedResize OnContextPopup OnDblClick OnDragDrop OnDragOver OnEditingDone OnEndDock OnEndDrag OnMouseDown OnMouseEnter OnMouseLeave OnMouseMove OnMouseUp OnMouseWheel OnMouseWheelDown OnMouseWheelHorz OnMouseWheelLeft OnMouseWheelRight OnMouseWheelUp OnQuadClick OnShowHint OnStartDock OnStartDrag OnTripleClick Parent ParentBackground ParentBiDiMode ParentColor ParentDestroyingHandle ParentFontChanged ParentShowHint ParentToClient Perform PopupMenu PositionDockRect QuadClick ReadBounds ReadState Refresh RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl Resize Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetBiDiMode SetBoundsKeepBase SetCursor SetDragMode SetEnabled SetHint SetInitialBounds SetName SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf ShouldAutoAdjust ShowHelp ShowHint TBDockHeight Text TextChanged Top TripleClick UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonDown WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp

From TLCLComponent (6)

DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass

From TComponent (64)

_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (4)

Assign FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (34)

CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

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