class

ADockTab

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

Constructors

SignatureNameDescription
ADockTab() = defaultADockTab
ADockTab(const CName& id, const CText& title, TSharedPtr<AWidget> content, EDock…ADockTab

Public functions

ReturnsNameDescription
const CName&GetId
voidSetId
const CText&GetTitle
voidSetTitle
TSharedPtr<AWidget>GetContent
voidSetContent
EDockTabRoleGetRole
voidSetRole
const CName&GetIcon
voidSetIcon
voidSetIconTintA document tab's glyph wears its asset type's colour (editor-main: a material's circle in AssetMaterial); unset, the tab state's own icon colour applies.
boolHasIconTint
const ArcColor&GetIconTint
voidSetPanelHeaderA panel that is alone in its area shows a header instead of a tab (editor-main's "Place actors": BodyStrong title, no tab chrome).
boolIsPanelHeader
voidSetHeaderHintA shortcut hint at the right of the tab's header while it is the active tab (editor-main's Content Browser: "Ctrl Space" in a key cap, then "Drawer").
const std::string&GetHeaderHintKeys
const std::string&GetHeaderHintLabel
voidSetHeaderActionA control at the right of the tab's header while it is the active tab (place-actors' "···" panel menu).
TSharedPtr<AWidget>GetHeaderAction
voidSetFrameOutsetGrows the area's panel frame past its slot on the left, top and bottom while this tab is in front (px).
floatGetFrameOutsetLeft
floatGetFrameOutsetTop
floatGetFrameOutsetBottom
boolIsCloseable
voidSetCloseable
boolIsActive
voidSetActive
boolIsDirty
voidSetDirty
int32_tGetBadgeCount
EDockTabBadgeGetBadgeKind
boolSetBadgeTrue when the badge changed, so the host re-lays the tab strip.
voidSetOnCloseRequestConsulted by ADockSpace::CloseTab before removing the tab.
const std::function<bool()>&GetOnCloseRequest

Function details

ADockTab

C++
ADockTab() = default

ADockTab

C++
ADockTab(const CName& id, const CText& title, TSharedPtr<AWidget> content, EDockTabRole role = EDockTabRole::Panel) : m_id(id), m_title(title), m_content(content), m_role(role)

GetId

C++
const CName& GetId() const

SetId

C++
void SetId(const CName& id)

GetTitle

C++
const CText& GetTitle() const

SetTitle

C++
void SetTitle(const CText& title)

GetContent

C++
TSharedPtr<AWidget> GetContent() const

SetContent

C++
void SetContent(TSharedPtr<AWidget> content)

GetRole

C++
EDockTabRole GetRole() const

SetRole

C++
void SetRole(EDockTabRole role)

GetIcon

C++
const CName& GetIcon() const

SetIcon

C++
void SetIcon(const CName& icon)

SetIconTint

C++
void SetIconTint(const ArcColor& tint)

A document tab's glyph wears its asset type's colour (editor-main: a material's circle in AssetMaterial); unset, the tab state's own icon colour applies.

HasIconTint

C++
bool HasIconTint() const

GetIconTint

C++
const ArcColor& GetIconTint() const

SetPanelHeader

C++
void SetPanelHeader(bool header)

A panel that is alone in its area shows a header instead of a tab (editor-main's "Place actors": BodyStrong title, no tab chrome). With a second tab docked beside it, it is a tab again.

IsPanelHeader

C++
bool IsPanelHeader() const

SetHeaderHint

C++
void SetHeaderHint(const std::string& keys, const std::string& label)

A shortcut hint at the right of the tab's header while it is the active tab (editor-main's Content Browser: "Ctrl Space" in a key cap, then "Drawer").

GetHeaderHintKeys

C++
const std::string& GetHeaderHintKeys() const

GetHeaderHintLabel

C++
const std::string& GetHeaderHintLabel() const

SetHeaderAction

C++
void SetHeaderAction(TSharedPtr<AWidget> action)

A control at the right of the tab's header while it is the active tab (place-actors' "···" panel menu).

GetHeaderAction

C++
TSharedPtr<AWidget> GetHeaderAction() const

SetFrameOutset

C++
void SetFrameOutset(float left, float top, float bottom)

Grows the area's panel frame past its slot on the left, top and bottom while this tab is in front (px). The design draws some panels a pixel outside the seams the others keep: the mode tool panels on three sides, the Details well's tool and settings tabs on top.

GetFrameOutsetLeft

C++
float GetFrameOutsetLeft() const

GetFrameOutsetTop

C++
float GetFrameOutsetTop() const

GetFrameOutsetBottom

C++
float GetFrameOutsetBottom() const

IsCloseable

C++
bool IsCloseable() const

SetCloseable

C++
void SetCloseable(bool closeable)

IsActive

C++
bool IsActive() const

SetActive

C++
void SetActive(bool active)

IsDirty

C++
bool IsDirty() const

SetDirty

C++
void SetDirty(bool dirty)

GetBadgeCount

C++
int32_t GetBadgeCount() const

GetBadgeKind

C++
EDockTabBadge GetBadgeKind() const

SetBadge

C++
bool SetBadge(int32_t count, EDockTabBadge kind)

True when the badge changed, so the host re-lays the tab strip.

SetOnCloseRequest

C++
void SetOnCloseRequest(std::function<bool()> onCloseRequest)

Consulted by ADockSpace::CloseTab before removing the tab. Returning false vetoes the close — the host owns whatever confirmation flow follows and force-closes later. Unset = always closeable.

GetOnCloseRequest

C++
const std::function<bool()>& GetOnCloseRequest() const
Generated from Arc/Docking/ADockTab.h via arc.json · Nov 5, 2026Version 1.0.0