class

ADockSpace

Module
Arc
Header
#include "Arc/Docking/ADockSpace.h"
Namespace
Arcf

Properties

TypeNameDescription
ArcDelegate<void(const std::shared_ptr<CDockNode>&, float)>OnSplitterSizeChangedFired when a fixed-pixel seam is dragged — (node, new fixed pixels). Ratio seams write their live ratio straight back into the node.
ArcDelegate<void(const CName&, const ArcVec2&)>OnTabDraggedOutFired when a tab drag ends outside every dock area — the host's tear-off-to-OS-window hook.
ArcDelegate<void(const CName&, const ArcVec2&)>OnTabContextMenuFired on right-click over a dock tab (the tab is activated first). Position is dockspace-window-local — the host opens its menu there.
ArcDelegate<void(const CName&)>OnTabActivatedFired when a click makes a different tab active in its well.
ArcDelegate<void()>OnLayoutChangedFired after any user-driven layout mutation — tab move/reorder/ activate/close, detach/reattach, external drop, splitter drag. NOT fired by SetLayout (programmatic apply). The host's persistence hook: mark the layout dirty and serialize debounced.

Public functions

ReturnsNameDescription
ARC_WIDGET_ARGS
voidSetLayout
const CDockLayout&GetLayout
boolIsEmptyTrue when no area in the layout holds a tab — a float host uses it to close a window whose last tab was dragged away or closed.
uint32_tGetTabCountTabs across every area.
boolIsPointOverTabStripBlankTrue when the point (widget-absolute space) sits inside some tab well's strip but over neither a tab handle nor an overflow chevron.
voidSetStyle
const FDockSpaceStyle&GetStyle
voidSetFramelessAreasAreas drawn without the floating-panel chrome (fill, border, radius) and their tab strip on the window's Surface0 with no rule: a single document that fills the window edge to edge under its tabs, the way an asset editor's window does.
boolHasFramelessAreas
voidSetLiveTearOffHooks
voidCloseTabRemoves the tab from the layout entirely (emptied areas collapse, persistent areas stay).
voidCloseAllDocumentTabsCloses every Document-role tab through CloseTab (vetoes respected).
voidRefreshTabRebuilds the well strip hosting the tab — dirty dot / title updates.
voidSetEmptyAreaContentContent shown in the body of an empty persistent area (the document well's empty state).
std::shared_ptr<ADockTab>FindTab
CNameGetAreaIdForTab
ArcRectGetAreaRectForTab
std::shared_ptr<ADockTab>DetachTabRemoves the tab from the layout (emptied areas collapse) and hands it to the caller.
boolReattachTabDocks a detached tab back: Center-joins preferredAreaId when that area still exists, else the first area in the tree.
voidUpdateExternalTabDrag
voidCancelExternalTabDrag
boolDropExternalTabDrops a detached tab at the current preview target.
ArcVec2ComputeDesiredSize
voidArrangeChildren
boolCanSkipArrangeRefused: split ratios animate and tab drags re-home areas mid-frame, neither of which passes through Invalidate.
int32_tOnPaint
boolCanCacheDesiredSizePure pass-through to the built layout tree; every layout edit ends in SetContent, and the drag preview is painted, not measured.
const char*GetTypeName

Function details

ARC_WIDGET_ARGS

C++
ARC_WIDGET_ARGS(ADockSpace) ARC_ARG(FDockSpaceStyle, Style) ARC_WIDGET_ARGS_END() void Construct(const CArguments& args)

SetLayout

C++
void SetLayout(const CDockLayout& layout)

GetLayout

C++
const CDockLayout& GetLayout() const

IsEmpty

C++
bool IsEmpty() const

True when no area in the layout holds a tab — a float host uses it to close a window whose last tab was dragged away or closed.

GetTabCount

C++
uint32_t GetTabCount() const

Tabs across every area. A float host asks it to tell "this window holds several tabs" from "this window IS the tab" — tearing the only tab out of a float would destroy and rebuild the window under the cursor for no visible change.

IsPointOverTabStripBlank

C++
bool IsPointOverTabStripBlank(const ArcVec2& absolutePos) const

True when the point (widget-absolute space) sits inside some tab well's strip but over neither a tab handle nor an overflow chevron. Float chrome uses it to keep the blank strip OS-draggable while the tabs themselves stay interactive.

SetStyle

C++
void SetStyle(const FDockSpaceStyle& style)

GetStyle

C++
const FDockSpaceStyle& GetStyle() const

SetFramelessAreas

C++
void SetFramelessAreas(bool frameless)

Areas drawn without the floating-panel chrome (fill, border, radius) and their tab strip on the window's Surface0 with no rule: a single document that fills the window edge to edge under its tabs, the way an asset editor's window does.

HasFramelessAreas

C++
bool HasFramelessAreas() const

SetLiveTearOffHooks

C++
void SetLiveTearOffHooks(FLiveTearOffHooks hooks)

CloseTab

C++
void CloseTab(const CName& tabId, bool force = false)

Removes the tab from the layout entirely (emptied areas collapse, persistent areas stay). The tab's close-request hook can veto unless force is set — every close path (button, middle-click, context menu) funnels through here so the veto is universal.

CloseAllDocumentTabs

C++
void CloseAllDocumentTabs()

Closes every Document-role tab through CloseTab (vetoes respected). Panel and Major tabs are untouched.

RefreshTab

C++
void RefreshTab(const CName& tabId)

Rebuilds the well strip hosting the tab — dirty dot / title updates.

SetEmptyAreaContent

C++
void SetEmptyAreaContent(std::function<TSharedPtr<AWidget>()> factory)

Content shown in the body of an empty persistent area (the document well's empty state). Called per rebuild — return a fresh widget.

FindTab

C++
std::shared_ptr<ADockTab> FindTab(const CName& tabId) const

GetAreaIdForTab

C++
CName GetAreaIdForTab(const CName& tabId) const

GetAreaRectForTab

C++
ArcRect GetAreaRectForTab(const CName& tabId) const

DetachTab

C++
std::shared_ptr<ADockTab> DetachTab(const CName& tabId)

Removes the tab from the layout (emptied areas collapse) and hands it to the caller. Returns null when the tab is not in this layout.

ReattachTab

C++
bool ReattachTab(const std::shared_ptr<ADockTab>& tab, const CName& preferredAreaId)

Docks a detached tab back: Center-joins preferredAreaId when that area still exists, else the first area in the tree.

UpdateExternalTabDrag

C++
void UpdateExternalTabDrag(const CName& tabId, const std::string& title, const ArcVec2& localPos)

CancelExternalTabDrag

C++
void CancelExternalTabDrag()

DropExternalTab

C++
bool DropExternalTab(const std::shared_ptr<ADockTab>& tab, const ArcVec2& localPos)

Drops a detached tab at the current preview target. Returns false (layout untouched) when the position hits no dock area.

ComputeDesiredSize

C++
ArcVec2 ComputeDesiredSize(float scale) const override

ArrangeChildren

C++
void ArrangeChildren(const CGeometry& geo) override

CanSkipArrange

C++
bool CanSkipArrange() const override

Refused: split ratios animate and tab drags re-home areas mid-frame, neither of which passes through Invalidate.

OnPaint

C++
int32_t OnPaint(const CArcPaintArgs& args, const CGeometry& geo, CArcUIRenderer& renderer, int32_t layerId) const override

CanCacheDesiredSize

C++
bool CanCacheDesiredSize() const override

Pure pass-through to the built layout tree; every layout edit ends in SetContent, and the drag preview is painted, not measured.

GetTypeName

C++
const char* GetTypeName() const override
Generated from Arc/Docking/ADockSpace.h via arc.json · Nov 5, 2026Version 1.0.0