UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SDockingTabStack Class Reference

#include <SDockingTabStack.h>

+ Inheritance diagram for SDockingTabStack:

Public Types

enum class  EChromeElement { Icon , Controls }
 
- Public Types inherited from SDockingNode
enum  Type { DockTabStack , DockSplitter , DockArea , PlaceholderNode }
 
enum  RelativeDirection {
  LeftOf , Above , RightOf , Below ,
  Center
}
 
enum  ELayoutModification { TabRemoval_DraggedOut , TabRemoval_Closed , TabRemoval_Sidebar , TabRemoval_None }
 
enum  ECleanupRetVal { VisibleTabsUnderNode , HistoryTabsUnderNode , NoTabsUnderNode }
 

Public Member Functions

 SLATE_BEGIN_ARGS (SDockingTabStack)
 
virtual Type GetNodeType () const override
 
SLATE_API void OnLastTabRemoved ()
 
SLATE_API void OnTabClosed (const TSharedRef< SDockTab > &ClosedTab, SDockingNode::ELayoutModification RemovalMethod)
 
SLATE_API void OnTabRemoved (const FTabId &TabId)
 
SLATE_API void Construct (const FArguments &InArgs, const TSharedRef< FTabManager::FStack > &PersistentNode)
 
SLATE_API void OpenTab (const TSharedRef< SDockTab > &InTab, int32 InsertAtLocation=INDEX_NONE, bool bKeepInactive=false)
 
SLATE_API void AddTabWidget (const TSharedRef< SDockTab > &InTab, int32 AtLocation=INDEX_NONE, bool bKeepInactive=false)
 
SLATE_API void AddSidebarTab (const TSharedRef< SDockTab > &InTab)
 
SLATE_API float GetTabSidebarSizeCoefficient (const TSharedRef< SDockTab > &InTab)
 
SLATE_API void SetTabSidebarSizeCoefficient (const TSharedRef< SDockTab > &InTab, float InSizeCoefficient)
 
SLATE_API bool IsTabPinnedInSidebar (const TSharedRef< SDockTab > &InTab)
 
SLATE_API void SetTabPinnedInSidebar (const TSharedRef< SDockTab > &InTab, bool bPinnedInSidebar)
 
SLATE_API bool IsTabLocked (const TSharedRef< const SDockTab > &InTab) const
 
SLATE_API void SetTabLocked (const TSharedRef< const SDockTab > &InTab, TOptional< bool > bInLocked)
 
SLATE_API bool CanMoveTabToSideBar (TSharedRef< SDockTab > Tab) const
 
SLATE_API void MoveTabToSidebar (TSharedRef< SDockTab > Tab)
 
SLATE_API void RestoreTabFromSidebar (TSharedRef< SDockTab > Tab)
 
SLATE_API const TSlotlessChildren< SDockTab > & GetTabs () const
 
SLATE_API bool HasTab (const struct FTabMatcher &TabMatcher) const
 
SLATE_API FGeometry GetTabStackGeometry () const
 
SLATE_API void RemoveClosedTabsWithName (FName InName)
 
SLATE_API bool IsShowingLiveTabs () const
 
SLATE_API void BringToFront (const TSharedRef< SDockTab > &TabToBringToFront)
 
SLATE_API void SetNodeContent (const TSharedRef< SWidget > &InContent, const FDockingStackOptionalContent &OptionalContent)
 
