ADockTab
- Module
- Arc
- Header
#include "Arc/Docking/ADockTab.h"- Namespace
Arcf
Constructors
| Signature | Name | Description |
|---|---|---|
ADockTab() = default | ADockTab | |
ADockTab(const CName& id, const CText& title, TSharedPtr<AWidget> content, EDock… | ADockTab |
Public functions
| Returns | Name | Description |
|---|---|---|
const CName& | GetId | |
void | SetId | |
const CText& | GetTitle | |
void | SetTitle | |
TSharedPtr<AWidget> | GetContent | |
void | SetContent | |
EDockTabRole | GetRole | |
void | SetRole | |
const CName& | GetIcon | |
void | SetIcon | |
void | SetIconTint | 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. |
bool | HasIconTint | |
const ArcColor& | GetIconTint | |
void | SetPanelHeader | 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). |
bool | IsPanelHeader | |
void | SetHeaderHint | 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"). |
const std::string& | GetHeaderHintKeys | |
const std::string& | GetHeaderHintLabel | |
void | SetHeaderAction | A control at the right of the tab's header while it is the active tab (place-actors' "···" panel menu). |
TSharedPtr<AWidget> | GetHeaderAction | |
void | SetFrameOutset | Grows the area's panel frame past its slot on the left, top and bottom while this tab is in front (px). |
float | GetFrameOutsetLeft | |
float | GetFrameOutsetTop | |
float | GetFrameOutsetBottom | |
bool | IsCloseable | |
void | SetCloseable | |
bool | IsActive | |
void | SetActive | |
bool | IsDirty | |
void | SetDirty | |
int32_t | GetBadgeCount | |
EDockTabBadge | GetBadgeKind | |
bool | SetBadge | True when the badge changed, so the host re-lays the tab strip. |
void | SetOnCloseRequest | Consulted by ADockSpace::CloseTab before removing the tab. |
const std::function<bool()>& | GetOnCloseRequest |
Function details
ADockTab
ADockTab() = defaultADockTab
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
const CName& GetId() constSetId
void SetId(const CName& id)GetTitle
const CText& GetTitle() constSetTitle
void SetTitle(const CText& title)GetContent
TSharedPtr<AWidget> GetContent() constSetContent
void SetContent(TSharedPtr<AWidget> content)GetRole
EDockTabRole GetRole() constSetRole
void SetRole(EDockTabRole role)GetIcon
const CName& GetIcon() constSetIcon
void SetIcon(const CName& icon)SetIconTint
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
bool HasIconTint() constGetIconTint
const ArcColor& GetIconTint() constSetPanelHeader
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
bool IsPanelHeader() constSetHeaderHint
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
const std::string& GetHeaderHintKeys() constGetHeaderHintLabel
const std::string& GetHeaderHintLabel() constSetHeaderAction
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
TSharedPtr<AWidget> GetHeaderAction() constSetFrameOutset
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
float GetFrameOutsetLeft() constGetFrameOutsetTop
float GetFrameOutsetTop() constGetFrameOutsetBottom
float GetFrameOutsetBottom() constIsCloseable
bool IsCloseable() constSetCloseable
void SetCloseable(bool closeable)IsActive
bool IsActive() constSetActive
void SetActive(bool active)IsDirty
bool IsDirty() constSetDirty
void SetDirty(bool dirty)GetBadgeCount
int32_t GetBadgeCount() constGetBadgeKind
EDockTabBadge GetBadgeKind() constSetBadge
bool SetBadge(int32_t count, EDockTabBadge kind)True when the badge changed, so the host re-lays the tab strip.
SetOnCloseRequest
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
const std::function<bool()>& GetOnCloseRequest() const