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

#include <SDockingArea.h>

+ Inheritance diagram for SDockingArea:

Public Member Functions

 SLATE_BEGIN_ARGS (SDockingArea)
 
SLATE_API void Construct (const FArguments &InArgs, const TSharedRef< FTabManager > &InTabManager, const TSharedRef< FTabManager::FArea > &PersistentNode)
 
virtual Type GetNodeType () const override
 
virtual SLATE_API TSharedPtr< SDockingAreaGetDockArea () override
 
virtual SLATE_API TSharedPtr< const SDockingAreaGetDockArea () const override
 
SLATE_API TSharedPtr< SWindowGetParentWindow () const
 
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 OnUserAttemptingDock (SDockingNode::RelativeDirection Direction, const FDragDropEvent &DragDropEvent) override
 
SLATE_API void OnTabFoundNewHome (const TSharedRef< SDockTab > &RelocatedTab, const TSharedRef< SWindow > &NewOwnerWindow)
 
SLATE_API void ShowCross ()
 
SLATE_API void HideCross ()
 
SLATE_API void CleanUp (ELayoutModification RemovalMethod)
 
SLATE_API void SetParentWindow (const TSharedRef< SWindow > &NewParentWindow)
 
virtual SLATE_API TSharedPtr< FTabManager::FLayoutNodeGatherPersistentLayout () const override
 
SLATE_API TSharedRef< FTabManagerGetTabManager () const
 
SLATE_API ESidebarLocation AddTabToSidebar (TSharedRef< SDockTab > TabToAdd)
 
SLATE_API bool RestoreTabFromSidebar (TSharedRef< SDockTab > TabToRemove)
 
SLATE_API bool IsTabInSidebar (TSharedRef< SDockTab > Tab) const
 
SLATE_API bool RemoveTabFromSidebar (TSharedRef< SDockTab > Tab)
 
SLATE_API bool TryOpenSidebarDrawer (TSharedRef< SDockTab > TabToOpen) const
 
SLATE_API void AddSidebarTabsFromRestoredLayout (const FSidebarTabLists &SidebarTabs)
 
SLATE_API TArray< TSharedRef< SDockTab > > GetAllSidebarTabs () const
 
bool CanHaveSidebar () const
 
bool HostTabIntoPanelDrawer (const TSharedRef< SDockTab > &InTab)
 
void ClosePanelDrawer ()
 
TSharedPtr< SDockTabClosePanelDrawerForTransfer ()
 
bool IsPanelDrawerOpen () const
 
bool HasPanelDrawer () const
 
TSharedPtr< SDockTabGetPanelDrawerSystemHostedTab (const FTabId &TabId) const
 
TSharedPtr< SDockTabGetPanelDrawerHostedTab () const
 
void SetPanelDrawerArea (const TSharedPtr< UE::Slate::Private::SPanelDrawerArea > &InPanelDrawerArea)
 
void DetachPanelDrawerArea ()
 
bool RestorePanelDrawerArea ()
 
TMap< FTabId, TSharedRef< SDockTab > > GetPanelDrawerKeepAliveTabs () const
 
TSharedPtr< UE::Slate::Private::SPanelDrawerAreaGetPanelDrawerArea () const
 
bool RemoveHiddenInactivePanelDrawerTab (const TSharedPtr< SDockTab > &TabToRemove)
 
void CleanPanelDrawer ()
 
void SetPanelDrawerHiddenActiveTab (TSharedRef< UE::Slate::Private::FPanelDrawerData > &&InPanelDrawerData)
 
- Public Member Functions inherited from SDockingSplitter
 SLATE_BEGIN_ARGS (SDockingSplitter)
 
SLATE_API void Construct (const FArguments &InArgs, const TSharedRef< FTabManager::FSplitter > &PersistentNode)
 
SLATE_API void AddChildNode (const TSharedRef< SDockingNode > &InChild, int32 InLocation=INDEX_NONE)
 
SLATE_API void ReplaceChild (const TSharedRef< SDockingNode > &InChildToReplace, const TSharedRef< SDockingNode > &Replacement)
 
SLATE_API void RemoveChild (const TSharedRef< SDockingNode > &ChildToRemove)
 
SLATE_API void RemoveChildAt (int32 IndexOfChildToRemove)
 
SLATE_API void PlaceNode (const TSharedRef< SDockingNode > &NodeToPlace, SDockingNode::RelativeDirection Direction, const TSharedRef< SDockingNode > &RelativeToMe)
 
SLATE_API void SetOrientation (EOrientation NewOrientation)
 
SLATE_API const TArray< TSharedRef< SDockingNode > > & GetChildNodes () const
 