virtual SLATE_API FReply OnUserAttemptingDock (SDockingNode::RelativeDirection Direction, const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API TArray< TSharedRef< SDockTab > > GetAllChildTabs () const override
 
virtual SLATE_API int32 GetNumTabs () const override
 
virtual SLATE_API SSplitter::ESizeRule GetSizeRule () const override
 
SLATE_API bool CanHideTabWell () const
 
SLATE_API void SetTabWellHidden (bool bShouldHideTabWell)
 
SLATE_API bool IsTabWellHidden () const
 
virtual SLATE_API TSharedPtr< FTabManager::FLayoutNodeGatherPersistentLayout () const override
 
SLATE_API void ClearReservedSpace ()
 
SLATE_API void ReserveSpaceForWindowChrome (EChromeElement Element, bool bIncludePaddingForMenuBar, bool bOnlyMinorTabs)
 
virtual SLATE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API void OnDragLeave (const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override
 
virtual SLATE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent) override
 
virtual SLATE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override
 
virtual bool SupportsKeyboardFocus () const override
 
- Public Member Functions inherited from SDockingNode
virtual SLATE_API TSharedPtr< SDockingAreaGetDockArea ()
 
virtual SLATE_API TSharedPtr< const SDockingAreaGetDockArea () const
 
SLATE_API float GetSizeCoefficient () const
 
SLATE_API void SetSizeCoefficient (float InSizeCoefficient)
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual SLATECORE_API FChildrenGetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
virtual SLATECORE_API bool HasKeyboardFocus () const
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Types

enum class  ETabsToClose : uint8 { CloseDocumentTabs , CloseDocumentAndMajorTabs , CloseAllTabs }
 
enum class  ECloseTabsDirection : uint8 { Left , Right }
 

Protected Member Functions

virtual EWindowZone::Type GetWindowZoneOverride () const override
 
SLATE_API void CloseForegroundTab ()
 
SLATE_API void CloseTabsInDirectionFromForegroundTab (ETabsToClose TabsToClose, ECloseTabsDirection Direction)
 
SLATE_API void CloseAllButForegroundTab (ETabsToClose TabsToClose)
 
SLATE_API FReply TabWellRightClicked (const FGeometry &TabWellGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATE_API SDockingNode::ECleanupRetVal CleanUpNodes () override
 
SLATE_API int32 OpenPersistentTab (const FTabId &TabId, int32 OpenLocationAmongActiveTabs=INDEX_NONE)
 
SLATE_API int32 ClosePersistentTab (const FTabId &TabId)
 
SLATE_API void RemovePersistentTab (const FTabId &TabId)
 
virtual SLATE_API void SetParentNode (TSharedRef< class SDockingSplitter > InParent) override
 
bool IsContentEnabled () const
 
- Protected Member Functions inherited from SDockingNode
SLATE_API SDockingNode ()
 
virtual SLATE_API void OnLiveTabAdded ()
 
- Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D ComputeDesiredSize (float) const override
 
TSlateAttributeRef< FVector2DGetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColorGetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColorGetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from SDockingNode
TWeakPtr< SDockingSplitterParentNodePtr
 
float SizeCoefficient = 1.0f
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Detailed Description

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.

Member Enumeration Documentation

◆ EChromeElement

Elements for which we might want to reserve space.

Enumerator
Icon 
Controls 

◆ ECloseTabsDirection

Enumerator
Left 
Right 

◆ ETabsToClose

enum class SDockingTabStack::ETabsToClose : uint8
strongprotected
Enumerator
CloseDocumentTabs 
CloseDocumentAndMajorTabs 
CloseAllTabs 

Member Function Documentation

◆ AddSidebarTab()

void SDockingTabStack::AddSidebarTab ( const TSharedRef< SDockTab > &  InTab)

◆ AddTabWidget()

void SDockingTabStack::AddTabWidget ( const TSharedRef< SDockTab > &  InTab,
int32  AtLocation = INDEX_NONE,
bool  bKeepInactive = false 
)

◆ BringToFront()

void SDockingTabStack::BringToFront ( const TSharedRef< SDockTab > &  TabToBringToFront)

◆ CanHideTabWell()

bool SDockingTabStack::CanHideTabWell ( ) const

Returns a bool indicating whether or not a tab is in a state where it can be hidden. A tab typically shouldn't be hidden in certain conditions like if there is more than one tab in the well, or if it's in a floating window.

Returns
returns true if the tab can be hidden, else it returns false

◆ CanMoveTabToSideBar()

bool SDockingTabStack::CanMoveTabToSideBar ( TSharedRef< SDockTab Tab) const
Returns
true if the specified tab can be moved to a sidebar

◆ CleanUpNodes()

SDockingNode::ECleanupRetVal SDockingTabStack::CleanUpNodes ( )
overrideprotectedvirtual

Reimplemented from SDockingNode.

◆ ClearReservedSpace()

void SDockingTabStack::ClearReservedSpace ( )

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

◆ CloseAllButForegroundTab()

void SDockingTabStack::CloseAllButForegroundTab ( ETabsToClose  TabsToClose)
protected

Close all the background tabs.

Parameters
TabsToCloseClose just document tabs or both document and tool tabs.

◆ CloseForegroundTab()

void SDockingTabStack::CloseForegroundTab ( )
protected

◆ ClosePersistentTab()

int32 SDockingTabStack::ClosePersistentTab ( const FTabId TabId)
protected

◆ CloseTabsInDirectionFromForegroundTab()

void SDockingTabStack::CloseTabsInDirectionFromForegroundTab ( ETabsToClose  TabsToClose,
ECloseTabsDirection  Direction 
)
protected

◆ Construct()

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

◆ GatherPersistentLayout()

TSharedPtr< FTabManager::FLayoutNode > SDockingTabStack::GatherPersistentLayout ( ) const
overridevirtual
Returns
true when this node is showing a live DockableTab; false when this nodes content is only kept around for history's sake Recursively build up an tree of FLayoutNodes that represent the persistent layout state of this DockingNode and all its descendants. The result can be easily serialized to disk or used as history for restoring tabs to their previous locations.
a pointer to persistent layout node; invalid pointer if this dock node had no tab layouts worth saving.

Implements SDockingNode.

◆ GetAllChildTabs()

TArray< TSharedRef< SDockTab > > SDockingTabStack::GetAllChildTabs ( ) const
overridevirtual

Recursively searches through all children looking for child tabs

Reimplemented from SDockingNode.

◆ GetNodeType()

virtual Type SDockingTabStack::GetNodeType ( ) const
inlineoverridevirtual
Returns
Is this dock node a tab stack, splitter or something else?

Implements SDockingNode.

◆ GetNumTabs()

int32 SDockingTabStack::GetNumTabs ( ) const
overridevirtual

Gets the number of tabs in all children recursively

Reimplemented from SDockingNode.

◆ GetSizeRule()

SSplitter::ESizeRule SDockingTabStack::GetSizeRule ( ) const
overridevirtual

Should this node auto-size or be a percentage of its parent size; this setting is usually determined by users

Reimplemented from SDockingNode.

◆ GetTabs()

const TSlotlessChildren< SDockTab > & SDockingTabStack::GetTabs ( ) const
Returns
All child tabs in this node

◆ GetTabSidebarSizeCoefficient()

float SDockingTabStack::GetTabSidebarSizeCoefficient ( const TSharedRef< SDockTab > &  InTab)

◆ GetTabStackGeometry()

FGeometry SDockingTabStack::GetTabStackGeometry ( ) const
Returns
the last known geometry of this TabStack

◆ GetWindowZoneOverride()

virtual EWindowZone::Type SDockingTabStack::GetWindowZoneOverride ( ) const
inlineoverrideprotectedvirtual

Called when the mouse is moved over the widget's window, to determine if we should report whether OS-specific features should be active at this location (such as a title bar grip, system menu, etc.) Usually you should not need to override this function.

Returns
The window "zone" the cursor is over, or EWindowZone::Unspecified if no special behavior is needed

Reimplemented from SWidget.

◆ HasTab()

bool SDockingTabStack::HasTab ( const struct FTabMatcher TabMatcher) const

◆ IsContentEnabled()

bool SDockingTabStack::IsContentEnabled ( ) const
protected
Returns
false if the content is disabled (non-interactable)

◆ IsShowingLiveTabs()

bool SDockingTabStack::IsShowingLiveTabs ( ) const

◆ IsTabLocked()

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

◆ IsTabPinnedInSidebar()

bool SDockingTabStack::IsTabPinnedInSidebar ( const TSharedRef< SDockTab > &  InTab)

◆ IsTabWellHidden()

bool SDockingTabStack::IsTabWellHidden ( ) const

◆ MoveTabToSidebar()

void SDockingTabStack::MoveTabToSidebar ( TSharedRef< SDockTab Tab)

Moves a specific tab from this stack into a sidebar

◆ OnDragLeave()

void SDockingTabStack::OnDragLeave ( const FDragDropEvent DragDropEvent)
overridevirtual

Called during drag and drop when the drag leaves a widget.

Parameters
DragDropEventThe drag and drop event.

Reimplemented from SWidget.

◆ OnDragOver()

FReply SDockingTabStack::OnDragOver ( const FGeometry MyGeometry,
const FDragDropEvent DragDropEvent 
)
overridevirtual

SWidget interface

Reimplemented from SWidget.

◆ OnDrop()

FReply SDockingTabStack::OnDrop ( const FGeometry MyGeometry,
const FDragDropEvent DragDropEvent 
)
overridevirtual

Called when the user is dropping something onto a widget; terminates drag and drop.

Parameters
MyGeometryThe geometry of the widget receiving the event.
DragDropEventThe drag and drop event.
Returns
A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnFocusChanging()

void SDockingTabStack::OnFocusChanging ( const FWeakWidgetPath PreviousFocusPath,
const FWidgetPath NewWidgetPath,
const FFocusEvent InFocusEvent 
)
overridevirtual

Called whenever a focus path is changing on all the widgets within the old and new focus paths

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SDockingTabStack::OnKeyDown ( const FGeometry MyGeometry,
const FKeyEvent InKeyEvent 
)
overridevirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters
MyGeometryThe Geometry of the widget receiving the event
InKeyEventKey event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnLastTabRemoved()

void SDockingTabStack::OnLastTabRemoved ( )

◆ OnMouseButtonDown()

FReply SDockingTabStack::OnMouseButtonDown ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

Parameters
MyGeometryThe Geometry of the widget receiving the event
MouseEventInformation about the input event
Returns
Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnTabClosed()

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

◆ OnTabRemoved()

void SDockingTabStack::OnTabRemoved ( const FTabId TabId)

◆ OnUserAttemptingDock()

FReply SDockingTabStack::OnUserAttemptingDock ( SDockingNode::RelativeDirection  Direction,
const FDragDropEvent DragDropEvent 
)
overridevirtual

Attempt to dock the TabWidget from the DragDropEvent next to this node.

Parameters
DirectionWhere relative to this direction to dock the node: e.g. to the right
DragDropEventDragAndDrop event that potentially carries
Returns
An FReply::Handled() if we successfully docked the content; FReply::Unhandled() otherwise.

Reimplemented from SDockingNode.

◆ OpenPersistentTab()

int32 SDockingTabStack::OpenPersistentTab ( const FTabId TabId,
int32  OpenLocationAmongActiveTabs = INDEX_NONE 
)
protected

◆ OpenTab()

void SDockingTabStack::OpenTab ( const TSharedRef< SDockTab > &  InTab,
int32  InsertAtLocation = INDEX_NONE,
bool  bKeepInactive = false 
)

◆ RemoveClosedTabsWithName()

void SDockingTabStack::RemoveClosedTabsWithName ( FName  InName)

◆ RemovePersistentTab()

void SDockingTabStack::RemovePersistentTab ( const FTabId TabId)
protected

◆ ReserveSpaceForWindowChrome()

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

Add some extra padding so that the corresponding window chrome element does not overlap our tabs.

◆ RestoreTabFromSidebar()

void SDockingTabStack::RestoreTabFromSidebar ( TSharedRef< SDockTab Tab)

Restores a specific tab from this stack to its original position

◆ SetNodeContent()

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

Set the content that the DockNode is presenting.

◆ SetParentNode()

void SDockingTabStack::SetParentNode ( TSharedRef< class SDockingSplitter InParent)
overrideprotectedvirtual

Overridden from SDockingNode

Reimplemented from SDockingNode.

◆ SetTabLocked()

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

◆ SetTabPinnedInSidebar()

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

◆ SetTabSidebarSizeCoefficient()

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

◆ SetTabWellHidden()

void SDockingTabStack::SetTabWellHidden ( bool  bShouldHideTabWell)

Sets the tab well to hidden/not hidden.

Parameters
bShouldHideTabWellthe bool that defines whether or not the tab well should be hidden

◆ SLATE_BEGIN_ARGS()

SDockingTabStack::SLATE_BEGIN_ARGS ( SDockingTabStack  )
inline

◆ SupportsKeyboardFocus()

virtual bool SDockingTabStack::SupportsKeyboardFocus ( ) const
inlineoverridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns
True if this widget can take keyboard focus

Reimplemented from SWidget.

◆ TabWellRightClicked()

FReply SDockingTabStack::TabWellRightClicked ( const FGeometry TabWellGeometry,
const FPointerEvent MouseEvent 
)
protected

The documentation for this class was generated from the following files: