Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Docking > SDockTab

Light Theme

Dark Theme

SDockTab

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

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SBorder

SDockTab

SLiveLinkCurveDebugUITab

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h
Include	#include "Widgets/Docking/SDockTab.h"

Syntax

class SDockTab : public SBorder

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 SDockingTabStack.

Variables

	Name	Description
bool	bCanEverClose	Determines whether the close button for the tab is shown.
bool	bShouldAutosize	Should this tab be auto-sized based on its content?
TSharedRef< SWi...	Content	The stuff to show when this tab is selected
TAttribute< FMa...	ContentAreaPadding
TSharedPtr< SDo...	DraggedOverDockingArea	The dock area this tab is currently being dragged over. Used in nomad tabs to change style
FCurveSequence	FlashTabCurve	Animation that causes the tab to flash
const FDockTabS...	GenericTabStyle
TAttribute< FLi...	IconColor	Color of this tab's icon
TSharedPtr< SIm...	IconWidget	Widget used to show the icon on the tab
TSharedPtr< STe...	LabelSuffix
TSharedPtr< STe...	LabelWidget	Widget used to show the label on the tab
double	LastActivationTime	Time this tab was last activated
FTabId	LayoutIdentifier	The tab's layout identifier
const FDockTabS...	MajorTabStyle	The styles used to draw the tab in its various states
TWeakPtr< FTabM...	MyTabManager	The tab manager that created this tab.
FCanCloseTab	OnCanCloseTab	Delegate to execute to determine if we can close this tab
FExtendContextM...	OnExtendContextMenu
FOnPersistVisua...	OnPersistVisualState	Invoked during the Save Visual State pass; gives this tab a chance to save misc info about visual state.
FOnTabActivated...	OnTabActivated	Callback to call when this tab is activated
FOnTabClosedCal...	OnTabClosed	Callback to call when this tab is destroyed
FSimpleDelegate	OnTabDraggedOverDockArea
FSimpleDelegate	OnTabDrawerClosedEvent
FSimpleDelegate	OnTabDrawerOpenedEvent
FSimpleDelegate	OnTabRelocated
FOnTabRenamed	OnTabRenamed	Invoked when the tab is renamed
TWeakPtr< SDock...	ParentPtr	The tab's parent tab well. Null if it is a floating tab.
FCurveSequence	SpawnAnimCurve	Animation that shows the tab opening up
TAttribute< FLi...	TabColorScale	Color of this tab
TAttribute< con...	TabIcon	The icon on the tab
TAttribute< FTe...	TabLabel	The label on the tab
TAttribute< FTe...	TabLabelSuffix	A second text field at the end of the Label that takes precedence and isn't lost when space is restricted
ETabRole	TabRole	Is this an MajorTab? A tool panel tab?
TSharedRef< SWi...	TabWellContentLeft
TSharedRef< SWi...	TabWellContentRight
TSharedRef< SWi...	TitleBarContentRight

Constructors

	Name	Description
	SDockTab()	Protected constructor; Widgets may only be constructed via a FArguments (i.e.: SNew(SDockTab) )

Functions

	Name	Description