SLATE_API TArray< TSharedRef< SDockingNode > > GetChildNodesRecursively () const
 
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 float GetSizeCoefficientForSlot (int32 Index) const
 
SLATE_API EOrientation GetOrientation () const
 
SLATE_API TSharedRef< SDockingTabStackFindTabStackToHouseWindowControls () const
 
SLATE_API TSharedRef< SDockingTabStackFindTabStackToHouseWindowIcon () const
 
- Public Member Functions inherited from SDockingNode
virtual void SetParentNode (TSharedRef< SDockingSplitter > InParent)
 
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 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 OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
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 FReply OnDragOver (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)
 
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

virtual SLATE_API SDockingNode::ECleanupRetVal CleanUpNodes () override
 
- Protected Member Functions inherited from SDockingSplitter
virtual SLATE_API void OnResized () override
 
SLATE_API float ComputeChildCoefficientTotal () const
 
SLATE_API TSharedRef< SDockingNodeFindTabStack (ETabStackToFind FindMe) const
 
SLATE_API void AdjustDockedTabsIfNeeded ()
 
- Protected Member Functions inherited from SDockingNode
SLATE_API SDockingNode ()
 
- 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

- 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 }
 
- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Protected Types inherited from SDockingSplitter
enum class  ETabStackToFind { UpperLeft , UpperRight }
 
- Static Protected Member Functions inherited from SDockingSplitter
static SLATE_API bool DoesDirectionMatchOrientation (SDockingNode::RelativeDirection InDirection, EOrientation InOrientation)
 
static SLATE_API SDockingNode::ECleanupRetVal MostResponsibility (SDockingNode::ECleanupRetVal A, SDockingNode::ECleanupRetVal B)
 
- 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 SDockingSplitter
TSharedPtr< SSplitterSplitter
 
TArray< TSharedRef< class SDockingNode > > Children
 
- 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

Represents the root node in a hierarchy of DockNodes.

Member Function Documentation

◆ AddSidebarTabsFromRestoredLayout()

void SDockingArea::AddSidebarTabsFromRestoredLayout ( const FSidebarTabLists SidebarTabs)

Adds all tabs back to a sidebar that were saved in a sidebar from a previous session

◆ AddTabToSidebar()

ESidebarLocation SDockingArea::AddTabToSidebar ( TSharedRef< SDockTab TabToAdd)

Adds a tab to a drawer in the sidebar.

Parameters
TabToAddThe tab to add to the sidebar
Returns
The location of the sidebar that the tab was added to

◆ CanHaveSidebar()

bool SDockingArea::CanHaveSidebar ( ) const
inline

◆ CleanPanelDrawer()

void SDockingArea::CleanPanelDrawer ( )

Remove any data that could cause this Paneldrawer to stay alive. Also transfer some state to the top level area if needed

◆ CleanUp()

void SDockingArea::CleanUp ( ELayoutModification  RemovalMethod)

Removes redundant stack and splitters. Collapses any widgets that any no longer showing live content.

◆ CleanUpNodes()

SDockingNode::ECleanupRetVal SDockingArea::CleanUpNodes ( )
overrideprotectedvirtual

Reimplemented from SDockingSplitter.

◆ ClosePanelDrawer()

void SDockingArea::ClosePanelDrawer ( )

Close the PanelDrawer associated to this area

◆ ClosePanelDrawerForTransfer()

TSharedPtr< SDockTab > SDockingArea::ClosePanelDrawerForTransfer ( )

Close the PanelDrawer associated to this area but set it up for a tab transfer

◆ Construct()

void SDockingArea::Construct ( const FArguments &  InArgs,
const TSharedRef< FTabManager > &  InTabManager,
const TSharedRef< FTabManager::FArea > &  PersistentNode 
)

True if this docking area should close the parent window when the last tab in this docking area goes away What to put into the DockArea initially. Usually a TabStack, so that some tabs can be added to it.

◆ DetachPanelDrawerArea()

void SDockingArea::DetachPanelDrawerArea ( )

Detach the PanelDrawer but doesn't setup or use the restore mechanism

◆ GatherPersistentLayout()

TSharedPtr< FTabManager::FLayoutNode > SDockingArea::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.

Reimplemented from SDockingSplitter.

◆ GetAllSidebarTabs()

TArray< TSharedRef< SDockTab > > SDockingArea::GetAllSidebarTabs ( ) const

Gets all tabs in all sidebars in this dock area

◆ GetDockArea() [1/2]

TSharedPtr< const SDockingArea > SDockingArea::GetDockArea ( ) const
overridevirtual

Reimplemented from SDockingNode.

◆ GetDockArea() [2/2]

