class

CDockingManager

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

Type aliases

AliasDescription
using TabFactory = FDockTabFactory

Public functions

ReturnsNameDescription
CDockingManager&Get
voidSetLayout
const CDockLayout&GetLayout
voidAddTab
voidRemoveTab
voidMoveTab
voidSplitArea
SDockArea*FindAreaContainingTab
SDockArea*FindArea
voidSaveLayoutPreset
voidLoadLayoutPreset
std::vector<std::string>GetLayoutPresetNames
voidRegisterTabFactory
voidRemoveTabFromLayoutRemove a tab from an arbitrary layout root and collapse any area (and its parent splitter) left empty.
voidCollapseEmptyAreasCollapse empty areas (and their parent splitters) without removing a tab first — for hosts that prune restored layouts themselves.
boolMoveTabInLayoutinsertIndex >= 0 places a Center join at that strip position (index counted over the target's tabs excluding the moved tab); -1 appends.
boolInsertTabInLayoutInsert a tab that is NOT currently in the layout (tear-off re-dock).
boolMoveTabToLayoutEdgeSplit against the whole layout: the tab gets a fresh area docked to the given edge of the entire tree, sized to ratio of the root.
boolInsertTabAtLayoutEdge
SDockArea*FindAreaInLayout
SDockArea*FindFirstAreaInLayout
std::shared_ptr<CDockNode>CloneTreeStructural deep copy (nodes, areas, tab order, active tab, the persistent flag); the ADockTab objects stay shared.
voidResetOrdered shutdown hook — the layout owns host-created tabs and the factory map owns host lambdas; both must go before this DLL's statics are destroyed.

Function details

Get

C++
static CDockingManager& Get()

SetLayout

C++
void SetLayout(CDockLayout layout)

GetLayout

C++
const CDockLayout& GetLayout() const

AddTab

C++
void AddTab(const CName& areaId, std::shared_ptr<ADockTab> tab)

RemoveTab

C++
void RemoveTab(const CName& tabId)

MoveTab

C++
void MoveTab(const CName& tabId, const CName& targetAreaId, EDockDropZone zone)

SplitArea

C++
void SplitArea(SDockArea* area, EDockSplitOrientation orientation, std::shared_ptr<ADockTab> newTab, float ratio = 0.5f)

FindAreaContainingTab

C++
SDockArea* FindAreaContainingTab(const CName& tabId) const

FindArea

C++
SDockArea* FindArea(const CName& areaId) const

SaveLayoutPreset

C++
void SaveLayoutPreset(const std::string& name)

LoadLayoutPreset

C++
void LoadLayoutPreset(const std::string& name)

GetLayoutPresetNames

C++
std::vector<std::string> GetLayoutPresetNames() const

RegisterTabFactory

C++
void RegisterTabFactory(const CName& tabId, TabFactory factory)

RemoveTabFromLayout

C++
static void RemoveTabFromLayout(std::shared_ptr<CDockNode>& root, const CName& tabId)

Remove a tab from an arbitrary layout root and collapse any area (and its parent splitter) left empty. Reused by ADockSpace, which owns its own layout rather than the manager's.

CollapseEmptyAreas

C++
static void CollapseEmptyAreas(std::shared_ptr<CDockNode>& root)

Collapse empty areas (and their parent splitters) without removing a tab first — for hosts that prune restored layouts themselves.

MoveTabInLayout

C++
static bool MoveTabInLayout(std::shared_ptr<CDockNode>& root, const CName& tabId, SDockArea* targetArea, EDockDropZone zone, int32_t insertIndex = -1)

insertIndex >= 0 places a Center join at that strip position (index counted over the target's tabs excluding the moved tab); -1 appends. Center onto the source area with an index degrades to an in-well reorder instead of the historical no-op.

InsertTabInLayout

C++
static bool InsertTabInLayout(std::shared_ptr<CDockNode>& root, const std::shared_ptr<ADockTab>& tab, SDockArea* targetArea, EDockDropZone zone, int32_t insertIndex = -1)

Insert a tab that is NOT currently in the layout (tear-off re-dock). Center joins the target area; edge zones split it at 0.5.

MoveTabToLayoutEdge

C++
static bool MoveTabToLayoutEdge(std::shared_ptr<CDockNode>& root, const CName& tabId, EDockDropZone zone, float ratio = 0.25f)

Split against the whole layout: the tab gets a fresh area docked to the given edge of the entire tree, sized to ratio of the root.

InsertTabAtLayoutEdge

C++
static bool InsertTabAtLayoutEdge(std::shared_ptr<CDockNode>& root, const std::shared_ptr<ADockTab>& tab, EDockDropZone zone, float ratio = 0.25f)

FindAreaInLayout

C++
static SDockArea* FindAreaInLayout(const std::shared_ptr<CDockNode>& root, const CName& areaId)

FindFirstAreaInLayout

C++
static SDockArea* FindFirstAreaInLayout(const std::shared_ptr<CDockNode>& root)

CloneTree

C++
static std::shared_ptr<CDockNode> CloneTree(const std::shared_ptr<CDockNode>& root)

Structural deep copy (nodes, areas, tab order, active tab, the persistent flag); the ADockTab objects stay shared.

Reset

C++
void Reset()

Ordered shutdown hook — the layout owns host-created tabs and the factory map owns host lambdas; both must go before this DLL's statics are destroyed.

Generated from Arc/Docking/CDockingManager.h via arc.json · Nov 5, 2026Version 1.0.0