SDockingTabStack

A node in the Docking/Tabbing hierarchy.

API > API/Runtime > API/Runtime/Slate

A node in the Docking/Tabbing hierarchy. A DockTabStack shows a row of tabs and the content of one selected tab. It also supports re-arranging tabs and dragging them out for the stack.

   
Name SDockingTabStack
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/Docking/SDockingTabStack.h
Include Path #include "Framework/Docking/SDockingTabStack.h"

Syntax

class SDockingTabStack : public SDockingNode

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Enums

Public

Name Remarks
EChromeElement Elements for which we might want to reserve space.

Protected

Name Remarks
ECloseTabsDirection  
ETabsToClose  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionList TSharedPtr< FUICommandList > Tab command list Framework/Docking/SDockingTabStack.h  
bIsDocumentArea bool Document Areas do not disappear when out of tabs, and instead say 'Document Area' Framework/Docking/SDockingTabStack.h  
bShowingTitleBarArea bool Whether or not this tab stack is part of the title bar area Framework/Docking/SDockingTabStack.h  
ContentSlot TSharedPtr< SBorder >   Framework/Docking/SDockingTabStack.h  
InlineContentAreaLeft SHorizontalBox::FSlot * The borders that hold any potential inline content areas. Framework/Docking/SDockingTabStack.h  
InlineContentAreaRight SHorizontalBox::FSlot *   Framework/Docking/SDockingTabStack.h  
NodeMinSize float Minimum pixel size enforced on the SSplitter slot containing this stack. Framework/Docking/SDockingTabStack.h  
OverlayManagement FOverlayManagement   Framework/Docking/SDockingTabStack.h  
ShowHideTabWell FCurveSequence Animation that shows/hides the tab well; also used as a state machine to determine whether tab well is shown/hidden Framework/Docking/SDockingTabStack.h  
Tabs TArray< FTabManager::FTab > Data that persists across sessions and when the widget associated with this node is removed. Framework/Docking/SDockingTabStack.h  
TabWell TSharedPtr< class SDockingTabWell > The tab well widget shows all tabs, keeps track of the selected tab, allows tab rearranging, etc. Framework/Docking/SDockingTabStack.h  
TitleBarContent TSharedPtr< SWidget >   Framework/Docking/SDockingTabStack.h  
TitleBarSlot SVerticalBox::FSlot *   Framework/Docking/SDockingTabStack.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSidebarTab ( const TSharedRef< SDockTab >& InTab
)

   Framework/Docking/SDockingTabStack.h  

void AddTabWidget ( const TSharedRef< SDockTab >& InTab,
int32 AtLocation,
bool bKeepInactive
)

   Framework/Docking/SDockingTabStack.h  

void BringToFront ( const TSharedRef< SDockTab >& TabToBringToFront
)

   Framework/Docking/SDockingTabStack.h  

bool CanHideTabWell ()

 Returns a bool indicating whether or not a tab is in a state where it can be hidden. Framework/Docking/SDockingTabStack.h  

bool CanMoveTabToSideBar ( TSharedRef< SDockTab > Tab
) const

   Framework/Docking/SDockingTabStack.h  

void ClearReservedSpace()

 Remove all the space that might have been reserved for various window chrome elements (app icons, minimize, close, etc.) Framework/Docking/SDockingTabStack.h  

void Construct ( const FArguments& InArgs,
const TSharedRef< FTabManager::FStack >& PersistentNode
)

   Framework/Docking/SDockingTabStack.h  

TSharedPtr< SDockTab > GetSelectedTabFromWell()

   Framework/Docking/SDockingTabStack.h  

const TSlotlessChildren< SDockTab > & GetTabs()

   Framework/Docking/SDockingTabStack.h  

float GetTabSidebarSizeCoefficient ( const TSharedRef< SDockTab >& InTab
)

   Framework/Docking/SDockingTabStack.h  

FGeometry GetTabStackGeometry()

   Framework/Docking/SDockingTabStack.h  

bool HasTab ( const FTabMatcher& TabMatcher
) const

   Framework/Docking/SDockingTabStack.h  

bool IsShowingLiveTabs()

   Framework/Docking/SDockingTabStack.h  

bool IsTabLocked ( const TSharedRef< const SDockTab >& InTab
) const

   Framework/Docking/SDockingTabStack.h  

bool IsTabPinnedInSidebar ( const TSharedRef< SDockTab >& InTab
)

   Framework/Docking/SDockingTabStack.h  

bool IsTabWellHidden()

   Framework/Docking/SDockingTabStack.h  
Moves a specific tab from this stack into a sidebar Framework/Docking/SDockingTabStack.h  

void OnLastTabRemoved()

   Framework/Docking/SDockingTabStack.h  

void OnTabClosed ( const TSharedRef< SDockTab >& ClosedTab,
SDockingNode::ELayoutModification RemovalMethod
)

   Framework/Docking/SDockingTabStack.h  

void OnTabRemoved ( const FTabId& TabId
)

   Framework/Docking/SDockingTabStack.h  

void OpenTab ( const TSharedRef< SDockTab >& InTab,
int32 InsertAtLocation,
bool bKeepInactive
)

   Framework/Docking/SDockingTabStack.h  

void RemoveClosedTabsWithName ( FName InName
)

   Framework/Docking/SDockingTabStack.h  