TSharedPtr< SDockingArea > SDockingArea::GetDockArea ( )
overridevirtual

Returns this dock area

Reimplemented from SDockingNode.

◆ GetNodeType()

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

Reimplemented from SDockingSplitter.

◆ GetPanelDrawerArea()

TSharedPtr< UE::Slate::Private::SPanelDrawerArea > SDockingArea::GetPanelDrawerArea ( ) const

Get the PanelDrawer currently associated with this area

◆ GetPanelDrawerHostedTab()

TSharedPtr< SDockTab > SDockingArea::GetPanelDrawerHostedTab ( ) const

Get the currently active tab in the PanelDrawer

◆ GetPanelDrawerKeepAliveTabs()

TMap< FTabId, TSharedRef< SDockTab > > SDockingArea::GetPanelDrawerKeepAliveTabs ( ) const

Get list of tabs this PanelDrawer is keeping alive

◆ GetPanelDrawerSystemHostedTab()

TSharedPtr< SDockTab > SDockingArea::GetPanelDrawerSystemHostedTab ( const FTabId TabId) const

Check if the tab is hosted by the PanelDrawer system associated to this area (Include previously hosted tabs ready to reopened)

◆ GetParentWindow()

TSharedPtr< SWindow > SDockingArea::GetParentWindow ( ) const

Returns the window that this dock area resides in directly and also manages

◆ GetTabManager()

TSharedRef< FTabManager > SDockingArea::GetTabManager ( ) const

◆ HasPanelDrawer()

bool SDockingArea::HasPanelDrawer ( ) const

Does this area have a DrawerPanel associated with it

◆ HideCross()

void SDockingArea::HideCross ( )

◆ HostTabIntoPanelDrawer()

bool SDockingArea::HostTabIntoPanelDrawer ( const TSharedRef< SDockTab > &  InTab)

If we have a PanelDrawer the tab host the tab in it

◆ IsPanelDrawerOpen()

bool SDockingArea::IsPanelDrawerOpen ( ) const

Return true if the area as an open PanelDrawer

◆ IsTabInSidebar()

bool SDockingArea::IsTabInSidebar ( TSharedRef< SDockTab Tab) const
Returns
true if the specified tab is in the sidebar

◆ OnDragEnter()

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

◆ OnTabFoundNewHome()

void SDockingArea::OnTabFoundNewHome ( const TSharedRef< SDockTab > &  RelocatedTab,
const TSharedRef< SWindow > &  NewOwnerWindow 
)

◆ OnUserAttemptingDock()

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

◆ RemoveHiddenInactivePanelDrawerTab()

bool SDockingArea::RemoveHiddenInactivePanelDrawerTab ( const TSharedPtr< SDockTab > &  TabToRemove)

Remove a hidden but keep alive tab by the PanelDrawer. This may include the PanelDrawer hidden active tab if the area currently doesn't have an associated PanelDrawer

◆ RemoveTabFromSidebar()

bool SDockingArea::RemoveTabFromSidebar ( TSharedRef< SDockTab Tab)

Removes a tab from a sidebar

Returns
true if the specified tab was found and removed

◆ RestorePanelDrawerArea()

bool SDockingArea::RestorePanelDrawerArea ( )

Used to set the state of the PanelDrawer associated to this area

◆ RestoreTabFromSidebar()

bool SDockingArea::RestoreTabFromSidebar ( TSharedRef< SDockTab TabToRemove)

Restores a tab from the sidebar to its parent tab stack and removes the tab from the sidebar.

Returns
true if the tab was found in this area and restore

◆ SetPanelDrawerArea()

void SDockingArea::SetPanelDrawerArea ( const TSharedPtr< UE::Slate::Private::SPanelDrawerArea > &  InPanelDrawerArea)

Associate a PanelDrawer to this area

◆ SetPanelDrawerHiddenActiveTab()

void SDockingArea::SetPanelDrawerHiddenActiveTab ( TSharedRef< UE::Slate::Private::FPanelDrawerData > &&  InPanelDrawerData)

Use when restoring a layout do not use outside of that

◆ SetParentWindow()

void SDockingArea::SetParentWindow ( const TSharedRef< SWindow > &  NewParentWindow)

◆ ShowCross()

void SDockingArea::ShowCross ( )

◆ SLATE_BEGIN_ARGS()

SDockingArea::SLATE_BEGIN_ARGS ( SDockingArea  )
inline

◆ TryOpenSidebarDrawer()

bool SDockingArea::TryOpenSidebarDrawer ( TSharedRef< SDockTab TabToOpen) const

Attempts to open a sidebar drawer that may the tab to open

@true if the drawer was opened, false if the tab is not in a drawer


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