SDockableTab

A tab widget that also holds on to some content that should be shown when this tab is selected.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockableTab.h

Include

#include "Widgets/Docking/SDockableTab.h"

Syntax

class SDockableTab

Remarks

A tab widget that also holds on to some content that should be shown when this tab is selected. Intended to be used in conjunction with SDockTabStack.

Variables

Name Description

Protected variable

bool

 

bShouldAutosize

Should this tab be auto-sized based on its content?

Protected variable

const FSlateBru...

 

ContentAreaBrush

The brush that the SDockTabStack should use to draw the content associated with this tab Documents, Apps, and Tool Panels have different backgrounds

Protected variable

TAttribute< FMa...

 

ContentAreaPadding

Protected variable

FName

 

LayoutIdentifier

The tab's layout identifier

Protected variable

SDockTab::FCanC...

 

OnCanCloseTab

Delegate to execute to determine if we can close this tab

Protected variable

FOnTabClosedCal...

 

OnTabClosed

Callback to call when this tab is destroyed

Protected variable

FOnTabStackMenu...

 

OnTabStackMenuOpeningHandler

Called when the the tab stack's context menu is open; gives the currently focused tab a change to add custom

Protected variable

float

 

OverlapWidth

The width that this tab will overlap with side-by-side tabs.

Protected variable

FLinearColor

 

TabColorScale

Color of this tab

Protected variable

TAttribute< FSt...

 

TabLabel

The label on the tab

Protected variable

ETabRole

 

TabRole

Is this an MajorTab? A tool panel tab?

Protected variable

const FSlateBru...

 

TabWellBrush

Protected variable

FMargin

 

TabWellPadding

Functions

Name Description

Public function

void

 

ActivateInParent

(
    ETabActivationCause InActivationCau...
)

Make this tab active in its tabwell

Public function

void

 

BringToFrontInParent()

Brings this tab to the front of its parent's tab well, if applicable.

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct the widget from the declaration.

Public function

TSharedRef< ...

 

GetContent()

Public function Const

TSharedPtr< ...

 

GetParentDockTabStack()

Gets the dock tab stack this dockable tab resides within, if any

Public function Const

bool

 

IsActive()

Public function Const

bool

 

IsForeground()

Public function

void

 

RemoveTabFromParent()

Pulls this tab out of it's parent tab stack and destroys it

Public function

void

 

RequestCloseTab()

Requests that the tab be closed. Tabs may prevent closing depending on their state

Public function

void

 

SetContent

(
    TSharedRef< SWidget > InContent
)

Public function

void

 

SetOnTabStackMenuOpening

(
    const FOnTabStackMenuOpening& InHa...
)

Set delegate to invoke when tab stack menu is opening

Public function Const

bool

 

ShouldAutosize()

Should this tab be sized based on its content.

Classes

Name

Description

Public struct

FArguments

Typedefs

Name

Description

FOnTabClosedCallback

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss