#include <SDockingSplitter.h>

Inheritance diagram for SDockingSplitter:

Public Member Functions
	SLATE_BEGIN_ARGS (SDockingSplitter)

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

virtual Type	GetNodeType () const override

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

virtual SLATE_API TSharedPtr< FTabManager::FLayoutNode >	GatherPersistentLayout () const override

SLATE_API TSharedRef< SDockingTabStack >	FindTabStackToHouseWindowControls () const

SLATE_API TSharedRef< SDockingTabStack >	FindTabStackToHouseWindowIcon () const

Public Member Functions inherited from SDockingNode
virtual void	SetParentNode (TSharedRef< SDockingSplitter > InParent)

virtual SLATE_API TSharedPtr< SDockingArea >	GetDockArea ()

virtual SLATE_API TSharedPtr< const SDockingArea >	GetDockArea () const

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

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 FChildren *	GetChildren () 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< FPopupLayer >	OnVisualizePopup (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 void	OnDragLeave (const FDragDropEvent &DragDropEvent)

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

virtual SLATECORE_API FReply	OnDrop (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< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (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 FSlateWidgetPersistentState &	GetPersistentState () 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< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_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 FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	SupportsKeyboardFocus () const

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () 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< IToolTip >	GetToolTip ()

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< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () 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 FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (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 FSlateWidgetClassData &	GetWidgetClass () 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	ETabStackToFind { UpperLeft , UpperRight }

Protected Member Functions
virtual SLATE_API SDockingNode::ECleanupRetVal	CleanUpNodes () override

virtual SLATE_API void	OnResized () override

SLATE_API float	ComputeChildCoefficientTotal () const

SLATE_API TSharedRef< SDockingNode >	FindTabStack (ETabStackToFind FindMe) const

SLATE_API void	AdjustDockedTabsIfNeeded ()

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< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () 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::Type >	GetCursor () 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 FSlateBrush *	GetFocusBrush () 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< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions
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< EVisibility >	AccessWidgetVisibilityAttribute (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
TSharedPtr< SSplitter >	Splitter

TArray< TSharedRef< class SDockingNode > >	Children

Protected Attributes inherited from SDockingNode
TWeakPtr< SDockingSplitter >	ParentNodePtr

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

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 FSlateWidgetClassData &	StaticWidgetClass ()

Detailed Description

Dynamic N-way splitter that provides the resizing functionality in the docking framework.

Member Enumeration Documentation

◆ ETabStackToFind

enum class SDockingSplitter::ETabStackToFind

strongprotected

Enumerator
UpperLeft
UpperRight

Member Function Documentation

◆ AddChildNode()

void SDockingSplitter::AddChildNode	(	const TSharedRef< SDockingNode > &	InChild,
		int32	InLocation = `INDEX_NONE`
	)

Add a new child dock node at the desired location. Assumes this DockNode is a splitter.

Parameters

InChild	The DockNode child to add.
InLocation	Index at which to add; INDEX_NONE (default) adds to the end of the list

◆ AdjustDockedTabsIfNeeded()

void SDockingSplitter::AdjustDockedTabsIfNeeded ( )

protected

As the Dock area is updating after clean up of any added, removed, or newly shown Dock areas or tabs, the tabs/tab well may need adjusting. Use this for post clean up docked tab adjustments.

◆ CleanUpNodes()

SDockingNode::ECleanupRetVal SDockingSplitter::CleanUpNodes ( )

overrideprotectedvirtual

Reimplemented from SDockingNode.

Reimplemented in SDockingArea.

◆ ComputeChildCoefficientTotal()

float SDockingSplitter::ComputeChildCoefficientTotal ( ) const

protected

◆ Construct()

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

◆ DoesDirectionMatchOrientation()

bool SDockingSplitter::DoesDirectionMatchOrientation	(	SDockingNode::RelativeDirection	InDirection,
		EOrientation	InOrientation
	)

staticprotected

Is the docking direction (left, right, above, below) match the orientation (horizontal vs. vertical)

◆ FindTabStack()

TSharedRef< SDockingNode > SDockingSplitter::FindTabStack ( ETabStackToFind FindMe ) const

protected

Helper: Finds the upper left or the upper right tab stack in the hierarchy

◆ FindTabStackToHouseWindowControls()

TSharedRef< SDockingTabStack > SDockingSplitter::FindTabStackToHouseWindowControls ( ) const

The tab stack which would be appropriate to use for showing the minimize/maximize/close buttons. On Windows it is the upper right most. On Mac the upper left most.

◆ FindTabStackToHouseWindowIcon()

TSharedRef< SDockingTabStack > SDockingSplitter::FindTabStackToHouseWindowIcon ( ) const

Which tab stack is appropriate for showing the app icon.

◆ GatherPersistentLayout()

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

Reimplemented in SDockingArea.

◆ GetAllChildTabs()

TArray< TSharedRef< SDockTab > > SDockingSplitter::GetAllChildTabs ( ) const

overridevirtual

Recursively searches through all children looking for child tabs

Reimplemented from SDockingNode.

◆ GetChildNodes()

const TArray< TSharedRef< SDockingNode > > & SDockingSplitter::GetChildNodes ( ) const

Gets an array of all child dock nodes

◆ GetChildNodesRecursively()

TArray< TSharedRef< SDockingNode > > SDockingSplitter::GetChildNodesRecursively ( ) const

Gets an array of all child dock nodes and all of their child dock nodes and so on

◆ GetNodeType()

virtual Type SDockingSplitter::GetNodeType ( ) const

inlineoverridevirtual

Returns: Is this dock node a tab stack, splitter or something else?

Implements SDockingNode.

Reimplemented in SDockingArea.

◆ GetNumTabs()

int32 SDockingSplitter::GetNumTabs ( ) const

overridevirtual

Gets the number of tabs in all children recursively

Reimplemented from SDockingNode.

◆ GetOrientation()

EOrientation SDockingSplitter::GetOrientation ( ) const

Gets the orientation of this splitter

◆ GetSizeCoefficientForSlot()

SLATE_API float SDockingSplitter::GetSizeCoefficientForSlot ( int32 Index ) const

Gets the size coefficient of a given child dock node

◆ GetSizeRule()

SSplitter::ESizeRule SDockingSplitter::GetSizeRule ( ) const

overridevirtual

Should this node auto-size or be a percentage of its parent size

Reimplemented from SDockingNode.

◆ MostResponsibility()

SDockingNode::ECleanupRetVal SDockingSplitter::MostResponsibility	(	SDockingNode::ECleanupRetVal	A,
		SDockingNode::ECleanupRetVal	B
	)

staticprotected

◆ OnResized()

void SDockingSplitter::OnResized ( )

overrideprotectedvirtual

Reimplemented from SDockingNode.

◆ PlaceNode()

void SDockingSplitter::PlaceNode	(	const TSharedRef< SDockingNode > &	NodeToPlace,
		SDockingNode::RelativeDirection	Direction,
		const TSharedRef< SDockingNode > &	RelativeToMe
	)

Inserts NodeToPlace next to RelativeToMe. Next to means above, below, left or right of RelativeToMe.

Parameters

NodeToPlace	The node to insert.
Direction	Where to insert relative to the other node
RelativeToMove	Insert relative to this node.

◆ RemoveChild()

void SDockingSplitter::RemoveChild ( const TSharedRef< SDockingNode > & ChildToRemove )

Remove a child node from the splitter

Parameters

ChildToRemove The child node to remove from this splitter

◆ RemoveChildAt()

void SDockingSplitter::RemoveChildAt ( int32 IndexOfChildToRemove )

Remove a child at this index

Parameters

IndexOfChildToRemove Remove a child at this index

◆ ReplaceChild()

void SDockingSplitter::ReplaceChild	(	const TSharedRef< SDockingNode > &	InChildToReplace,
		const TSharedRef< SDockingNode > &	Replacement
	)

Replace the child InChildToReplace with Replacement

Parameters

InChildToReplace	The child of this node to replace
Replacement	What to replace with

◆ SetOrientation()

void SDockingSplitter::SetOrientation ( EOrientation NewOrientation )

Sets the orientation of this splitter

◆ SLATE_BEGIN_ARGS()

SDockingSplitter::SLATE_BEGIN_ARGS ( SDockingSplitter )

inline

Member Data Documentation

◆ Children

TArray< TSharedRef<class SDockingNode> > SDockingSplitter::Children

protected

The DockNode children. All these children are kept in sync with the SSplitter's children via the use of the public interface for adding, removing and replacing children.

◆ Splitter

TSharedPtr<SSplitter> SDockingSplitter::Splitter

protected

The SSplitter widget that SDockingSplitter wraps.

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

Engine/Source/Runtime/Slate/Private/Framework/Docking/SDockingSplitter.h
Engine/Source/Runtime/Slate/Private/Framework/Docking/SDockingSplitter.cpp

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ETabStackToFind

Member Function Documentation

◆ AddChildNode()

◆ AdjustDockedTabsIfNeeded()

◆ CleanUpNodes()

◆ ComputeChildCoefficientTotal()

◆ Construct()

◆ DoesDirectionMatchOrientation()

◆ FindTabStack()

◆ FindTabStackToHouseWindowControls()

◆ FindTabStackToHouseWindowIcon()

◆ GatherPersistentLayout()

◆ GetAllChildTabs()

◆ GetChildNodes()

◆ GetChildNodesRecursively()

◆ GetNodeType()

◆ GetNumTabs()

◆ GetOrientation()

◆ GetSizeCoefficientForSlot()

◆ GetSizeRule()

◆ MostResponsibility()

◆ OnResized()

◆ PlaceNode()

◆ RemoveChild()

◆ RemoveChildAt()

◆ ReplaceChild()

◆ SetOrientation()

◆ SLATE_BEGIN_ARGS()

Member Data Documentation

◆ Children

◆ Splitter