void	ActivateInParent ( ETabActivationCause InActivationCau... )	Make this tab active in its tabwell
bool	CanCloseTab()
void	Construct ( const FArguments& InArgs )	Construct the widget from the declaration.
void	DrawAttention()	Draws attention to the tab.
void	ExtendContextMenu ( FMenuBuilder& MenuBuilder )	Add any entries specific to this tab to the tab context menu
void	FlashTab()	Flash the tab, used for drawing attention to it
EVisibility	GetActiveTabIndicatorVisibility()
UE::Slate::F...	GetAnimatedScale()
FText	GetCloseButtonToolTipText()	The close button tooltip showing the appropriate close command shortcut
const FSlate...	GetColorOverlayImageBrush()
TSharedRef< ...	GetContent()
const FSlate...	GetContentAreaBrush()	What should the content area look like for this type of tab? Documents, Apps, and Tool Panels have different backgrounds.
FMargin	GetContentPadding()	Padding around the content when it is presented by the SDockingTabStack
const FDockT...	GetCurrentStyle()
TSharedPtr< ...	GetDockArea()	Gets the dock area that this resides in
FSlateColor	GetFlashColor()
const FSlate...	GetFlashOverlayImageBrush()
float	GetFlashValue()	Get the desired color of tab. These change during flashing.
FSlateColor	GetIconColor()
const FSlate...	GetImageBrush()
double	GetLastActivationTime()	Returns the time this tab was last activated
const FTabId	GetLayoutIdentifier()	Gets this tab's layout identifier
TSharedRef< ...	GetLeftContent()
float	GetOverlapWidth()	The width that this tab will overlap with side-by-side tabs.
TSharedPtr< ...	GetParent()	Gets the tab's tab well parent, or nothing, if it has none
TSharedPtr< ...	GetParentDockTabStack()	Gets the dock tab stack this dockable tab resides within, if any
TSharedPtr< ...	GetParentWindow()	Get the window in which this tab's tabmanager has placed it
TSharedRef< ...	GetRightContent()
FSlateColor	GetTabColor()
const FSlate...	GetTabIcon()	Gets the tab icon
FMargin	GetTabIconBorderPadding()
TOptional< F...	GetTabIconSize()
FText	GetTabLabel()	The label on the tab
FText	GetTabLabelSuffix()	Get Label Suffix
TSharedPtr< ...	GetTabManagerPtr()	Get the tab manager currently managing this tab.
FMargin	GetTabPadding()
ETabRole	GetTabRole()	Is this an MajorTab? A tool panel tab?
const FSlate...	GetTabWellBrush()	Depending on the tabs we put into the tab well, we want a different background brush.
TSharedRef< ...	GetTitleBarRightContent()
ETabRole	GetVisualTabRole()	Similar to GetTabRole() but returns the correct role for UI style and user input purposes
EVisibility	HandleIsCloseButtonVisible()
bool	HasSiblingTab ( const FTabId& SiblingTabId, const bool TreatIndexNoneAsWildcard )	Check to see whether this tab has a sibling tab with the given tab ID
bool	IsActive()
bool	IsForeground()
FReply	OnCloseButtonClicked()	Called when the close button is clicked on the tab.
void	PersistVisualState()	A chance for the tab's content to save any internal layout info
void	PlaySpawnAnim()	Play an animation showing this tab as opening
void	ProvideDefaultIcon ( const FSlateBrush* InDefaultIc... )	Provide a default tab icon.
void	ProvideDefaultLabel ( const FText& InDefaultLabel )	Provide a default tab label in case the spawner did not set one.
void	RemoveTabFromParent()	Pulls this tab out of it's parent tab stack and destroys it Note: This does not check if its safe to remove the tab.
bool	RequestCloseTab()	Requests that the tab be closed. Tabs may prevent closing depending on their state
void	SetCanCloseTab ( const FCanCloseTab& InOnTabClosing )	Set the handler to be invoked when the user requests that this tab be closed.
void	SetDraggedOverDockArea ( const TSharedPtr< SDockingArea >& ... )	Used by the drag/drop operation to signal to this tab what it is dragging over.
void	SetLabel ( const TAttribute< FText >& InTabLa... )	The label that appears on the tab.
void	SetLayoutIdentifier ( const FTabId& TabId )	Specify the TabId that was used to spawn this tab.
void	SetLeftContent ( TSharedRef< SWidget > InContent )	Content that appears in the TabWell to the left of the tabs
void	SetOnExtendContextMenu ( const FExtendContextMenu& Handler )	Set the handler for extending the tab context menu
void	SetOnPersistVisualState ( const FOnPersistVisualState& Handl... )	Set the custom code to execute for saving visual state in this tab.
void	SetOnTabActivated ( const FOnTabActivatedCallback& InD... )	Set the handler that will be invoked when the tab is activated
void	SetOnTabClosed ( const FOnTabClosedCallback& InDele... )	Set the handler that will be invoked when the tab is closed
void	SetOnTabDraggedOverDockArea ( const FSimpleDelegate InDelegate )	Set the handler that will be invoked when the tab is dragged over dock area
void	SetOnTabDrawerClosed ( const FSimpleDelegate InDelegate )	Set the handler that will be invoked when the tab is closed from a drawer
void	SetOnTabDrawerOpened ( const FSimpleDelegate InDelegate )	Set the handler that will be invoked when the tab is opened from a drawer
void	SetOnTabRelocated ( const FSimpleDelegate InDelegate )	Set the handler that will be invoked when the tab is relocated to a new tab well
void	SetOnTabRenamed ( const FOnTabRenamed& InDelegate )	Set the handler that will be invoked when the tab is renamed
void	SetParent ( TSharedPtr< SDockingTabWell > Paren... )	Sets the tab's tab well parent, or resets it if nothing is passed in
void	SetRightContent ( TSharedRef< SWidget > InContent )	Content that appears in the TabWell to the right of the tabs
void	SetShouldAutosize ( const bool bNewShouldAutosize )	Set whether this tab should be sized based on its content.
void	SetTabIcon ( const TAttribute< const FSlateBrush... )	Sets the tab icon
void	SetTabLabelSuffix ( const TAttribute< FText >& InTabLa... )	Set Label Suffix.
void	SetTabManager ( const TSharedPtr< FTabManager >& I... )	Set the tab manager that is controlling this tab
void	SetTabToolTipWidget ( TSharedPtr< SToolTip > InTabToolTip... )	The tooltip text that appears on the tab.
void	SetTitleBarRightContent ( TSharedRef< SWidget > InContent )	Content that appears on the right side of the title bar in the window this stack is in
bool	ShouldAutosize()	Should this tab be sized based on its content.
void	UpdateActivationTime()	Updates the 'last activated' time to the current time

Overridden from SBorder

		Name	Description
	void	SetContent ( TSharedRef< SWidget > InContent )	Sets the content for this border

Overridden from SWidget

	Name	Description
FSlateColor	GetForegroundColor()
FReply	OnDragDetected ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when Slate detects that a widget started to be dragged.
void	OnDragEnter ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
void	OnDragLeave ( const FDragDropEvent& DragDropEven... )	Called during drag and drop when the drag leaves a widget.
FReply	OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called when the user is dropping something onto a widget; terminates drag and drop.
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
FReply	OnTouchEnded ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is ended (finger lifted)
FReply	OnTouchStarted ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is started (finger down)

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
FCanCloseTab	Delegate called before a tab is closed. Returning false will prevent the tab from closing
FExtendContextMenu	Invoked to add entries to the tab context menu
FOnPersistVisualState	Invoked w`en this tab should save some information about its content.
FOnTabActivatedCallback	Invoked when a tab is activated
FOnTabClosedCallback	Invoked when a tab is closing
FOnTabRenamed	Invoked when a tab is renamed

Deprecated Functions

		Name	Description
	TSharedRef< ...	GetTabManager()	The tab manager is not guaranteed to exist, which will cause GetTabManager() to crash. Use GetTabManagerPtr() instead.

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

Take our survey

Cancel