#include <SDockingTabWell.h>

Inheritance diagram for SDockingTabWell:

Public Member Functions
	SLATE_BEGIN_ARGS (SDockingTabWell)

	SDockingTabWell ()

void	Construct (const FArguments &InArgs)

int32	GetNumTabs () const

const TSlotlessChildren< SDockTab > &	GetTabs () const

void	AddTab (const TSharedRef< SDockTab > &InTab, int32 AtIndex=INDEX_NONE, bool bKeepInactive=false)

void	BringTabToFront (int32 TabIndexToActivate)

void	BringTabToFront (TSharedPtr< SDockTab > TabToActivate)

TSharedPtr< SDockTab >	GetForegroundTab () const

int32	GetForegroundTabIndex () const

void	RemoveAndDestroyTab (const TSharedRef< SDockTab > &TabToRemove, SDockingNode::ELayoutModification RemovalMethod)

void	RefreshParentContent ()

TSharedPtr< SDockingArea >	GetDockArea ()

TSharedPtr< SDockingTabStack >	GetParentDockTabStack ()

FReply	StartDraggingTab (TSharedRef< SDockTab > TabToStartDragging, FVector2D TabGrabOffsetFraction, const FPointerEvent &MouseEvent)

FVector2D	ComputeChildSize (const FGeometry &AllottedGeometry) const

virtual void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual FVector2D	ComputeDesiredSize (float) const override

virtual FChildren *	GetChildren () override

virtual void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override

virtual void	OnDragLeave (const FDragDropEvent &DragDropEvent) override

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

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

virtual EWindowZone::Type	GetWindowZoneOverride () const override

virtual FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

Public Member Functions inherited from SPanel
void	Construct ()

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 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 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)

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	GetForegroundColor () 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

