Navigation
API > API/Runtime > API/Runtime/Slate
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.
| Name | SDockTab |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Docking/SDockTab.h |
| Include Path | #include "Widgets/Docking/SDockTab.h" |
Syntax
class SDockTab : public SBorder
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBorder → SDockTab
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBorder → SDockTab
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SDockTab() |
Protected constructor; Widgets may only be constructed via a FArguments (i.e.: SNew(SDockTab) ) | Widgets/Docking/SDockTab.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCanCloseTab | TBaseDelegate_NoParams< bool > | Delegate called before a tab is closed. Returning false will prevent the tab from closing | Widgets/Docking/SDockTab.h |
| FExtendContextMenu | TBaseDelegate_OneParam< void, FMenuBuilder & > | Invoked to add entries to the tab context menu | Widgets/Docking/SDockTab.h |
| FOnPersistVisualState | TBaseDelegate_NoParams< void > | Invoked w`en this tab should save some information about its content. | Widgets/Docking/SDockTab.h |
| FOnTabActivatedCallback | TBaseDelegate_TwoParams< void, TSharedRef< SDockTab >, ETabActivationCause > | Invoked when a tab is activated | Widgets/Docking/SDockTab.h |
| FOnTabClosedCallback | TBaseDelegate_OneParam< void, TSharedRef< SDockTab > > | Invoked when a tab is closing | Widgets/Docking/SDockTab.h |
| FOnTabRenamed | TBaseDelegate_OneParam< void, TSharedRef< SDockTab > > | Invoked when a tab is renamed | Widgets/Docking/SDockTab.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DragDropTimerHandle | TWeakPtr< FActiveTimerHandle > | The handle to the active tab activation tick | Widgets/Docking/SDockTab.h | |
| UpdateStyleTimerHandle | TWeakPtr< FActiveTimerHandle > | Widgets/Docking/SDockTab.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateInParent
(
ETabActivationCause InActivationCause |
Make this tab active in its tabwell | Widgets/Docking/SDockTab.h | |
bool CanCloseTab() |
Widgets/Docking/SDockTab.h | ||
void Construct
(
const FArguments& InArgs |
Construct the widget from the declaration. | Widgets/Docking/SDockTab.h | |
void DrawAttention() |
Draws attention to the tab. | Widgets/Docking/SDockTab.h | |
void ExtendContextMenu
(
FMenuBuilder& MenuBuilder |
Add any entries specific to this tab to the tab context menu | Widgets/Docking/SDockTab.h | |
void FlashTab() |
Flash the tab, used for drawing attention to it | Widgets/Docking/SDockTab.h | |
TSharedRef< SWidget > GetContent() |
Widgets/Docking/SDockTab.h | ||
const FSlateBrush * GetContentAreaBrush() |
What should the content area look like for this type of tab? Documents, Apps, and Tool Panels have different backgrounds. | Widgets/Docking/SDockTab.h | |
FMargin GetContentPadding() |
Padding around the content when it is presented by the SDockingTabStack | Widgets/Docking/SDockTab.h | |
TSharedPtr< class SDockingArea > GetDockArea() |
Gets the dock area that this resides in | Widgets/Docking/SDockTab.h | |
double GetLastActivationTime() |
Returns the time this tab was last activated | Widgets/Docking/SDockTab.h | |
const FTabId GetLayoutIdentifier() |
Gets this tab's layout identifier | Widgets/Docking/SDockTab.h | |
TSharedRef< SWidget > GetLeftContent() |
Widgets/Docking/SDockTab.h | ||
float GetOverlapWidth() |
The width that this tab will overlap with side-by-side tabs. | Widgets/Docking/SDockTab.h | |
TSharedPtr< SDockingTabWell > GetParent() |
Gets the tab's tab well parent, or nothing, if it has none | Widgets/Docking/SDockTab.h | |
TSharedPtr< SDockingTabStack > GetParentDockTabStack() |
Gets the dock tab stack this dockable tab resides within, if any | Widgets/Docking/SDockTab.h | |
TSharedPtr< SWindow > GetParentWindow() |
Get the window in which this tab's tabmanager has placed it | Widgets/Docking/SDockTab.h | |
TSharedRef< SWidget > GetRightContent() |
Widgets/Docking/SDockTab.h | ||
const FSlateBrush * GetTabIcon() |
Gets the tab icon | Widgets/Docking/SDockTab.h | |
FText GetTabLabel() |
The label on the tab | Widgets/Docking/SDockTab.h | |
FText GetTabLabelSuffix() |
Get Label Suffix | Widgets/Docking/SDockTab.h | |
| Get the tab manager currently managing this tab. | Widgets/Docking/SDockTab.h | ||
| Get the tab manager currently managing this tab. | Widgets/Docking/SDockTab.h | ||
ETabRole GetTabRole() |
Is this an MajorTab? A tool panel tab? | Widgets/Docking/SDockTab.h | |
const FSlateBrush * GetTabWellBrush() |
Depending on the tabs we put into the tab well, we want a different background brush. | Widgets/Docking/SDockTab.h | |
TSharedRef< SWidget > GetTitleBarRightContent() |
Widgets/Docking/SDockTab.h | ||
ETabRole GetVisualTabRole() |
Similar to GetTabRole() but returns the correct role for UI style and user input purposes | Widgets/Docking/SDockTab.h | |
bool HasSiblingTab
(
const FTabId& SiblingTabId, |
Check to see whether this tab has a sibling tab with the given tab ID | Widgets/Docking/SDockTab.h | |
bool IsActive() |
Widgets/Docking/SDockTab.h | ||
bool IsForeground() |
Widgets/Docking/SDockTab.h | ||
void PersistVisualState() |
A chance for the tab's content to save any internal layout info | Widgets/Docking/SDockTab.h | |
void PlaySpawnAnim() |
Play an animation showing this tab as opening | Widgets/Docking/SDockTab.h | |
void ProvideDefaultLabel
(
const FText& InDefaultLabel |
Provide a default tab label in case the spawner did not set one. | Widgets/Docking/SDockTab.h | |
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. | Widgets/Docking/SDockTab.h | |
bool RequestCloseTab() |
Requests that the tab be closed. Tabs may prevent closing depending on their state | Widgets/Docking/SDockTab.h | |
void SetCanCloseTab
(
const FCanCloseTab& InOnTabClosing |
Set the handler to be invoked when the user requests that this tab be closed. | Widgets/Docking/SDockTab.h | |
void SetDraggedOverDockArea
(
const TSharedPtr< SDockingArea >& Area |
Used by the drag/drop operation to signal to this tab what it is dragging over. | Widgets/Docking/SDockTab.h | |
void SetLabel
(
const TAttribute< FText >& InTabLabel |
The label that appears on the tab. | Widgets/Docking/SDockTab.h | |
void SetLeftContent
(
TSharedRef< SWidget > InContent |
Content that appears in the TabWell to the left of the tabs | Widgets/Docking/SDockTab.h | |
void SetOnExtendContextMenu
(
const FExtendContextMenu& Handler |
Set the handler for extending the tab context menu | Widgets/Docking/SDockTab.h | |
void SetOnPersistVisualState
(
const FOnPersistVisualState& Handler |
Set the custom code to execute for saving visual state in this tab. | Widgets/Docking/SDockTab.h | |
void SetOnTabActivated
(
const FOnTabActivatedCallback& InDelegate |
Set the handler that will be invoked when the tab is activated | Widgets/Docking/SDockTab.h | |
void SetOnTabClosed
(
const FOnTabClosedCallback& InDelegate |
Set the handler that will be invoked when the tab is closed | Widgets/Docking/SDockTab.h | |
void SetOnTabDraggedOverDockArea
(
const FSimpleDelegate InDelegate |
Set the handler that will be invoked when the tab is dragged over dock area | Widgets/Docking/SDockTab.h | |
void SetOnTabDrawerClosed
(
const FSimpleDelegate InDelegate |
Set the handler that will be invoked when the tab is closed from a drawer | Widgets/Docking/SDockTab.h | |
void SetOnTabDrawerOpened
(
const FSimpleDelegate InDelegate |
Set the handler that will be invoked when the tab is opened from a drawer | Widgets/Docking/SDockTab.h | |
void SetOnTabRelocated
(
const FSimpleDelegate InDelegate |
Set the handler that will be invoked when the tab is relocated to a new tab well | Widgets/Docking/SDockTab.h | |
void SetOnTabRenamed
(
const FOnTabRenamed& InDelegate |
Set the handler that will be invoked when the tab is renamed | Widgets/Docking/SDockTab.h | |
void SetParent
(
TSharedPtr< SDockingTabWell > Parent |
Sets the tab's tab well parent, or resets it if nothing is passed in | Widgets/Docking/SDockTab.h | |
void SetParentDockTabStackTabWellHidden
(
bool bIsTabWellHidden |
Widgets/Docking/SDockTab.h | ||
void SetRightContent
(
TSharedRef< SWidget > InContent |
Content that appears in the TabWell to the right of the tabs | Widgets/Docking/SDockTab.h | |
void SetShouldAutosize
(
const bool bNewShouldAutosize |
Set whether this tab should be sized based on its content. | Widgets/Docking/SDockTab.h | |
void SetTabIcon
(
const TAttribute< const FSlateBrush* > InTabIcon |
Sets the tab icon | Widgets/Docking/SDockTab.h | |
void SetTabLabelOverflowPolicy
(
ETextOverflowPolicy InOverflowPolicy |
Set the Label overflow policy | Widgets/Docking/SDockTab.h | |
void SetTabLabelSuffix
(
const TAttribute< FText >& InTabLabelSuffix |
Set Label Suffix. | Widgets/Docking/SDockTab.h | |
void SetTabManager
(
const TSharedPtr< FTabManager >& InTabManager |
Set the tab manager that is controlling this tab | Widgets/Docking/SDockTab.h | |
void SetTabToolTipWidget
(
TSharedPtr< SToolTip > InTabToolTipWidget |
The tooltip text that appears on the tab. | Widgets/Docking/SDockTab.h | |
void SetTitleBarRightContent
(
TSharedRef< SWidget > InContent |
Content that appears on the right side of the title bar in the window this stack is in | Widgets/Docking/SDockTab.h | |
bool ShouldAutosize() |
Should this tab be sized based on its content. | Widgets/Docking/SDockTab.h | |
void UpdateActivationTime() |
Updates the 'last activated' time to the current time | Widgets/Docking/SDockTab.h |
Overridden from SBorder
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetContent
(
TSharedRef< SWidget > InContent |
Sets the content for this border | Widgets/Docking/SDockTab.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FSlateColor GetForegroundColor() |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnDragDetected
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual void OnDragEnter
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual void OnDragLeave
(
const FDragDropEvent& DragDropEvent |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnDrop
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnMouseButtonDoubleClick
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnTouchEnded
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h | ||
virtual FReply OnTouchStarted
(
const FGeometry& MyGeometry, |
Widgets/Docking/SDockTab.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EVisibility GetActiveTabIndicatorVisibility() |
Widgets/Docking/SDockTab.h | ||
UE::Slate::FDeprecateVector2DResult GetAnimatedScale() |
Widgets/Docking/SDockTab.h | ||
FText GetCloseButtonToolTipText() |
The close button tooltip showing the appropriate close command shortcut | Widgets/Docking/SDockTab.h | |
const FSlateBrush * GetColorOverlayImageBrush() |
Widgets/Docking/SDockTab.h | ||
const FDockTabStyle & GetCurrentStyle() |
Widgets/Docking/SDockTab.h | ||
FSlateColor GetFlashColor() |
Widgets/Docking/SDockTab.h | ||
const FSlateBrush * GetFlashOverlayImageBrush() |
Widgets/Docking/SDockTab.h | ||
float GetFlashValue() |
Get the desired color of tab. These change during flashing. | Widgets/Docking/SDockTab.h | |
FSlateColor GetIconColor() |
Widgets/Docking/SDockTab.h | ||
const FSlateBrush * GetImageBrush() |
Widgets/Docking/SDockTab.h | ||
FSlateColor GetTabColor() |
Widgets/Docking/SDockTab.h | ||
FMargin GetTabIconBorderPadding() |
Widgets/Docking/SDockTab.h | ||
TOptional< FVector2D > GetTabIconSize() |
Widgets/Docking/SDockTab.h | ||
FMargin GetTabPadding() |
Widgets/Docking/SDockTab.h | ||
EVisibility HandleIsCloseButtonVisible() |
Widgets/Docking/SDockTab.h | ||
FReply OnCloseButtonClicked() |
Called when the close button is clicked on the tab. | Widgets/Docking/SDockTab.h | |
void ProvideDefaultIcon
(
const FSlateBrush* InDefaultIcon |
Provide a default tab icon. | Widgets/Docking/SDockTab.h | |
void SetLayoutIdentifier
(
const FTabId& TabId |
Specify the TabId that was used to spawn this tab. | Widgets/Docking/SDockTab.h |