void ReserveSpaceForWindowChrome ( EChromeElement Element,
bool bIncludePaddingForMenuBar,
bool bOnlyMinorTabs
)

 Add some extra padding so that the corresponding window chrome element does not overlap our tabs. Framework/Docking/SDockingTabStack.h  

void RestoreTabFromSidebar ( TSharedRef< SDockTab > Tab
)

 Restores a specific tab from this stack to its original position Framework/Docking/SDockingTabStack.h  

void SetNodeContent ( const TSharedRef< SWidget >& InContent,
const FDockingStackOptionalContent& OptionalContent
)

 Set the content that the DockNode is presenting. Framework/Docking/SDockingTabStack.h  

void SetNodeMinSize ( float InMinSize
)

   Framework/Docking/SDockingTabStack.h  

void SetTabLocked ( const TSharedRef< const SDockTab >& InTab,
TOptional< bool > bInLocked
)

   Framework/Docking/SDockingTabStack.h  

void SetTabPinnedInSidebar ( const TSharedRef< SDockTab >& InTab,
bool bPinnedInSidebar
)

   Framework/Docking/SDockingTabStack.h  

void SetTabSidebarSizeCoefficient ( const TSharedRef< SDockTab >& InTab,
float InSizeCoefficient
)

   Framework/Docking/SDockingTabStack.h  

void SetTabWellHidden ( bool bShouldHideTabWell
)

 Sets the tab well to hidden/not hidden. Framework/Docking/SDockingTabStack.h  

void ShowContextMenu ( const TSharedRef< SDockTab >& InContextTab,
const FWidgetPath& InWidgetPath
)

 Create and show context menu for a specific tab Framework/Docking/SDockingTabStack.h  

Public Virtual

Overridden from SDockingNode

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FTabManager::FLayoutNode > GatherPersistentLayout()

   Framework/Docking/SDockingTabStack.h  

virtual TArray< TSharedRef< SDockTab > > GetAllChildTabs()

 Recursively searches through all children looking for child tabs Framework/Docking/SDockingTabStack.h  

virtual float GetNodeMinSize()

 Minimum pixel size for this node when it is a slot in a parent splitter. Zero means no minimum. Framework/Docking/SDockingTabStack.h  

virtual Type GetNodeType()

   Framework/Docking/SDockingTabStack.h  

virtual int32 GetNumTabs()

 Gets the number of tabs in all children recursively Framework/Docking/SDockingTabStack.h  

virtual SSplitter::ESizeRule GetSizeRule()

 Should this node auto-size or be a percentage of its parent size; this setting is usually determined by users Framework/Docking/SDockingTabStack.h  

virtual FReply OnUserAttemptingDock ( SDockingNode::RelativeDirection Direction,
const FDragDropEvent& DragDropEvent
)

 Attempt to dock the TabWidget from the DragDropEvent next to this node. Framework/Docking/SDockingTabStack.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnDragLeave ( const FDragDropEvent& DragDropEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual void OnFocusChanging ( const FWeakWidgetPath& PreviousFocusPath,
const FWidgetPath& NewWidgetPath,
const FFocusEvent& InFocusEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Framework/Docking/SDockingTabStack.h  

virtual bool SupportsKeyboardFocus()

   Framework/Docking/SDockingTabStack.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CloseAllButForegroundTab ( ETabsToClose TabsToClose
)

 Close all the background tabs. Framework/Docking/SDockingTabStack.h  

void CloseAllButTab ( TSharedPtr< SDockTab > InTab,
ETabsToClose InTabsToClose
)

   Framework/Docking/SDockingTabStack.h  

void CloseForegroundTab()

   Framework/Docking/SDockingTabStack.h  

int32 ClosePersistentTab ( const FTabId& TabId
)

   Framework/Docking/SDockingTabStack.h  

void CloseTab ( TSharedPtr< SDockTab > InTab
)

   Framework/Docking/SDockingTabStack.h  

void CloseTabsInDirectionFromForegroundTab ( ETabsToClose TabsToClose,
ECloseTabsDirection Direction
)

   Framework/Docking/SDockingTabStack.h  

void CloseTabsInDirectionFromTab ( TSharedPtr< SDockTab > InTab,
ETabsToClose InTabsToClose,
ECloseTabsDirection InDirection
)

   Framework/Docking/SDockingTabStack.h  

bool IsContentEnabled()

   Framework/Docking/SDockingTabStack.h  

int32 OpenPersistentTab ( const FTabId& TabId,
int32 OpenLocationAmongActiveTabs
)

   Framework/Docking/SDockingTabStack.h  

void RemovePersistentTab ( const FTabId& TabId
)

   Framework/Docking/SDockingTabStack.h  

FReply TabWellRightClicked ( const FGeometry& TabWellGeometry,
const FPointerEvent& MouseEvent
)

   Framework/Docking/SDockingTabStack.h  

Protected Virtual

Overridden from SDockingNode

Name Remarks Include Path Unreal Specifiers

virtual SDockingNode::ECleanupRetVal CleanUpNodes()

   Framework/Docking/SDockingTabStack.h  

virtual void SetParentNode ( TSharedRef< class SDockingSplitter > InParent
)

 Overridden from SDockingNode Framework/Docking/SDockingTabStack.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual EWindowZone::Type GetWindowZoneOverride()

   Framework/Docking/SDockingTabStack.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetIncrementFromCloseTabsDirection ( ECloseTabsDirection
)

   Framework/Docking/SDockingTabStack.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page