Additional Inherited Members
Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Protected Member Functions inherited from SPanel
SLATECORE_API int32	PaintArrangedChildren (const FPaintArgs &Args, const FArrangedChildren &ArrangedChildren, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

SLATECORE_API	SPanel ()

virtual SLATECORE_API	~SPanel ()

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 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 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

TabWell is a panel that shows dockable tabs. Tabs can be re-arranged and dragged out of the TabStack.

Constructor & Destructor Documentation

◆ SDockingTabWell()

SDockingTabWell::SDockingTabWell ( )

Member Function Documentation

◆ AddTab()

void SDockingTabWell::AddTab	(	const TSharedRef< SDockTab > &	InTab,
		int32	AtIndex = `INDEX_NONE`,
		bool	bKeepInactive = `false`
	)

Add a new tab (InTab) to the TabWell at location (AtIndex).

Parameters

InTab	TheTab to add
AtIndex	Add at this index or at the end if INDEX_NONE(default)

◆ BringTabToFront() [1/2]

void SDockingTabWell::BringTabToFront ( int32 TabIndexToActivate )

Activate the tab specified by TabToActivate index.

◆ BringTabToFront() [2/2]

void SDockingTabWell::BringTabToFront ( TSharedPtr< SDockTab > TabToActivate )

Activate the tab specified by TabToActivate SDockTab.

◆ ComputeChildSize()

FVector2D SDockingTabWell::ComputeChildSize ( const FGeometry & AllottedGeometry ) const

Assume all tabs overlap the same amount.

◆ ComputeDesiredSize()

FVector2D SDockingTabWell::ComputeDesiredSize ( float ) const

overridevirtual

A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user. See StackPanel for an example.

Returns: The desired size.

Implements SPanel.

◆ Construct()

void SDockingTabWell::Construct ( const FArguments & InArgs )

◆ GetChildren()

FChildren * SDockingTabWell::GetChildren ( )

overridevirtual

All widgets must provide a way to access their children in a layout-agnostic way. Panels store their children in Slots, which creates a dilemma. Most panels can store their children in a TPanelChildren<Slot>, where the Slot class provides layout information about the child it stores. In that case GetChildren should simply return the TPanelChildren<Slot>. See StackPanel for an example.

Implements SPanel.

◆ GetDockArea()

TSharedPtr< SDockingArea > SDockingTabWell::GetDockArea ( )

Gets the dock area that this resides in

◆ GetForegroundTab()

TSharedPtr< SDockTab > SDockingTabWell::GetForegroundTab ( ) const

Gets the currently active tab (or the currently dragged tab), or a null pointer if no tab is active.

◆ GetForegroundTabIndex()

int32 SDockingTabWell::GetForegroundTabIndex ( ) const

Gets the index of the currently active tab, or INDEX_NONE if no tab is active or a tab is being dragged.

◆ GetNumTabs()

int32 SDockingTabWell::GetNumTabs ( ) const

Returns: How many tabs there are.

◆ GetParentDockTabStack()

TSharedPtr< SDockingTabStack > SDockingTabWell::GetParentDockTabStack ( )

Gets the parent dockable tab stack this tab well belong to

◆ GetTabs()

const TSlotlessChildren< SDockTab > & SDockingTabWell::GetTabs ( ) const

Returns: All child tabs in this node

◆ GetWindowZoneOverride()

EWindowZone::Type SDockingTabWell::GetWindowZoneOverride ( ) const

overridevirtual

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

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

Reimplemented from SWidget.

◆ OnArrangeChildren()

void SDockingTabWell::OnArrangeChildren	(	const FGeometry &	AllottedGeometry,
		FArrangedChildren &	ArrangedChildren
	)		const

overridevirtual

Panels arrange their children in a space described by the AllottedGeometry parameter. The results of the arrangement should be returned by appending a FArrangedWidget pair for every child widget. See StackPanel for an example

Parameters

AllottedGeometry	The geometry allotted for this widget by its parent.
ArrangedChildren	The array to which to add the WidgetGeometries that represent the arranged children.

Implements SPanel.

◆ OnDragEnter()

void SDockingTabWell::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

MyGeometry	The geometry of the widget receiving the event.
DragDropEvent	The 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 SDockingTabWell::OnDragLeave ( const FDragDropEvent & DragDropEvent )

overridevirtual

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

Parameters

DragDropEvent The drag and drop event.

Reimplemented from SWidget.

◆ OnDragOver()

FReply SDockingTabWell::OnDragOver	(	const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

overridevirtual

Called during drag and drop when the the mouse is being dragged over a widget.

Parameters

MyGeometry	The geometry of the widget receiving the event.
DragDropEvent	The drag and drop event.

Returns: A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnDrop()

FReply SDockingTabWell::OnDrop	(	const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

overridevirtual

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

Parameters

MyGeometry	The geometry of the widget receiving the event.
DragDropEvent	The drag and drop event.

Returns: A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnMouseButtonUp()

FReply SDockingTabWell::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

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnMouseMove()

FReply SDockingTabWell::OnMouseMove	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

overridevirtual

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

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from SWidget.

◆ OnPaint()

int32 SDockingTabWell::OnPaint	(	const FPaintArgs &	Args,
		const FGeometry &	AllottedGeometry,
		const FSlateRect &	MyCullingRect,
		FSlateWindowElementList &	OutDrawElements,
		int32	LayerId,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)		const

overridevirtual

The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.

Parameters

Args	All the arguments necessary to paint this widget (
AllottedGeometry	The FGeometry that describes an area in which the widget should appear.
MyCullingRect	The rectangle representing the bounds currently being used to completely cull widgets. Unless IsChildWidgetCulled(...) returns true, you should paint the widget.
OutDrawElements	A list of FDrawElements to populate with the output.
LayerId	The Layer onto which this widget should be rendered.
InColorAndOpacity	Color and Opacity to be applied to all the descendants of the widget being painted
bParentEnabled	True if the parent of this widget is enabled.

Returns: The maximum layer ID attained by this widget or any of its children.

Reimplemented from SPanel.

◆ RefreshParentContent()

void SDockingTabWell::RefreshParentContent ( )

◆ RemoveAndDestroyTab()

void SDockingTabWell::RemoveAndDestroyTab	(	const TSharedRef< SDockTab > &	TabToRemove,
		SDockingNode::ELayoutModification	RemovalMethod
	)

Removes the passed in tab from the tab well and trashes it.

Parameters

TabToRemove	The tab to be removed
RemovalMethod	The user action that caused the tab to be removed

◆ SLATE_BEGIN_ARGS()

SDockingTabWell::SLATE_BEGIN_ARGS ( SDockingTabWell )

inline

◆ StartDraggingTab()

FReply SDockingTabWell::StartDraggingTab	(	TSharedRef< SDockTab >	TabToStartDragging,
		FVector2D	TabGrabOffsetFraction,
		const FPointerEvent &	MouseEvent
	)

A tab notifies us that the started dragging it, so we should begin re-arranging layout

Parameters

TabToStartDragging	The tab that notified us that the user started dragging it
TabGrabOffsetFraction	The offset into the tab where the user grabbed it; as a fraction of the tab's size.
MouseEvent	The mouse event that caused this dragging to start.

Returns: The DragDrop operation

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SDockingTabWell()

Member Function Documentation

◆ AddTab()

◆ BringTabToFront() [1/2]

◆ BringTabToFront() [2/2]

◆ ComputeChildSize()

◆ ComputeDesiredSize()

◆ Construct()

◆ GetChildren()

◆ GetDockArea()

◆ GetForegroundTab()

◆ GetForegroundTabIndex()

◆ GetNumTabs()

◆ GetParentDockTabStack()

◆ GetTabs()

◆ GetWindowZoneOverride()

◆ OnArrangeChildren()

◆ OnDragEnter()

◆ OnDragLeave()

◆ OnDragOver()

◆ OnDrop()

◆ OnMouseButtonUp()

◆ OnMouseMove()

◆ OnPaint()

◆ RefreshParentContent()

◆ RemoveAndDestroyTab()

◆ SLATE_BEGIN_ARGS()

◆ StartDraggingTab()