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

#include <SDockTab.h>

+ Inheritance diagram for SDockTab:

Public Member Functions

 DECLARE_DELEGATE_OneParam (FOnTabClosedCallback, TSharedRef< SDockTab >)
 
 DECLARE_DELEGATE_TwoParams (FOnTabActivatedCallback, TSharedRef< SDockTab >, ETabActivationCause)
 
 DECLARE_DELEGATE_OneParam (FOnTabRenamed, TSharedRef< SDockTab >)
 
 DECLARE_DELEGATE (FOnPersistVisualState)
 
 DECLARE_DELEGATE_RetVal (bool, FCanCloseTab)
 
 DECLARE_DELEGATE_OneParam (FExtendContextMenu, FMenuBuilder &)
 
 SLATE_BEGIN_ARGS (SDockTab)
 
FArguments & Icon (const FSlateBrush *InIcon)
 
SLATE_API void Construct (const FArguments &InArgs)
 
virtual SLATE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API FReply OnMouseButtonDoubleClick (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
 
virtual SLATE_API void OnDragEnter (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 FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override
 
virtual SLATE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override
 
virtual SLATE_API void SetContent (TSharedRef< SWidget > InContent) override
 
SLATE_API void SetLeftContent (TSharedRef< SWidget > InContent)
 
SLATE_API void SetRightContent (TSharedRef< SWidget > InContent)
 
SLATE_API void SetTitleBarRightContent (TSharedRef< SWidget > InContent)
 
SLATE_API bool IsActive () const
 
SLATE_API bool IsForeground () const
 
virtual SLATE_API FSlateColor GetForegroundColor () const
 
SLATE_API void ExtendContextMenu (FMenuBuilder &MenuBuilder)
 
SLATE_API ETabRole GetTabRole () const
 
SLATE_API ETabRole GetVisualTabRole () const
 
SLATE_API const FSlateBrushGetContentAreaBrush () const
 
SLATE_API const FSlateBrushGetTabWellBrush () const
 
SLATE_API TSharedRef< SWidgetGetContent ()
 
SLATE_API TSharedRef< SWidgetGetLeftContent ()
 
SLATE_API TSharedRef< SWidgetGetRightContent ()
 
SLATE_API TSharedRef< SWidgetGetTitleBarRightContent ()
 
SLATE_API FMargin GetContentPadding () const
 
SLATE_API const FTabId GetLayoutIdentifier () const
 
SLATE_API void SetParent (TSharedPtr< SDockingTabWell > Parent=TSharedPtr< SDockingTabWell >())
 
void SetParentDockingArea (TSharedPtr< SDockingArea > Parent)
 
SLATE_API TSharedPtr< SDockingTabWellGetParent () const
 
SLATE_API TSharedPtr< SDockingTabStackGetParentDockTabStack () const
 
SLATE_API TSharedPtr< class SDockingAreaGetDockArea () const
 
SLATE_API TSharedPtr< SWindowGetParentWindow () const
 
SLATE_API float GetOverlapWidth () const
 
SLATE_API FText GetTabLabel () const
 
SLATE_API void SetLabel (const TAttribute< FText > &InTabLabel)
 
SLATE_API FText GetTabLabelSuffix () const
 
SLATE_API void SetTabLabelSuffix (const TAttribute< FText > &InTabLabelSuffix)
 
SLATE_API void SetTabLabelOverflowPolicy (TOptional< ETextOverflowPolicy > InOverflowPolicy) const
 
SLATE_API void SetTabToolTipWidget (TSharedPtr< SToolTip > InTabToolTipWidget)
 
SLATE_API const FSlateBrushGetTabIcon () const
 
SLATE_API void SetTabIcon (const TAttribute< const FSlateBrush * > InTabIcon)
 
SLATE_API bool ShouldAutosize () const
 
SLATE_API void SetShouldAutosize (const bool bNewShouldAutosize)
 
SLATE_API bool CanCloseTab () const
 
SLATE_API bool CanCloseTab (bool bIgnoreLockedTabs) const
 
SLATE_API bool RequestCloseTab ()
 
SLATE_API bool IsTabLocked () const
 
SLATE_API void PersistVisualState ()
 
SLATE_API void RemoveTabFromParent ()
 
SLATE_API SDockTab ()
 
SLATE_API void ActivateInParent (ETabActivationCause InActivationCause)
 
SLATE_API void SetTabManager (const TSharedPtr< FTabManager > &InTabManager)
 
SLATE_API void SetOnPersistVisualState (const FOnPersistVisualState &Handler)
 
SLATE_API void SetCanCloseTab (const FCanCloseTab &InOnTabClosing)
 
SLATE_API void SetOnTabClosed (const FOnTabClosedCallback &InDelegate)
 
SLATE_API void SetOnTabActivated (const FOnTabActivatedCallback &InDelegate)
 
SLATE_API void SetOnTabRelocated (const FSimpleDelegate InDelegate)
 
SLATE_API void SetOnTabDraggedOverDockArea (const FSimpleDelegate InDelegate)
 
SLATE_API void SetOnTabRenamed (const FOnTabRenamed &InDelegate)
 
SLATE_API void SetOnTabDrawerOpened (const FSimpleDelegate InDelegate)
 
SLATE_API void SetOnTabDrawerClosed (const FSimpleDelegate InDelegate)
 
SLATE_API void SetOnExtendContextMenu (const FExtendContextMenu &Handler)
 
 UE_DEPRECATED (5.0, "The tab manager is not guaranteed to exist, which will cause GetTabManager() to crash. Use GetTabManagerPtr() instead.") SLATE_API TSharedRef< FTabManager > GetTabManager() const
 
SLATE_API TSharedPtr< FTabManagerGetTabManagerPtr () const
 
SLATE_API void DrawAttention ()
 
SLATE_API void ProvideDefaultLabel (const FText &InDefaultLabel)
 
SLATE_API void PlaySpawnAnim ()
 
SLATE_API void FlashTab ()
 
SLATE_API void SetDraggedOverDockArea (const TSharedPtr< SDockingArea > &Area)
 
SLATE_API bool HasSiblingTab (const FTabId &SiblingTabId, const bool TreatIndexNoneAsWildcard=true) const
 
SLATE_API void UpdateActivationTime ()
 
double GetLastActivationTime ()
 
SLATE_API void SetParentDockTabStackTabWellHidden (bool bIsTabWellHidden)
 
SLATE_API bool IsTabNameHidden () const
 
- Public Member Functions inherited from SBorder
 SLATE_BEGIN_ARGS (SBorder)
 
FArguments & Padding (float Uniform)
 
FArguments & Padding (float Horizontal, float Vertical)
 
FArguments & Padding (float Left, float Top, float Right, float Bottom)
 
SLATE_API SBorder ()
 
virtual SLATE_API ~SBorder ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
SLATE_API const TSharedRef< SWidget > & GetContent () const
 
SLATE_API void ClearContent ()
 
SLATE_API void SetBorderBackgroundColor (TAttribute< FSlateColor > InColorAndOpacity)
 
FSlateColor GetBorderBackgroundColor () const
 
SLATE_API void SetDesiredSizeScale (TAttribute< FVector2D > InDesiredSizeScale)
 
SLATE_API void SetHAlign (EHorizontalAlignment HAlign)
 
SLATE_API void SetVAlign (EVerticalAlignment VAlign)
 
SLATE_API void SetPadding (TAttribute< FMargin > InPadding)
 
SLATE_API void SetShowEffectWhenDisabled (TAttribute< bool > InShowEffectWhenDisabled)
 
SLATE_API void SetBorderImage (TAttribute< const FSlateBrush * > InBorderImage)
 
const FSlateBrushGetBorderImage () const
 
virtual SLATE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
- 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 FChildrenGetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) 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 void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, 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 OnKeyDown (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 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 bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (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)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
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 SupportsKeyboardFocus () const
 
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 Member Functions

SLATE_API void ProvideDefaultIcon (const FSlateBrush *InDefaultIcon)
 
SLATE_API const FDockTabStyleGetCurrentStyle () const
 
SLATE_API const FSlateBrushGetImageBrush () const
 
SLATE_API FMargin GetTabPadding () const
 
SLATE_API const FSlateBrushGetColorOverlayImageBrush () const
 
SLATE_API EVisibility GetActiveTabIndicatorVisibility () const
 
SLATE_API FSlateColor GetTabColor () const
 
SLATE_API FSlateColor GetIconColor () const
 
SLATE_API const FSlateBrushGetFlashOverlayImageBrush () const
 
SLATE_API FSlateColor GetFlashColor () const
 
SLATE_API FReply OnCloseButtonClicked ()
 
SLATE_API FText GetCloseButtonToolTipText () const
 
SLATE_API void SetLayoutIdentifier (const FTabId &TabId)
 
SLATE_API EVisibility HandleIsCloseButtonVisible () const
 
SLATE_API TOptional< FVector2DGetTabIconSize () const
 
SLATE_API FMargin GetTabIconBorderPadding () const
 
SLATE_API UE::Slate::FDeprecateVector2DResult GetAnimatedScale () const
 
SLATE_API float GetFlashValue () const
 
- Protected Member Functions inherited from SBorder
virtual SLATE_API FVector2D ComputeDesiredSize (float) const override
 
bool GetShowDisabledEffect () const
 
FVector2D GetDesiredSizeScale () const
 
TSlateAttributeRef< const FSlateBrush * > GetBorderImageAttribute () const
 
TSlateAttributeRef< FSlateColorGetBorderBackgroundColorAttribute () const
 
TSlateAttributeRef< FVector2DGetDesiredSizeScaleAttribute () const
 
TSlateAttributeRef< boolGetShowDisabledEffectAttribute () const
 
- Protected Member Functions inherited from SCompoundWidget
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 ()
 

Protected Attributes

TWeakPtr< FTabManagerMyTabManager
 
TSharedRef< SWidgetContent
 
TSharedRef< SWidgetTabWellContentLeft
 
TSharedRef< SWidgetTabWellContentRight
 
TSharedRef< SWidgetTitleBarContentRight
 
FTabId LayoutIdentifier
 
ETabRole TabRole
 
bool bCanEverClose
 
TWeakPtr< SDockingTabWellParentPtr
 
TWeakPtr< SDockingAreaParentDockingAreaPtr
 
TAttribute< FTextTabLabel
 
TAttribute< FTextTabLabelSuffix
 
TAttribute< const FSlateBrush * > TabIcon
 
FOnTabClosedCallback OnTabClosed
 
FOnTabActivatedCallback OnTabActivated
 
FCanCloseTab OnCanCloseTab
 
FSimpleDelegate OnTabDrawerClosedEvent
 
FSimpleDelegate OnTabDrawerOpenedEvent
 
FSimpleDelegate OnTabRelocated
 
FSimpleDelegate OnTabDraggedOverDockArea
 
FExtendContextMenu OnExtendContextMenu
 
FOnPersistVisualState OnPersistVisualState
 
FOnTabRenamed OnTabRenamed
 
const FDockTabStyleMajorTabStyle
 
const FDockTabStyleGenericTabStyle
 
TAttribute< FMarginContentAreaPadding
 
bool bShouldAutosize
 
TAttribute< FLinearColorTabColorScale
 
TAttribute< FLinearColorIconColor
 
FCurveSequence SpawnAnimCurve
 
FCurveSequence FlashTabCurve
 
TSharedPtr< SDockingAreaDraggedOverDockingArea
 
TSharedPtr< STextBlockLabelWidget
 
TSharedPtr< STextBlockLabelSuffix
 
TSharedPtr< SImageIconWidget
 
double LastActivationTime
 
- 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
 

Friends

class FTabManager
 
class STabSidebar
 

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)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SDockTab()

SDockTab::SDockTab ( )

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

Member Function Documentation

◆ ActivateInParent()

void SDockTab::ActivateInParent ( ETabActivationCause  InActivationCause)

Make this tab active in its tabwell

Parameters
InActivationMethodHow this tab was activated.

◆ CanCloseTab() [1/2]

bool SDockTab::CanCloseTab ( ) const
Returns
true if the tab can be closed right now. Example: Callback could ask user via dialog.

◆ CanCloseTab() [2/2]

bool SDockTab::CanCloseTab ( bool  bIgnoreLockedTabs) const
Returns
true if the tab can be closed right now. Example: Callback could ask user via dialog.

◆ Construct()

void SDockTab::Construct ( const FArguments &  InArgs)

When the close button is pressed, checks whether the tab can be closed in that moment. Example: Show dialog and ask user whether they're sure to close. Whether this tab can ever be closed. Example: certain programs may want to show tabs for the lifetime of the program. Invoked when a tab is closed from a drawer. This does not mean the tab or its contents is destroyed, just hidden. Use OnTabClosed for that Construct the widget from the declaration.

◆ DECLARE_DELEGATE()

SDockTab::DECLARE_DELEGATE ( FOnPersistVisualState  )

Invoked w`en this tab should save some information about its content.

◆ DECLARE_DELEGATE_OneParam() [1/3]

SDockTab::DECLARE_DELEGATE_OneParam ( FExtendContextMenu  ,
FMenuBuilder  
)

Invoked to add entries to the tab context menu

◆ DECLARE_DELEGATE_OneParam() [2/3]

SDockTab::DECLARE_DELEGATE_OneParam ( FOnTabClosedCallback  ,
TSharedRef< SDockTab  
)

Invoked when a tab is closing

◆ DECLARE_DELEGATE_OneParam() [3/3]

SDockTab::DECLARE_DELEGATE_OneParam ( FOnTabRenamed  ,
TSharedRef< SDockTab  
)

Invoked when a tab is renamed

◆ DECLARE_DELEGATE_RetVal()

SDockTab::DECLARE_DELEGATE_RetVal ( bool  ,
FCanCloseTab   
)

Delegate called before a tab is closed. Returning false will prevent the tab from closing

◆ DECLARE_DELEGATE_TwoParams()

SDockTab::DECLARE_DELEGATE_TwoParams ( FOnTabActivatedCallback  ,
TSharedRef< SDockTab ,
ETabActivationCause   
)

Invoked when a tab is activated

◆ DrawAttention()

void SDockTab::DrawAttention ( )

Draws attention to the tab.

◆ ExtendContextMenu()

void SDockTab::ExtendContextMenu ( FMenuBuilder MenuBuilder)

Add any entries specific to this tab to the tab context menu

◆ FlashTab()

void SDockTab::FlashTab ( )

Flash the tab, used for drawing attention to it

◆ GetActiveTabIndicatorVisibility()

EVisibility SDockTab::GetActiveTabIndicatorVisibility ( ) const
protected
Returns
The visibility of the active tab indicator

◆ GetAnimatedScale()

UE::Slate::FDeprecateVector2DResult SDockTab::GetAnimatedScale ( ) const
protected
Returns
the scaling of the tab based on the opening/closing animation

◆ GetCloseButtonToolTipText()

FText SDockTab::GetCloseButtonToolTipText ( ) const
protected

The close button tooltip showing the appropriate close command shortcut

◆ GetColorOverlayImageBrush()

const FSlateBrush * SDockTab::GetColorOverlayImageBrush ( ) const
protected
Returns
the image brush for the tab's color overlay

◆ GetContent()

TSharedRef< SWidget > SDockTab::GetContent ( )
Returns
the content associated with this tab

◆ GetContentAreaBrush()

const FSlateBrush * SDockTab::GetContentAreaBrush ( ) const

What should the content area look like for this type of tab? Documents, Apps, and Tool Panels have different backgrounds.

◆ GetContentPadding()

FMargin SDockTab::GetContentPadding ( ) const

Padding around the content when it is presented by the SDockingTabStack

◆ GetCurrentStyle()

const FDockTabStyle & SDockTab::GetCurrentStyle ( ) const
protected
Returns
the style currently applied to the dock tab

◆ GetDockArea()

TSharedPtr< SDockingArea > SDockTab::GetDockArea ( ) const

Gets the dock area that this resides in

◆ GetFlashColor()

FSlateColor SDockTab::GetFlashColor ( ) const
protected
Returns
Returns a color to flash the background of this tab with

◆ GetFlashOverlayImageBrush()

const FSlateBrush * SDockTab::GetFlashOverlayImageBrush ( ) const
protected
Returns
the image brush for the tab's flasher overlay

◆ GetFlashValue()

float SDockTab::GetFlashValue ( ) const
protected

Get the desired color of tab. These change during flashing.

◆ GetForegroundColor()

FSlateColor SDockTab::GetForegroundColor ( ) const
virtual
Returns
the Foreground color that this widget sets; unset options if the widget does not set a foreground color

Reimplemented from SCompoundWidget.

◆ GetIconColor()

FSlateColor SDockTab::GetIconColor ( ) const
protected
Returns
Returns the color of this tab's icon

◆ GetImageBrush()

const FSlateBrush * SDockTab::GetImageBrush ( ) const
protected
Returns
the image brush that best represents this tab's in its current state

◆ GetLastActivationTime()

double SDockTab::GetLastActivationTime ( )
inline

Returns the time this tab was last activated

◆ GetLayoutIdentifier()

const FTabId SDockTab::GetLayoutIdentifier ( ) const

Gets this tab's layout identifier

◆ GetLeftContent()

TSharedRef< SWidget > SDockTab::GetLeftContent ( )

◆ GetOverlapWidth()

float SDockTab::GetOverlapWidth ( ) const

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

◆ GetParent()

TSharedPtr< SDockingTabWell > SDockTab::GetParent ( ) const

Gets the tab's tab well parent, or nothing, if it has none

◆ GetParentDockTabStack()

TSharedPtr< SDockingTabStack > SDockTab::GetParentDockTabStack ( ) const

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

◆ GetParentWindow()

TSharedPtr< SWindow > SDockTab::GetParentWindow ( ) const

Get the window in which this tab's tabmanager has placed it

◆ GetRightContent()

TSharedRef< SWidget > SDockTab::GetRightContent ( )

◆ GetTabColor()

FSlateColor SDockTab::GetTabColor ( ) const
protected
Returns
Returns a color to scale the background of this tab by

◆ GetTabIcon()

const FSlateBrush * SDockTab::GetTabIcon ( ) const

Gets the tab icon

◆ GetTabIconBorderPadding()

FMargin SDockTab::GetTabIconBorderPadding ( ) const
protected
Returns
the padding for the tab icon border

◆ GetTabIconSize()

TOptional< FVector2D > SDockTab::GetTabIconSize ( ) const
protected
Returns
the size the tab icon should be

◆ GetTabLabel()

FText SDockTab::GetTabLabel ( ) const

The label on the tab

◆ GetTabLabelSuffix()

FText SDockTab::GetTabLabelSuffix ( ) const

Get Label Suffix

◆ GetTabManagerPtr()

TSharedPtr< FTabManager > SDockTab::GetTabManagerPtr ( ) const

Get the tab manager currently managing this tab. Note that a user move the tab between Tab Managers, so this return value may change.

◆ GetTabPadding()

FMargin SDockTab::GetTabPadding ( ) const
protected
Returns
the padding for the tab widget

◆ GetTabRole()

ETabRole SDockTab::GetTabRole ( ) const

Is this an MajorTab? A tool panel tab?

◆ GetTabWellBrush()

const FSlateBrush * SDockTab::GetTabWellBrush ( ) const

Depending on the tabs we put into the tab well, we want a different background brush.

◆ GetTitleBarRightContent()

TSharedRef< SWidget > SDockTab::GetTitleBarRightContent ( )

◆ GetVisualTabRole()

ETabRole SDockTab::GetVisualTabRole ( ) const

Similar to GetTabRole() but returns the correct role for UI style and user input purposes

◆ HandleIsCloseButtonVisible()

EVisibility SDockTab::HandleIsCloseButtonVisible ( ) const
protected
Returns
if the close button should be visible.

◆ HasSiblingTab()

bool SDockTab::HasSiblingTab ( const FTabId SiblingTabId,
const bool  TreatIndexNoneAsWildcard = true 
) const

Check to see whether this tab has a sibling tab with the given tab ID

Parameters
SiblingTabIdThe ID of the tab we want to find
TreatIndexNoneAsWildcardNote that this variable only takes effect if SiblingTabId has an InstanceId of INDEX_NONE. If true, we will consider this a "wildcard" search (matching any tab with the correct TabType, regardless of its InstanceId). If false, we will explicitly look for a tab with an InstanceId of INDEX_NONE

◆ Icon()

FArguments & SDockTab::Icon ( const FSlateBrush InIcon)
inline

◆ IsActive()

bool SDockTab::IsActive ( ) const
Returns
True if this tab is currently focused

◆ IsForeground()

bool SDockTab::IsForeground ( ) const
Returns
True if this tab appears active; False otherwise

◆ IsTabLocked()

bool SDockTab::IsTabLocked ( ) const
Returns
True if this tab is currently locked

◆ IsTabNameHidden()

bool SDockTab::IsTabNameHidden ( ) const

Get if the TabName should be hidden and not take up space for this Tab

◆ OnCloseButtonClicked()

FReply SDockTab::OnCloseButtonClicked ( )
protected

Called when the close button is clicked on the tab.

◆ OnDragDetected()

FReply SDockTab::OnDragDetected ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

Called when Slate detects that a widget started to be dragged. Usage: A widget can ask Slate to detect a drag. OnMouseDown() reply with FReply::Handled().DetectDrag( SharedThis(this) ). Slate will either send an OnDragDetected() event or do nothing. If the user releases a mouse button or leaves the widget before a drag is triggered (maybe user started at the very edge) then no event will be sent.

Parameters
InMyGeometryWidget geometry
InMouseEventMouseMove that triggered the drag

Reimplemented from SWidget.

◆ OnDragEnter()

void SDockTab::OnDragEnter ( const FGeometry MyGeometry,
const FDragDropEvent DragDropEvent 
)
overridevirtual

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

Enter/Leave events in slate are meant as lightweight notifications. So we do not want to capture mouse or set focus in response to these. However, OnDragEnter must also support external APIs (e.g. OLE Drag/Drop) Those require that we let them know whether we can handle the content being dragged OnDragEnter.

The concession is to return a can_handled/cannot_handle boolean rather than a full FReply.

Parameters
MyGeometryThe geometry of the widget receiving the event.
DragDropEventThe drag and drop event.
Returns
A reply that indicated whether the contents of the DragDropEvent can potentially be processed by this widget.

Reimplemented from SWidget.

◆ OnDragLeave()

void SDockTab::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.

◆ OnDrop()

FReply SDockTab::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.

◆ OnMouseButtonDoubleClick()

FReply SDockTab::OnMouseButtonDoubleClick ( const FGeometry InMyGeometry,
const FPointerEvent InMouseEvent 
)
overridevirtual

Called when a mouse button is double clicked. Override this in derived classes.

Parameters
InMyGeometryWidget geometry
InMouseEventMouse button event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnMouseButtonDown()

FReply SDockTab::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.

◆ OnMouseButtonUp()

FReply SDockTab::OnMouseButtonUp ( const FGeometry MyGeometry,
const FPointerEvent MouseEvent 
)
overridevirtual

The system calls this method to notify the widget that a mouse button was release 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.

◆ OnTouchEnded()

FReply SDockTab::OnTouchEnded ( const FGeometry MyGeometry,
const FPointerEvent InTouchEvent 
)
overridevirtual

Called when a touchpad touch is ended (finger lifted)

Parameters
InTouchEventThe touch event generated

Reimplemented from SWidget.

◆ OnTouchStarted()

FReply SDockTab::OnTouchStarted ( const FGeometry MyGeometry,
const FPointerEvent InTouchEvent 
)
overridevirtual

Called when a touchpad touch is started (finger down)

Parameters
InTouchEventThe touch event generated

Reimplemented from SWidget.

◆ PersistVisualState()

void SDockTab::PersistVisualState ( )

A chance for the tab's content to save any internal layout info

◆ PlaySpawnAnim()

void SDockTab::PlaySpawnAnim ( )

Play an animation showing this tab as opening

◆ ProvideDefaultIcon()

void SDockTab::ProvideDefaultIcon ( const FSlateBrush InDefaultIcon)
protected

Provide a default tab icon.

◆ ProvideDefaultLabel()

void SDockTab::ProvideDefaultLabel ( const FText InDefaultLabel)

Provide a default tab label in case the spawner did not set one.

◆ RemoveTabFromParent()

void SDockTab::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. Use RequestCloseTab to do this safely.

◆ RequestCloseTab()

bool SDockTab::RequestCloseTab ( )

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

◆ SetCanCloseTab()

void SDockTab::SetCanCloseTab ( const FCanCloseTab InOnTabClosing)

Set the handler to be invoked when the user requests that this tab be closed.

◆ SetContent()

void SDockTab::SetContent ( TSharedRef< SWidget InContent)
overridevirtual

Sets the content for this border

Parameters
InContentThe widget to use as content for the border

Reimplemented from SBorder.

◆ SetDraggedOverDockArea()

void SDockTab::SetDraggedOverDockArea ( const TSharedPtr< SDockingArea > &  Area)

Used by the drag/drop operation to signal to this tab what it is dragging over.

◆ SetLabel()

void SDockTab::SetLabel ( const TAttribute< FText > &  InTabLabel)

The label that appears on the tab.

◆ SetLayoutIdentifier()

void SDockTab::SetLayoutIdentifier ( const FTabId TabId)
protected

Specify the TabId that was used to spawn this tab.

◆ SetLeftContent()

void SDockTab::SetLeftContent ( TSharedRef< SWidget InContent)

Content that appears in the TabWell to the left of the tabs

◆ SetOnExtendContextMenu()

void SDockTab::SetOnExtendContextMenu ( const FExtendContextMenu Handler)

Set the handler for extending the tab context menu

◆ SetOnPersistVisualState()

void SDockTab::SetOnPersistVisualState ( const FOnPersistVisualState Handler)

Set the custom code to execute for saving visual state in this tab. e.g. ContentBrowser saves the visible filters.OnExtendContextMenu

◆ SetOnTabActivated()

void SDockTab::SetOnTabActivated ( const FOnTabActivatedCallback InDelegate)

Set the handler that will be invoked when the tab is activated

◆ SetOnTabClosed()

void SDockTab::SetOnTabClosed ( const FOnTabClosedCallback InDelegate)

Set the handler that will be invoked when the tab is closed

◆ SetOnTabDraggedOverDockArea()

void SDockTab::SetOnTabDraggedOverDockArea ( const FSimpleDelegate  InDelegate)

Set the handler that will be invoked when the tab is dragged over dock area

◆ SetOnTabDrawerClosed()

void SDockTab::SetOnTabDrawerClosed ( const FSimpleDelegate  InDelegate)

Set the handler that will be invoked when the tab is closed from a drawer

◆ SetOnTabDrawerOpened()

void SDockTab::SetOnTabDrawerOpened ( const FSimpleDelegate  InDelegate)

Set the handler that will be invoked when the tab is opened from a drawer

◆ SetOnTabRelocated()

void SDockTab::SetOnTabRelocated ( const FSimpleDelegate  InDelegate)

Set the handler that will be invoked when the tab is relocated to a new tab well

◆ SetOnTabRenamed()

void SDockTab::SetOnTabRenamed ( const FOnTabRenamed InDelegate)

Set the handler that will be invoked when the tab is renamed

◆ SetParent()

void SDockTab::SetParent ( TSharedPtr< SDockingTabWell Parent = TSharedPtr<SDockingTabWell>())

Sets the tab's tab well parent, or resets it if nothing is passed in

◆ SetParentDockingArea()

void SDockTab::SetParentDockingArea ( TSharedPtr< SDockingArea Parent)

Set the tab parent when the tab live outside of a tab well (PanelDrawer for example)

◆ SetParentDockTabStackTabWellHidden()

void SDockTab::SetParentDockTabStackTabWellHidden ( bool  bIsTabWellHidden)

◆ SetRightContent()

void SDockTab::SetRightContent ( TSharedRef< SWidget InContent)

Content that appears in the TabWell to the right of the tabs

◆ SetShouldAutosize()

void SDockTab::SetShouldAutosize ( const bool  bNewShouldAutosize)

Set whether this tab should be sized based on its content.

◆ SetTabIcon()

void SDockTab::SetTabIcon ( const TAttribute< const FSlateBrush * >  InTabIcon)

Sets the tab icon

◆ SetTabLabelOverflowPolicy()

void SDockTab::SetTabLabelOverflowPolicy ( TOptional< ETextOverflowPolicy InOverflowPolicy) const

Set the Label overflow policy

◆ SetTabLabelSuffix()

void SDockTab::SetTabLabelSuffix ( const TAttribute< FText > &  InTabLabelSuffix)

Set Label Suffix. A second text field at the end of the Label that takes precedence and isn't lost when space is restricted

◆ SetTabManager()

void SDockTab::SetTabManager ( const TSharedPtr< FTabManager > &  InTabManager)

Set the tab manager that is controlling this tab

◆ SetTabToolTipWidget()

void SDockTab::SetTabToolTipWidget ( TSharedPtr< SToolTip InTabToolTipWidget)

The tooltip text that appears on the tab.

◆ SetTitleBarRightContent()

void SDockTab::SetTitleBarRightContent ( TSharedRef< SWidget InContent)

Content that appears on the right side of the title bar in the window this stack is in

◆ ShouldAutosize()

bool SDockTab::ShouldAutosize ( ) const

Should this tab be sized based on its content.

◆ SLATE_BEGIN_ARGS()

SDockTab::SLATE_BEGIN_ARGS ( SDockTab  )
inline

◆ UE_DEPRECATED()

SDockTab::UE_DEPRECATED ( 5.  0,
"The tab manager is not guaranteed to  exist,
which will cause GetTabManager() to crash. Use GetTabManagerPtr() instead."   
) const

Get the tab manager currently managing this tab. Note that a user move the tab between Tab Managers, so this return value may change.

◆ UpdateActivationTime()

void SDockTab::UpdateActivationTime ( )

Updates the 'last activated' time to the current time

Friends And Related Symbol Documentation

◆ FTabManager

friend class FTabManager
friend

◆ STabSidebar

friend class STabSidebar
friend

Member Data Documentation

◆ bCanEverClose

bool SDockTab::bCanEverClose
protected

Determines whether the close button for the tab is shown.

◆ bShouldAutosize

bool SDockTab::bShouldAutosize
protected

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

◆ Content

TSharedRef<SWidget> SDockTab::Content
protected

The stuff to show when this tab is selected

◆ ContentAreaPadding

TAttribute<FMargin> SDockTab::ContentAreaPadding
protected

◆ DraggedOverDockingArea

TSharedPtr<SDockingArea> SDockTab::DraggedOverDockingArea
protected

The dock area this tab is currently being dragged over. Used in nomad tabs to change style

◆ FlashTabCurve

FCurveSequence SDockTab::FlashTabCurve
protected

Animation that causes the tab to flash

◆ GenericTabStyle

const FDockTabStyle* SDockTab::GenericTabStyle
protected

◆ IconColor

TAttribute<FLinearColor> SDockTab::IconColor
protected

Color of this tab's icon

◆ IconWidget

TSharedPtr<SImage> SDockTab::IconWidget
protected

Widget used to show the icon on the tab

◆ LabelSuffix

TSharedPtr<STextBlock> SDockTab::LabelSuffix
protected

◆ LabelWidget

TSharedPtr<STextBlock> SDockTab::LabelWidget
protected

Widget used to show the label on the tab

◆ LastActivationTime

double SDockTab::LastActivationTime
protected

Time this tab was last activated

◆ LayoutIdentifier

FTabId SDockTab::LayoutIdentifier
protected

The tab's layout identifier

◆ MajorTabStyle

const FDockTabStyle* SDockTab::MajorTabStyle
protected

The styles used to draw the tab in its various states

◆ MyTabManager

TWeakPtr<FTabManager> SDockTab::MyTabManager
protected

The tab manager that created this tab.

◆ OnCanCloseTab

FCanCloseTab SDockTab::OnCanCloseTab
protected

Delegate to execute to determine if we can close this tab

◆ OnExtendContextMenu

FExtendContextMenu SDockTab::OnExtendContextMenu
protected

◆ OnPersistVisualState

FOnPersistVisualState SDockTab::OnPersistVisualState
protected

Invoked during the Save Visual State pass; gives this tab a chance to save misc info about visual state. e.g. Content Browser might save the current filters, current folder, whether some panel is collapsed, etc.

◆ OnTabActivated

FOnTabActivatedCallback SDockTab::OnTabActivated
protected

Callback to call when this tab is activated

◆ OnTabClosed

FOnTabClosedCallback SDockTab::OnTabClosed
protected

Callback to call when this tab is destroyed

◆ OnTabDraggedOverDockArea

FSimpleDelegate SDockTab::OnTabDraggedOverDockArea
protected

◆ OnTabDrawerClosedEvent

FSimpleDelegate SDockTab::OnTabDrawerClosedEvent
protected

◆ OnTabDrawerOpenedEvent

FSimpleDelegate SDockTab::OnTabDrawerOpenedEvent
protected

◆ OnTabRelocated

FSimpleDelegate SDockTab::OnTabRelocated
protected

◆ OnTabRenamed

FOnTabRenamed SDockTab::OnTabRenamed
protected

Invoked when the tab is renamed

◆ ParentDockingAreaPtr

TWeakPtr<SDockingArea> SDockTab::ParentDockingAreaPtr
protected

The tab's parent docking area (Might be null)

◆ ParentPtr

TWeakPtr<SDockingTabWell> SDockTab::ParentPtr
protected

The tab's parent tab well. Null if it is a floating tab or hosted by a DrawerPanel.

◆ SpawnAnimCurve

FCurveSequence SDockTab::SpawnAnimCurve
protected

Animation that shows the tab opening up

◆ TabColorScale

TAttribute<FLinearColor> SDockTab::TabColorScale
protected

Color of this tab

◆ TabIcon

TAttribute<const FSlateBrush*> SDockTab::TabIcon
protected

The icon on the tab

◆ TabLabel

TAttribute<FText> SDockTab::TabLabel
protected

The label on the tab

◆ TabLabelSuffix

TAttribute<FText> SDockTab::TabLabelSuffix
protected

A second text field at the end of the Label that takes precedence and isn't lost when space is restricted

◆ TabRole

ETabRole SDockTab::TabRole
protected

Is this an MajorTab? A tool panel tab?

◆ TabWellContentLeft

TSharedRef<SWidget> SDockTab::TabWellContentLeft
protected

◆ TabWellContentRight

TSharedRef<SWidget> SDockTab::TabWellContentRight
protected

◆ TitleBarContentRight

TSharedRef<SWidget> SDockTab::TitleBarContentRight
protected

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