#include <SWindow.h>

Inheritance diagram for SWindow:

Classes
struct	FMorpher

Public Types
using	FScopedWidgetSlotArguments = TPanelChildren< FPopupLayerSlot >::FScopedWidgetSlotArguments

Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }

Public Member Functions
	SLATE_BEGIN_ARGS (SWindow)

SLATECORE_API	SWindow ()

SLATECORE_API	~SWindow ()

SLATECORE_API void	Construct (const FArguments &InArgs)

EWindowType	GetType () const

FText	GetTitle () const

void	SetTitle (const FText &InTitle)

SLATECORE_API int32	PaintWindow (double CurrentTime, float DeltaTime, FSlateWindowElementList &OutDrawElements, const FWidgetStyle &InWidgetStyle, bool bParentEnabled)

SLATECORE_API FOptionalSize	GetTitleBarSize () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSizeDesktopPixels () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetInitialDesiredSizeInScreen () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetInitialDesiredPositionInScreen () const

SLATECORE_API FGeometry	GetWindowGeometryInScreen () const

SLATECORE_API FGeometry	GetWindowGeometryInWindow () const

SLATECORE_API FSlateLayoutTransform	GetLocalToScreenTransform () const

SLATECORE_API FSlateLayoutTransform	GetLocalToWindowTransform () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetPositionInScreen () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetSizeInScreen () const

SLATECORE_API FSlateRect	GetNonMaximizedRectInScreen () const

SLATECORE_API FSlateRect	GetRectInScreen () const

SLATECORE_API FSlateRect	GetClientRectInScreen () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetClientSizeInScreen () const

SLATECORE_API FSlateRect	GetClippingRectangleInWindow () const

SLATECORE_API FMargin	GetWindowBorderSize (bool bIncTitleBar=false) const

SLATECORE_API FMargin	GetNonMaximizedWindowBorderSize () const

SLATECORE_API void	MoveWindowTo (UE::Slate::FDeprecateVector2DParameter NewPosition)

SLATECORE_API void	ReshapeWindow (UE::Slate::FDeprecateVector2DParameter NewPosition, UE::Slate::FDeprecateVector2DParameter NewSize)

SLATECORE_API void	ReshapeWindow (const FSlateRect &InNewShape)

SLATECORE_API void	Resize (UE::Slate::FDeprecateVector2DParameter NewClientSize)

SLATECORE_API FSlateRect	GetFullScreenInfo () const

SLATECORE_API bool	IsMorphing () const

SLATECORE_API bool	IsMorphingSize () const

SLATECORE_API void	MorphToPosition (const FCurveSequence &Sequence, const float TargetOpacity, const UE::Slate::FDeprecateVector2DParameter &TargetPosition)

SLATECORE_API void	MorphToShape (const FCurveSequence &Sequence, const float TargetOpacity, const FSlateRect &TargetShape)

SLATECORE_API void	UpdateMorphTargetShape (const FSlateRect &TargetShape)

SLATECORE_API void	UpdateMorphTargetPosition (const UE::Slate::FDeprecateVector2DParameter &TargetPosition)

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetMorphTargetPosition () const

SLATECORE_API FSlateRect	GetMorphTargetShape () const

SLATECORE_API void	FlashWindow ()

SLATECORE_API void	DrawAttention (const FWindowDrawAttentionParameters &Parameters)

SLATECORE_API void	BringToFront (bool bForce=false)

SLATECORE_API void	HACK_ForceToFront ()

SLATECORE_API void	SetCachedScreenPosition (UE::Slate::FDeprecateVector2DParameter NewPosition)

SLATECORE_API void	SetCachedSize (UE::Slate::FDeprecateVector2DParameter NewSize)

SLATECORE_API TSharedPtr< FGenericWindow >	GetNativeWindow ()

SLATECORE_API TSharedPtr< const FGenericWindow >	GetNativeWindow () const

SLATECORE_API float	GetDPIScaleFactor () const

SLATECORE_API void	SetDPIScaleFactor (const float Factor)

SLATECORE_API void	SetManualManageDPIChanges (const bool bManualDPI)

bool	IsManualManageDPIChanges () const

SLATECORE_API bool	IsDescendantOf (const TSharedPtr< SWindow > &ParentWindow) const

SLATECORE_API void	SetNativeWindow (TSharedRef< FGenericWindow > InNativeWindow)

SLATECORE_API void	SetContent (TSharedRef< SWidget > InContent)

SLATECORE_API TSharedRef< SWidget >	GetContent ()

SLATECORE_API bool	HasOverlay () const

SLATECORE_API SOverlay::FScopedWidgetSlotArguments	AddOverlaySlot (const int32 ZOrder=INDEX_NONE)

SLATECORE_API bool	RemoveOverlaySlot (const TSharedRef< SWidget > &InContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent) override

SLATECORE_API FScopedWidgetSlotArguments	AddPopupLayerSlot ()

SLATECORE_API void	RemovePopupLayerSlot (const TSharedRef< SWidget > &WidgetToRemove)

SLATECORE_API void	SetFullWindowOverlayContent (TSharedPtr< SWidget > InContent)

SLATECORE_API void	BeginFullWindowOverlayTransition ()

SLATECORE_API void	EndFullWindowOverlayTransition ()

SLATECORE_API bool	HasFullWindowOverlayContent () const

SLATECORE_API void	SetNativeWindowButtonsVisibility (bool bVisible)

SLATECORE_API bool	AppearsInTaskbar () const

FOnWindowActivatedEvent &	GetOnWindowActivatedEvent ()

FOnWindowDeactivatedEvent &	GetOnWindowDeactivatedEvent ()

SLATECORE_API void	SetOnWindowClosed (const FOnWindowClosed &InDelegate)

FOnWindowClosedEvent &	GetOnWindowClosedEvent ()

SLATECORE_API void	SetOnWindowMoved (const FOnWindowMoved &InDelegate)

SLATECORE_API void	SetRequestDestroyWindowOverride (const FRequestDestroyWindowOverride &InDelegate)

SLATECORE_API void	RequestDestroyWindow ()

SLATECORE_API void	DestroyWindowImmediately ()

SLATECORE_API void	NotifyWindowBeingDestroyed ()

SLATECORE_API void	ShowWindow ()

SLATECORE_API void	HideWindow ()

SLATECORE_API void	EnableWindow (bool bEnable)

SLATECORE_API void	SetWindowMode (EWindowMode::Type WindowMode)

EWindowMode::Type	GetWindowMode () const

SLATECORE_API bool	IsVisible () const

SLATECORE_API bool	IsWindowMaximized () const

SLATECORE_API bool	IsWindowMinimized () const

SLATECORE_API void	InitialMaximize ()

SLATECORE_API void	InitialMinimize ()

SLATECORE_API void	SetOpacity (const float InOpacity)

SLATECORE_API float	GetOpacity () const

SLATECORE_API EWindowTransparency	GetTransparencySupport () const

virtual SLATECORE_API FString	ToString () const override

void	SetWidgetToFocusOnActivate (TSharedPtr< SWidget > InWidget)

TWeakPtr< SWidget >	GetWidgetFocusedOnDeactivate ()

SLATECORE_API EWindowActivationPolicy	ActivationPolicy () const

SLATECORE_API bool	AcceptsInput () const

void	SetAcceptsInput (bool bEnabled)

SLATECORE_API bool	IsUserSized () const

SLATECORE_API bool	IsAutosized () const

SLATECORE_API void	SetSizingRule (ESizingRule InSizingRule)

SLATECORE_API bool	IsRegularWindow () const

SLATECORE_API bool	IsTopmostWindow () const

bool	SizeWillChangeOften () const

bool	ShouldPreserveAspectRatio () const

int32	GetExpectedMaxWidth () const

int32	GetExpectedMaxHeight () const

bool	HasOSWindowBorder () const

SLATECORE_API bool	IsScreenspaceMouseWithin (UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate) const

SLATECORE_API bool	HasSizingFrame () const

SLATECORE_API bool	HasCloseBox () const

SLATECORE_API bool	HasMaximizeBox () const

SLATECORE_API bool	HasMinimizeBox () const

void	SetAsModalWindow ()

bool	IsModalWindow ()

void	SetMirrorWindow (bool bSetMirrorWindow)

void	SetIsHDR (bool bHDR)

bool	GetIsHDR () const

void	SetViewportScaleUIOverride (float InViewportScaleUIOverride)

void	ResetViewportScaleUIOverride ()

float	GetViewportScaleUIOverride () const

bool	IsVirtualWindow () const

bool	IsMirrorWindow ()

void	SetTitleBar (const TSharedPtr< IWindowTitleBar > InTitleBar)

TSharedPtr< IWindowTitleBar >	GetTitleBar () const

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const override

virtual SLATECORE_API bool	OnIsActiveChanged (const FWindowActivateEvent &ActivateEvent)

SLATECORE_API void	Maximize ()

SLATECORE_API void	Restore ()

SLATECORE_API void	Minimize ()

SLATECORE_API EWindowZone::Type	GetCurrentWindowZone (UE::Slate::FDeprecateVector2DParameter LocalMousePosition)

SLATECORE_API int32	GetCornerRadius ()

virtual SLATECORE_API bool	SupportsKeyboardFocus () const override

bool	IsDrawingEnabled () const

virtual bool	Advanced_IsWindow () const override

virtual SLATECORE_API bool	Advanced_IsInvalidationRoot () const override

virtual SLATECORE_API const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const override

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetWindowSizeFromClientSize (UE::Slate::FDeprecateVector2DParameter InClientSize, TOptional< float > DPIScale=TOptional< float >())

bool	IsFocusedInitially () const

SLATECORE_API const TArray< TSharedRef< SWindow > > &	GetChildWindows () const

SLATECORE_API TArray< TSharedRef< SWindow > > &	GetChildWindows ()

SLATECORE_API void	AddChildWindow (const TSharedRef< SWindow > &ChildWindow)

SLATECORE_API TSharedPtr< SWindow >	GetParentWindow () const

SLATECORE_API TSharedPtr< SWindow >	GetTopmostAncestor ()

SLATECORE_API bool	RemoveDescendantWindow (const TSharedRef< SWindow > &DescendantToRemove)

SLATECORE_API void	SetOnWorldSwitchHack (FOnSwitchWorldHack &InOnWorldSwitchHack)

SLATECORE_API int32	SwitchWorlds (int32 WorldId) const

SLATECORE_API bool	IsActive () const

SLATECORE_API bool	HasActiveChildren () const

SLATECORE_API bool	HasActiveParent () const

void	SetViewportSizeDrivenByWindow (bool bDrivenByWindow)

bool	IsViewportSizeDrivenByWindow () const

UE::Slate::FDeprecateVector2DResult	GetViewportSize () const

void	SetIndependentViewportSize (const UE::Slate::FDeprecateVector2DParameter &VP)

void	SetViewport (TSharedRef< ISlateViewport > ViewportRef)

void	UnsetViewport (TSharedRef< ISlateViewport > ViewportRef)

TSharedPtr< ISlateViewport >	GetViewport ()

SLATECORE_API FHittestGrid &	GetHittestGrid ()

SLATECORE_API FWindowSizeLimits	GetSizeLimits () const

SLATECORE_API void	SetSizeLimits (const FWindowSizeLimits &InSizeLimits)

SLATECORE_API void	SetAllowFastUpdate (bool bInAllowFastUpdate)

virtual SLATECORE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override

SLATECORE_API EVisibility	GetWindowVisibility () const

SLATECORE_API TAttribute< FText >	GetWindowCloseButtonToolTipText () const

SLATECORE_API void	ProcessWindowInvalidation ()

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

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

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

Public Member Functions inherited from FSlateInvalidationRoot
SLATECORE_API	FSlateInvalidationRoot ()

virtual SLATECORE_API	~FSlateInvalidationRoot ()

virtual SLATECORE_API void	AddReferencedObjects (FReferenceCollector &Collector) override

virtual SLATECORE_API FString	GetReferencerName () const override

SLATECORE_API void	InvalidateRootChildOrder (const SWidget *Investigator=nullptr)

SLATECORE_API void	InvalidateRootLayout (const SWidget *Investigator=nullptr)

SLATECORE_API void	InvalidateScreenPosition (const SWidget *Investigator=nullptr)

bool	NeedsSlowPath () const

FHittestGrid *	GetHittestGrid () const

FSlateCachedElementData &	GetCachedElements ()

const FSlateCachedElementData &	GetCachedElements () const

const SWidget *	GetInvalidationRootWidget () const

FSlateInvalidationRootHandle	GetInvalidationRootHandle () const

const FSlateInvalidationWidgetList &	GetFastPathWidgetList () const

SLATECORE_API const TSharedPtr< SWidget >	GetFastPathWidgetListRoot () const

SLATECORE_API FSlateInvalidationResult	PaintInvalidationRoot (const FSlateInvalidationContext &Context)

void	OnWidgetDestroyed (const SWidget *Widget)

SLATECORE_API void	Advanced_ResetInvalidation (bool bClearResourcesImmediately)

Public Member Functions inherited from FGCObject
	FGCObject ()

	FGCObject (const FGCObject &Other)

	FGCObject (FGCObject &&Other)

	FGCObject (EFlags Flags)

virtual	~FGCObject ()

FGCObject &	operator= (const FGCObject &)

FGCObject &	operator= (FGCObject &&)

COREUOBJECT_API void	RegisterGCObject ()

COREUOBJECT_API void	UnregisterGCObject ()

virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Static Public Member Functions
static SLATECORE_API TSharedRef< SWindow >	MakeToolTipWindow ()

static SLATECORE_API TSharedRef< SWindow >	MakeCursorDecorator ()

static SLATECORE_API TSharedRef< SWindow >	MakeStyledCursorDecorator (const FWindowStyle &InStyle)

static SLATECORE_API TSharedRef< SWindow >	MakeNotificationWindow ()

static SLATECORE_API UE::Slate::FDeprecateVector2DResult	ComputeWindowSizeForContent (UE::Slate::FDeprecateVector2DParameter ContentSize)

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

Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()

Public Attributes
EWindowZone::Type	MoveResizeZone

UE::Slate::FDeprecateVector2DResult	MoveResizeStart

FSlateRect	MoveResizeRect

Protected Member Functions
virtual SLATECORE_API TSharedRef< SWidget >	MakeWindowTitleBar (const TSharedRef< SWindow > &Window, const TSharedPtr< SWidget > &CenterContent, EHorizontalAlignment CenterContentAlignment)

virtual SLATECORE_API EHorizontalAlignment	GetTitleAlignment ()

SLATECORE_API void	StartMorph ()

virtual SLATECORE_API bool	CustomPrepass (float LayoutScaleMultiplier) override

SLATECORE_API void	ConstructWindowInternals ()

SLATECORE_API EActiveTimerReturnType	TriggerPlayMorphSequence (double InCurrentTime, float InDeltaTime)

SLATECORE_API void	SetWindowBackground (const FSlateBrush *InWindowBackground)

SLATECORE_API void	UpdateWindowContentVisibility ()

virtual SLATECORE_API TSharedRef< SWidget >	GetRootWidget () override

virtual SLATECORE_API int32	PaintSlowPath (const FSlateInvalidationContext &InvalidationContext) override

Protected Member Functions inherited from SCompoundWidget
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 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 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 ()

Protected Member Functions inherited from FSlateInvalidationRoot
void	SetInvalidationRootWidget (SWidget &InInvalidationRootWidget)

void	SetInvalidationRootHittestGrid (FHittestGrid &InHittestGrid)

int32	GetCachedMaxLayerId () const

SLATECORE_API bool	ProcessInvalidation ()

SLATECORE_API void	ClearAllFastPathData (bool bClearResourcesImmediately)

virtual void	OnRootInvalidated ()

SLATECORE_API void	SetNeedsSlowPath (bool InNeedsSlowPath)

Protected Member Functions inherited from FNoncopyable
	FNoncopyable ()

	~FNoncopyable ()

Protected Attributes
EWindowType	Type

TAttribute< FText >	Title

TAttribute< FText >	CloseButtonToolTipText

bool	bDragAnywhere

float	Opacity

ESizingRule	SizingRule

EAutoCenter	AutoCenterRule

EWindowTransparency	TransparencySupport

bool	bCreateTitleBar: 1

bool	bIsPopupWindow: 1

bool	bIsTopmostWindow: 1

bool	bSizeWillChangeOften: 1

bool	bInitiallyMaximized: 1

bool	bInitiallyMinimized: 1

bool	bHasEverBeenShown: 1

bool	bFocusWhenFirstShown: 1

bool	bHasOSWindowBorder: 1

bool	bVirtualWindow: 1

bool	bHasCloseButton: 1

bool	bHasMinimizeButton: 1

bool	bHasMaximizeButton: 1

bool	bHasSizingFrame: 1

bool	bIsModalWindow: 1

bool	bIsMirrorWindow: 1

bool	bShouldPreserveAspectRatio: 1

bool	bIsHDR: 1

bool	bManualManageDPI: 1

bool	bAllowFastUpdate: 1

bool	bAcceptsInput: 1

EWindowActivationPolicy	WindowActivationPolicy

UE::Slate::FDeprecateVector2DResult	InitialDesiredScreenPosition

UE::Slate::FDeprecateVector2DResult	InitialDesiredSize

UE::Slate::FDeprecateVector2DResult	ScreenPosition

UE::Slate::FDeprecateVector2DResult	PreFullscreenPosition

UE::Slate::FDeprecateVector2DResult	Size

UE::Slate::FDeprecateVector2DResult	ViewportSize

TWeakPtr< ISlateViewport >	Viewport

float	ViewportScaleUIOverride

float	TitleBarSize

struct SWindow::FMorpher	Morpher

EWindowZone::Type	WindowZone

TSharedPtr< SWidget >	TitleArea

SVerticalBox::FSlot *	ContentSlot

TWeakPtr< SWidget >	WidgetToFocusOnActivate

TWeakPtr< SWidget >	WidgetFocusedOnDeactivate

FWindowSizeLimits	SizeLimits

TSharedPtr< FGenericWindow >	NativeWindow

TUniquePtr< FHittestGrid >	HittestGrid

FOnWindowActivated	OnWindowActivated

FOnWindowActivatedEvent	WindowActivatedEvent

FOnWindowDeactivated	OnWindowDeactivated

FOnWindowDeactivatedEvent	WindowDeactivatedEvent

FOnWindowClosed	OnWindowClosed

FOnWindowClosedEvent	WindowClosedEvent

FOnWindowMoved	OnWindowMoved

FRequestDestroyWindowOverride	RequestDestroyWindowOverride

TSharedPtr< SOverlay >	WindowOverlay

TSharedPtr< class SPopupLayer >	PopupLayer

TSharedPtr< SWidget >	FullWindowOverlayWidget

TWeakPtr< SWindow >	ParentWindowPtr

TArray< TSharedRef< SWindow > >	ChildWindows

FOnSwitchWorldHack	OnWorldSwitchHack

bool	bShouldShowWindowContentDuringOverlay

int32	ExpectedMaxWidth

int32	ExpectedMaxHeight

int32	FocusUserIndex

TSharedPtr< IWindowTitleBar >	TitleBar

FMargin	LayoutBorder

FMargin	UserResizeBorder

bool	bIsDrawingEnabled

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
Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

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)

Detailed Description

SWindow is a platform-agnostic representation of a top-level window.

Member Typedef Documentation

◆ FScopedWidgetSlotArguments

using SWindow::FScopedWidgetSlotArguments = TPanelChildren<FPopupLayerSlot>::FScopedWidgetSlotArguments

Constructor & Destructor Documentation

◆ SWindow()

SWindow::SWindow ( )

Type of this window Style used to draw this window Title of the window When true, the window can be dragged from anywhere. The windows auto-centering mode. If set to anything other than None, then the ScreenPosition value will be ignored Screen-space position where the window should be initially located. What the initial size of the window should be. If the initial ClientSize and ScreenPosition arguments should be automatically adjusted to account for DPI scale Should this window support transparency The initial opacity of the window Is the window initially maximized Is the window initially minimized How the window should be sized True if this should be a 'pop-up' window True if this window should always be on top of all other windows Should this window be focused immediately after it is shown? The index of the user that should focus this window on activation. INDEX_NONE for all users When should this window be activated upon being shown? Use the default os look for the border of the window Does this window have a close button? Can this window be maximized? Can this window be minimized? Should this window preserve its aspect ratio when resized by user? The smallest width this window can be in Desktop Pixel Units. The smallest height this window can be in Desktop Pixel Units. The biggest width this window can be in Desktop Pixel Units. The biggest height this window can be in Desktop Pixel Units. True if we should initially create a traditional title bar area. If false, the user must embed the title area content into the window manually, taking into account platform-specific considerations! Has no effect for certain types of windows (popups, tool-tips, etc.) If the window appears off screen or is too large to safely fit this flag will force realistic constraints on the window and bring it back into view. The padding around the edges of the window applied to it's content. The margin around the edges of the window that will be detected as places the user can grab to resize the window. true if this window will self handle any eventual DPI adjustments Optional tooltip for the close button, when HasCloseButton is true. Default constructor. Use SNew(SWindow) instead.

Default constructor. Protected because SWindows must always be used via TSharedPtr. Instead, use FSlateApplication::MakeWindow()

◆ ~SWindow()

SWindow::~SWindow ( )

Member Function Documentation

◆ AcceptsInput()

bool SWindow::AcceptsInput ( ) const

Returns: true if the window accepts input; false if the window is non-interactive

◆ ActivationPolicy()

EWindowActivationPolicy SWindow::ActivationPolicy ( ) const

Returns: the window activation policy used when showing the window

◆ AddChildWindow()

void SWindow::AddChildWindow ( const TSharedRef< SWindow > & ChildWindow )

Add ChildWindow as this window's child

◆ AddOverlaySlot()

SOverlay::FScopedWidgetSlotArguments SWindow::AddOverlaySlot ( const int32 ZOrder = INDEX_NONE )

Adds content to draw on top of the entire window

Parameters

InZOrder Z-order to use for this widget

Returns: The added overlay slot so that it can be configured and populated

◆ AddPopupLayerSlot()

SWindow::FScopedWidgetSlotArguments SWindow::AddPopupLayerSlot ( )

Return a new slot in the popup layer. Assumes that the window has a popup layer.

◆ Advanced_AsInvalidationRoot()

const FSlateInvalidationRoot * SWindow::Advanced_AsInvalidationRoot ( ) const

overridevirtual

Reimplemented from SWidget.

◆ Advanced_IsInvalidationRoot()

bool SWindow::Advanced_IsInvalidationRoot ( ) const

overridevirtual

Reimplemented from SWidget.

Reimplemented in SVirtualWindow.

◆ Advanced_IsWindow()

virtual bool SWindow::Advanced_IsWindow ( ) const

inlineoverridevirtual

Is this widget derivative of SWindow

Reimplemented from SWidget.

◆ AppearsInTaskbar()

bool SWindow::AppearsInTaskbar ( ) const

Returns: should this window show up in the taskbar

◆ BeginFullWindowOverlayTransition()

void SWindow::BeginFullWindowOverlayTransition ( )

Begins a transition from showing regular window content to overlay content During the transition we show both sets of content

◆ BringToFront()

void SWindow::BringToFront ( bool bForce = false )

Bring the window to the front

Parameters

bForce Forces the window to the top of the Z order, even if that means stealing focus from other windows In general do not pass force in. It can be useful for some window types, like game windows where not forcing it to the front would cause mouse capture and mouse lock to happen but without the window visible

◆ ComputeWindowSizeForContent()

UE::Slate::FDeprecateVector2DResult SWindow::ComputeWindowSizeForContent ( UE::Slate::FDeprecateVector2DParameter ContentSize )

static

Parameters

ContentSize The size of content that we want to accommodate

Returns: The size of the window necessary to accommodate the given content

◆ Construct()

void SWindow::Construct ( const FArguments & InArgs )

◆ ConstructWindowInternals()

void SWindow::ConstructWindowInternals ( )

protected

◆ CustomPrepass()

bool SWindow::CustomPrepass ( float LayoutScaleMultiplier )

overrideprotectedvirtual

Reimplemented from SWidget.

◆ DestroyWindowImmediately()

void SWindow::DestroyWindowImmediately ( )

Warning: use Request Destroy Window whenever possible! This method destroys the window immediately!

◆ DrawAttention()

void SWindow::DrawAttention ( const FWindowDrawAttentionParameters & Parameters )

Attempts to draw the user's attention to this window in whatever way is appropriate for the platform if this window is not the current active

Parameters

Parameters The parameters for bouncing. Depending on the platform, not all parameters may be supported.

◆ EnableWindow()

void SWindow::EnableWindow ( bool bEnable )

Enables or disables this window and all of its children

Parameters

bEnable true to enable this window and its children false to diable this window and its children

◆ EndFullWindowOverlayTransition()

void SWindow::EndFullWindowOverlayTransition ( )

Ends a transition from showing regular window content to overlay content When this is called content occluded by the full window overlay(if there is one) will be physically hidden

◆ FlashWindow()

void SWindow::FlashWindow ( )

Flashed the window, used for drawing attention to modal dialogs

◆ GetChildWindows() [1/2]

TArray< TSharedRef< SWindow > > & SWindow::GetChildWindows ( )

Returns: the list of this window's child windows

◆ GetChildWindows() [2/2]

const TArray< TSharedRef< SWindow > > & SWindow::GetChildWindows ( ) const

Returns: the list of this window's child windows

◆ GetClientRectInScreen()

FSlateRect SWindow::GetClientRectInScreen ( ) const

Returns: Rectangle of the window's usable client area in screen space.

◆ GetClientSizeInScreen()

UE::Slate::FDeprecateVector2DResult SWindow::GetClientSizeInScreen ( ) const

Returns: the size of the window's usable client area.

◆ GetClippingRectangleInWindow()

FSlateRect SWindow::GetClippingRectangleInWindow ( ) const

Returns: a clipping rectangle that represents this window in Window Space (i.e. always starts at 0,0)

◆ GetContent()

TSharedRef< SWidget > SWindow::GetContent ( )

Gets the widget content for this window

Returns: The widget content for this window

◆ GetCornerRadius()

int32 SWindow::GetCornerRadius ( )

Returns: Gets the radius of the corner rounding of the window.

◆ GetCurrentWindowZone()

EWindowZone::Type SWindow::GetCurrentWindowZone ( UE::Slate::FDeprecateVector2DParameter LocalMousePosition )

Gets the current Window Zone that mouse position is over.

◆ GetDesiredSizeDesktopPixels()

UE::Slate::FDeprecateVector2DResult SWindow::GetDesiredSizeDesktopPixels ( ) const

Returns: the desired size in desktop pixels

◆ GetDPIScaleFactor()

float SWindow::GetDPIScaleFactor ( ) const

Returns the DPI scale factor of the native window

◆ GetExpectedMaxHeight()

int32 SWindow::GetExpectedMaxHeight ( ) const

inline

Returns: Returns the configured expected maximum height of the window, or INDEX_NONE if not specified. Can be used to optimize performance for window size animation

◆ GetExpectedMaxWidth()

int32 SWindow::GetExpectedMaxWidth ( ) const

inline

Returns: Returns the configured expected maximum width of the window, or INDEX_NONE if not specified. Can be used to optimize performance for window size animation

◆ GetFullScreenInfo()

FSlateRect SWindow::GetFullScreenInfo ( ) const

Returns the rectangle of the screen the window is associated with

◆ GetHittestGrid()

FHittestGrid & SWindow::GetHittestGrid ( )

Access the hittest acceleration data structure for this window. The grid is filled out every time the window is painted.

See also: FHittestGrid for more details.

◆ GetInitialDesiredPositionInScreen()

UE::Slate::FDeprecateVector2DResult SWindow::GetInitialDesiredPositionInScreen ( ) const

Returns: The initially desired size of the slate window

◆ GetInitialDesiredSizeInScreen()

UE::Slate::FDeprecateVector2DResult SWindow::GetInitialDesiredSizeInScreen ( ) const

Returns: The initially desired screen position of the slate window

◆ GetIsHDR()

bool SWindow::GetIsHDR ( ) const

inline

◆ GetLocalToScreenTransform()

FSlateLayoutTransform SWindow::GetLocalToScreenTransform ( ) const

Returns: the transform from local space to screen space (desktop space).

◆ GetLocalToWindowTransform()

FSlateLayoutTransform SWindow::GetLocalToWindowTransform ( ) const

Returns: the transform from local space to window space, which is basically desktop space without the offset. Essentially contains the DPI scale.

◆ GetMorphTargetPosition()

UE::Slate::FDeprecateVector2DResult SWindow::GetMorphTargetPosition ( ) const

Returns: Returns the currently set morph target position

◆ GetMorphTargetShape()

FSlateRect SWindow::GetMorphTargetShape ( ) const

Returns: Returns the currently set morph target shape

◆ GetNativeWindow() [1/2]

TSharedPtr< FGenericWindow > SWindow::GetNativeWindow ( )

◆ GetNativeWindow() [2/2]

TSharedPtr< const FGenericWindow > SWindow::GetNativeWindow ( ) const

◆ GetNonMaximizedRectInScreen()

FSlateRect SWindow::GetNonMaximizedRectInScreen ( ) const

Returns: the rectangle of the window for its non-maximized state

◆ GetNonMaximizedWindowBorderSize()

FMargin SWindow::GetNonMaximizedWindowBorderSize ( ) const

Returns the margins used for the window border if it's not maximized

◆ GetOnWindowActivatedEvent()

FOnWindowActivatedEvent & SWindow::GetOnWindowActivatedEvent ( )

inline

Gets the multicast delegate executed when the window is activated

◆ GetOnWindowClosedEvent()

FOnWindowClosedEvent & SWindow::GetOnWindowClosedEvent ( )

inline

Gets the multicast delegate to execute right before the window is closed

◆ GetOnWindowDeactivatedEvent()

FOnWindowDeactivatedEvent & SWindow::GetOnWindowDeactivatedEvent ( )

inline

Gets the multicast delegate executed when the window is deactivated

◆ GetOpacity()

float SWindow::GetOpacity ( ) const

Returns: the window's current opacity

◆ GetParentWindow()

TSharedPtr< SWindow > SWindow::GetParentWindow ( ) const

Returns: the parent of this window; Invalid shared pointer if this window is not a child

◆ GetPositionInScreen()

UE::Slate::FDeprecateVector2DResult SWindow::GetPositionInScreen ( ) const

Returns: The position of the window in screen space

◆ GetRectInScreen()

FSlateRect SWindow::GetRectInScreen ( ) const

Returns: Rectangle that this window occupies in screen space

◆ GetRootWidget()

TSharedRef< SWidget > SWindow::GetRootWidget ( )

overrideprotectedvirtual

Returns: the children root widget of the Invalidation root.

Implements FSlateInvalidationRoot.

◆ GetSizeInScreen()

UE::Slate::FDeprecateVector2DResult SWindow::GetSizeInScreen ( ) const

Returns: the size of the window in screen pixels

◆ GetSizeLimits()

FWindowSizeLimits SWindow::GetSizeLimits ( ) const

Optional constraints on min and max sizes that this window can be.

◆ GetTitle()

FText SWindow::GetTitle ( ) const

inline

Grabs the current window title

Returns: The window's title

◆ GetTitleAlignment()

EHorizontalAlignment SWindow::GetTitleAlignment ( )

protectedvirtual

Returns the alignment type for the titlebar's title text.

◆ GetTitleBar()

TSharedPtr< IWindowTitleBar > SWindow::GetTitleBar ( ) const

inline

◆ GetTitleBarSize()

FOptionalSize SWindow::GetTitleBarSize ( ) const

Returns the size of the title bar as a Slate size parameter. Does not take into account application scale!

Returns: Title bar size

◆ GetTopmostAncestor()

TSharedPtr< SWindow > SWindow::GetTopmostAncestor ( )

Look up the parent chain until we find the top-level window that owns this window

◆ GetTransparencySupport()

EWindowTransparency SWindow::GetTransparencySupport ( ) const

Returns: the level of transparency supported by this window

◆ GetType()

EWindowType SWindow::GetType ( ) const

inline

Grabs the window type

Returns: The window's type

◆ GetViewport()

TSharedPtr< ISlateViewport > SWindow::GetViewport ( )

inline

◆ GetViewportScaleUIOverride()

float SWindow::GetViewportScaleUIOverride ( ) const

inline

◆ GetViewportSize()

UE::Slate::FDeprecateVector2DResult SWindow::GetViewportSize ( ) const

inline

Returns the viewport size, taking into consideration if the window size should drive the viewport size

◆ GetWidgetFocusedOnDeactivate()

TWeakPtr< SWidget > SWindow::GetWidgetFocusedOnDeactivate ( )

inline

Returns widget last focused on deactivate

◆ GetWindowBorderSize()

FMargin SWindow::GetWindowBorderSize ( bool bIncTitleBar = false ) const

Returns the margins used for the window border. This varies based on whether it's maximized or not.

◆ GetWindowCloseButtonToolTipText()

TAttribute< FText > SWindow::GetWindowCloseButtonToolTipText ( ) const

Return the tooltip text that should be used for the window's Close button.

◆ GetWindowGeometryInScreen()

FGeometry SWindow::GetWindowGeometryInScreen ( ) const

Get the Geometry that describes this window. Windows in Slate are unique in that they know their own geometry.

◆ GetWindowGeometryInWindow()

FGeometry SWindow::GetWindowGeometryInWindow ( ) const

Returns: The geometry of the window in window space (i.e. position and AbsolutePosition are 0)

◆ GetWindowMode()

EWindowMode::Type SWindow::GetWindowMode ( ) const

inline

Returns: The current window mode (fullscreen, windowed, etc)

◆ GetWindowSizeFromClientSize()

UE::Slate::FDeprecateVector2DResult SWindow::GetWindowSizeFromClientSize	(	UE::Slate::FDeprecateVector2DParameter	InClientSize,
		TOptional< float >	DPIScale = `TOptional<float>()`
	)

For a given client size, calculate the window size required to accommodate any potential non-OS borders and title bars

Parameters

InClientSize	Client size with DPI scaling already applied
DPIScale	Scale that will be applied for border and title. When not supplied detects DPIScale using native or initial position.

◆ GetWindowVisibility()

EVisibility SWindow::GetWindowVisibility ( ) const

Windows that are not hittestable should not show up in the hittest grid.

◆ HACK_ForceToFront()

void SWindow::HACK_ForceToFront ( )

@hack Force a window to front even if a different application is in front.

◆ HasActiveChildren()

bool SWindow::HasActiveChildren ( ) const

Are any of our child windows active?

◆ HasActiveParent()

bool SWindow::HasActiveParent ( ) const

Are any of our parent windows active?

◆ HasCloseBox()

bool SWindow::HasCloseBox ( ) const

Returns: true if this window has a close button/box on the titlebar area

◆ HasFullWindowOverlayContent()

bool SWindow::HasFullWindowOverlayContent ( ) const

Checks to see if there is content assigned as a full window overlay

Returns: True if there is an overlay widget assigned

◆ HasMaximizeBox()

bool SWindow::HasMaximizeBox ( ) const

Returns: true if this window has a maximize button/box on the titlebar area

◆ HasMinimizeBox()

bool SWindow::HasMinimizeBox ( ) const

Returns: true if this window has a minimize button/box on the titlebar area

◆ HasOSWindowBorder()

bool SWindow::HasOSWindowBorder ( ) const

inline

Returns: true if the window is using the os window border instead of a slate created one

◆ HasOverlay()

bool SWindow::HasOverlay ( ) const

Check whether we have a full window overlay, used to draw content over the entire window.

Returns: true if the window has an overlay

◆ HasSizingFrame()

bool SWindow::HasSizingFrame ( ) const

Returns: true if this is a user-sized window with a thick edge

◆ HideWindow()

void SWindow::HideWindow ( )

Make the window invisible

◆ InitialMaximize()

void SWindow::InitialMaximize ( )

Maximize the window if bInitiallyMaximized is set

◆ InitialMinimize()

void SWindow::InitialMinimize ( )

Maximize the window if bInitiallyMinimized is set

◆ IsActive()

bool SWindow::IsActive ( ) const

Is this window active?

Are any of our child windows active?

◆ IsAutosized()

bool SWindow::IsAutosized ( ) const

Returns: true if the window is sized by the windows content

◆ IsDescendantOf()

bool SWindow::IsDescendantOf ( const TSharedPtr< SWindow > & ParentWindow ) const

Returns whether or not this window is a descendant of the specfied parent window

Parameters

ParentWindow The window to check

Returns: true if the window is a child of ParentWindow, false otherwise.

◆ IsDrawingEnabled()

bool SWindow::IsDrawingEnabled ( ) const

inline

◆ IsFocusedInitially()

bool SWindow::IsFocusedInitially ( ) const

inline

Returns: true if this window will be focused when it is first shown

◆ IsManualManageDPIChanges()

bool SWindow::IsManualManageDPIChanges ( ) const

inline

◆ IsMirrorWindow()

bool SWindow::IsMirrorWindow ( )

inline

◆ IsModalWindow()

bool SWindow::IsModalWindow ( )

inline

◆ IsMorphing()

bool SWindow::IsMorphing ( ) const

Returns: Returns true if the window is currently morphing to a new position, shape and/or opacity

◆ IsMorphingSize()

bool SWindow::IsMorphingSize ( ) const

Returns: Returns true if the window is currently morphing and is morphing by size

◆ IsRegularWindow()

bool SWindow::IsRegularWindow ( ) const

Returns: true if this is a vanilla window, or one being used for some special purpose: e.g. tooltip or menu

◆ IsScreenspaceMouseWithin()

bool SWindow::IsScreenspaceMouseWithin ( UE::Slate::FDeprecateVector2DParameter ScreenspaceMouseCoordinate ) const

Returns: true if mouse coordinates is within this window

◆ IsTopmostWindow()

bool SWindow::IsTopmostWindow ( ) const

Returns: true if the window should be on top of all other windows; false otherwise

◆ IsUserSized()

bool SWindow::IsUserSized ( ) const

Returns: true if the user decides the size of the window; true if the user decides the size of the window; false if the content determines the size of the window

◆ IsViewportSizeDrivenByWindow()

bool SWindow::IsViewportSizeDrivenByWindow ( ) const

inline

Returns whether or not the viewport and window size should be linked together. If false, the two can be independent in cases where it is needed (e.g. mirror mode window drawing)

◆ IsVirtualWindow()

bool SWindow::IsVirtualWindow ( ) const

inline

◆ IsVisible()

bool SWindow::IsVisible ( ) const

Returns: true if the window is visible, false otherwise

◆ IsWindowMaximized()

bool SWindow::IsWindowMaximized ( ) const

Returns: true if the window is maximized, false otherwise

◆ IsWindowMinimized()

bool SWindow::IsWindowMinimized ( ) const

Returns: true of the window is minimized (iconic), false otherwise

◆ MakeCursorDecorator()

TSharedRef< SWindow > SWindow::MakeCursorDecorator ( )

static

Make cursor decorator window

Returns: The new SWindow

◆ MakeNotificationWindow()

TSharedRef< SWindow > SWindow::MakeNotificationWindow ( )

static

Make a notification window

Returns: The new SWindow

◆ MakeStyledCursorDecorator()

TSharedRef< SWindow > SWindow::MakeStyledCursorDecorator ( const FWindowStyle & InStyle )

static

Make cursor decorator window with a non-default style

Parameters

InStyle The style to use for the cursor decorator

Returns: The new SWindow

◆ MakeToolTipWindow()

TSharedRef< SWindow > SWindow::MakeToolTipWindow ( )

static

Make a tool tip window

Returns: The new SWindow

◆ MakeWindowTitleBar()

TSharedRef< SWidget > SWindow::MakeWindowTitleBar	(	const TSharedRef< SWindow > &	Window,
		const TSharedPtr< SWidget > &	CenterContent,
		EHorizontalAlignment	CenterContentAlignment
	)

protectedvirtual

Returns swindow title bar widgets.

◆ Maximize()

void SWindow::Maximize ( )

Windows functions

◆ Minimize()

void SWindow::Minimize ( )

◆ MorphToPosition()

void SWindow::MorphToPosition	(	const FCurveSequence &	Sequence,
		const float	TargetOpacity,
		const UE::Slate::FDeprecateVector2DParameter &	TargetPosition
	)

Animate the window to TargetOpacity and TargetPosition over a short period of time

◆ MorphToShape()

void SWindow::MorphToShape	(	const FCurveSequence &	Sequence,
		const float	TargetOpacity,
		const FSlateRect &	TargetShape
	)

Animate the window to TargetOpacity and TargetShape over a short period of time

◆ MoveWindowTo()

void SWindow::MoveWindowTo ( UE::Slate::FDeprecateVector2DParameter NewPosition )

Relocate the window to a screenspace position specified by NewPosition

◆ NotifyWindowBeingDestroyed()

void SWindow::NotifyWindowBeingDestroyed ( )

Calls the OnWindowClosed delegate when this window is about to be closed

Calls OnWindowClosed delegate and WindowClosedEvent when this window is about to be closed

◆ OnCursorQuery()

FCursorReply SWindow::OnCursorQuery	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	CursorEvent
	)		const

overridevirtual

The system asks each widget under the mouse to provide a cursor. This event is bubbled.

Returns: FCursorReply::Unhandled() if the event is not handled; return FCursorReply::Cursor() otherwise.

Reimplemented from SWidget.

◆ OnIsActiveChanged()

bool SWindow::OnIsActiveChanged ( const FWindowActivateEvent & ActivateEvent )

virtual

The system will call this method to notify the window that it has been places in the foreground or background.

◆ OnVisualizePopup()

TSharedPtr< FPopupLayer > SWindow::OnVisualizePopup ( const TSharedRef< SWidget > & PopupContent )

overridevirtual

Visualize a new pop-up if possible. If it's not possible for this widget to host the pop-up content you'll get back an invalid pointer to the layer. The returned FPopupLayer allows you to remove the pop-up when you're done with it

Parameters

PopupContent The widget to try and host overlaid on top of the widget.

Returns: a valid FPopupLayer if this widget supported hosting it. You can call Remove() on this to destroy the pop-up.

Reimplemented from SWidget.

◆ PaintSlowPath()

int32 SWindow::PaintSlowPath ( const FSlateInvalidationContext & InvalidationContext )

overrideprotectedvirtual

Implements FSlateInvalidationRoot.

◆ PaintWindow()

int32 SWindow::PaintWindow	(	double	CurrentTime,
		float	DeltaTime,
		FSlateWindowElementList &	OutDrawElements,
		const FWidgetStyle &	InWidgetStyle,
		bool	bParentEnabled
	)

Paint the window and all of its contents. Not the same as Paint().

◆ ProcessWindowInvalidation()

void SWindow::ProcessWindowInvalidation ( )

Process the invalidation of the widget contained by the window in GlobalInvalidation.

◆ RemoveDescendantWindow()

bool SWindow::RemoveDescendantWindow ( const TSharedRef< SWindow > & DescendantToRemove )

Remove DescendantToRemove from this window's children or their children.

◆ RemoveOverlaySlot()

bool SWindow::RemoveOverlaySlot ( const TSharedRef< SWidget > & InContent )

Removes a widget that is being drawn over the entire window

Parameters

InContent The widget to remove

Returns: true if successful

◆ RemovePopupLayerSlot()

void SWindow::RemovePopupLayerSlot ( const TSharedRef< SWidget > & WidgetToRemove )

Counterpart to AddPopupLayerSlot

◆ RequestDestroyWindow()

void SWindow::RequestDestroyWindow ( )

Request that this window be destroyed. The window is not destroyed immediately. Instead it is placed in a queue for destruction on next Tick

◆ ResetViewportScaleUIOverride()

void SWindow::ResetViewportScaleUIOverride ( )

inline

◆ ReshapeWindow() [1/2]

void SWindow::ReshapeWindow ( const FSlateRect & InNewShape )

◆ ReshapeWindow() [2/2]

void SWindow::ReshapeWindow	(	UE::Slate::FDeprecateVector2DParameter	NewPosition,
		UE::Slate::FDeprecateVector2DParameter	NewSize
	)

Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize

◆ Resize()

void SWindow::Resize ( UE::Slate::FDeprecateVector2DParameter NewClientSize )

Resize the window to be dpi scaled NewClientSize immediately

Parameters

NewClientSize Client size with DPI scaling already applied that does not include border or title bars.

◆ Restore()

void SWindow::Restore ( )

◆ SetAcceptsInput()

void SWindow::SetAcceptsInput ( bool bEnabled )

inline

If true the window will accept input if window type supports it

◆ SetAllowFastUpdate()

void SWindow::SetAllowFastUpdate ( bool bInAllowFastUpdate )

◆ SetAsModalWindow()

void SWindow::SetAsModalWindow ( )

inline

Set modal window related flags - called by Slate app code during FSlateApplication::AddModalWindow()

◆ SetCachedScreenPosition()

void SWindow::SetCachedScreenPosition ( UE::Slate::FDeprecateVector2DParameter NewPosition )

Sets the actual screen position of the window. THIS SHOULD ONLY BE CALLED BY THE OS

◆ SetCachedSize()

void SWindow::SetCachedSize ( UE::Slate::FDeprecateVector2DParameter NewSize )

Sets the actual size of the window. THIS SHOULD ONLY BE CALLED BY THE OS

◆ SetContent()

void SWindow::SetContent ( TSharedRef< SWidget > InContent )

Sets the widget content for this window

Parameters

InContent The widget to use as content for this window

◆ SetDPIScaleFactor()

void SWindow::SetDPIScaleFactor ( const float Factor )

Overrides the DPI scale factor of the native window

◆ SetFullWindowOverlayContent()

void SWindow::SetFullWindowOverlayContent ( TSharedPtr< SWidget > InContent )

Sets a widget to use as a full window overlay, or clears an existing widget if set. When set, this widget will be drawn on top of all other window content.

Parameters

InContent The widget to use for full window overlay content, or nullptr for no overlay

◆ SetIndependentViewportSize()

void SWindow::SetIndependentViewportSize ( const UE::Slate::FDeprecateVector2DParameter & VP )

inline

Sets the viewport size independently of the window size, if non-zero.

◆ SetIsHDR()

void SWindow::SetIsHDR ( bool bHDR )

inline

◆ SetManualManageDPIChanges()

void SWindow::SetManualManageDPIChanges ( const bool bManualDPI )

Will inform the native window that we need to handle any DPI changes from within the application

◆ SetMirrorWindow()

void SWindow::SetMirrorWindow ( bool bSetMirrorWindow )

inline

Set mirror window flag

◆ SetNativeWindow()

void SWindow::SetNativeWindow ( TSharedRef< FGenericWindow > InNativeWindow )

Sets the native OS window associated with this SWindow

Parameters

InNativeWindow The native window

◆ SetNativeWindowButtonsVisibility()

void SWindow::SetNativeWindowButtonsVisibility ( bool bVisible )

Shows or hides native window buttons on platforms that use them

◆ SetOnWindowClosed()

void SWindow::SetOnWindowClosed ( const FOnWindowClosed & InDelegate )

Sets the delegate to execute right before the window is closed

◆ SetOnWindowMoved()

void SWindow::SetOnWindowMoved ( const FOnWindowMoved & InDelegate )

Sets the delegate to execute right after the window has been moved

◆ SetOnWorldSwitchHack()

void SWindow::SetOnWorldSwitchHack ( FOnSwitchWorldHack & InOnWorldSwitchHack )

Sets the delegate to call when switching worlds in before ticking,drawing, or sending messages to widgets in this window

◆ SetOpacity()

void SWindow::SetOpacity ( const float InOpacity )

Sets the opacity of this window

Parameters

InOpacity The new window opacity represented as a floating point scalar

◆ SetRequestDestroyWindowOverride()

void SWindow::SetRequestDestroyWindowOverride ( const FRequestDestroyWindowOverride & InDelegate )

Sets the delegate to override RequestDestroyWindow

◆ SetSizeLimits()

void SWindow::SetSizeLimits ( const FWindowSizeLimits & InSizeLimits )

Set optional constraints on min and max sizes that this window can be.

◆ SetSizingRule()

void SWindow::SetSizingRule ( ESizingRule InSizingRule )

Should this window automatically derive its size based on its content or be user-drive?

◆ SetTitle()

void SWindow::SetTitle ( const FText & InTitle )

inline

Sets the current window title

Parameters

InTitle The new title of the window

◆ SetTitleBar()

void SWindow::SetTitleBar ( const TSharedPtr< IWindowTitleBar > InTitleBar )

inline

◆ SetViewport()

void SWindow::SetViewport ( TSharedRef< ISlateViewport > ViewportRef )

inline

◆ SetViewportScaleUIOverride()

void SWindow::SetViewportScaleUIOverride ( float InViewportScaleUIOverride )

inline

◆ SetViewportSizeDrivenByWindow()

void SWindow::SetViewportSizeDrivenByWindow ( bool bDrivenByWindow )

inline

Sets whether or not the viewport size should be driven by the window's size. If true, the two will be the same. If false, an independent viewport size can be specified with SetIndependentViewportSize

◆ SetWidgetToFocusOnActivate()

void SWindow::SetWidgetToFocusOnActivate ( TSharedPtr< SWidget > InWidget )

inline

Sets a widget that should become focused when this window is next activated

Parameters

InWidget The widget to set focus to when this window is activated

◆ SetWindowBackground()

void SWindow::SetWindowBackground ( const FSlateBrush * InWindowBackground )

protected

◆ SetWindowMode()

void SWindow::SetWindowMode ( EWindowMode::Type NewWindowMode )

Toggle window between window modes (fullscreen, windowed, etc)

Toggle window between fullscreen and normal mode

◆ ShouldPreserveAspectRatio()

bool SWindow::ShouldPreserveAspectRatio ( ) const

inline

◆ ShowWindow()

void SWindow::ShowWindow ( )

Make the window visible

◆ SizeWillChangeOften()

bool SWindow::SizeWillChangeOften ( ) const

inline

Returns: True if we expect the window size to change frequently. See description of bSizeWillChangeOften member variable.

◆ SLATE_BEGIN_ARGS()

SWindow::SLATE_BEGIN_ARGS ( SWindow )

inline

◆ StartMorph()

void SWindow::StartMorph ( )

protected

Kick off a morph to whatever the target shape happens to be.

◆ SupportsKeyboardFocus()

bool SWindow::SupportsKeyboardFocus ( ) const

overridevirtual

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

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

Reimplemented in SVirtualWindow.

◆ SwitchWorlds()

int32 SWindow::SwitchWorlds ( int32 WorldId ) const

Hack to switch worlds

Parameters

WorldId	User ID for a world that should be restored or -1 if no restore
The	ID of the world restore later

◆ Tick()

void SWindow::Tick	(	const FGeometry &	AllottedGeometry,
		const double	InCurrentTime,
		const float	InDeltaTime
	)

overridevirtual

Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

Parameters

AllottedGeometry	The space allotted for this widget
InCurrentTime	Current absolute real time
InDeltaTime	Real time passed since last tick

Reimplemented from SWidget.

◆ ToString()

FString SWindow::ToString ( ) const

overridevirtual

Returns: A String representation of the widget

Reimplemented from SWidget.

◆ TriggerPlayMorphSequence()

EActiveTimerReturnType SWindow::TriggerPlayMorphSequence	(	double	InCurrentTime,
		float	InDeltaTime
	)

protected

One-off active timer to trigger a the morph sequence to play

◆ UnsetViewport()

void SWindow::UnsetViewport ( TSharedRef< ISlateViewport > ViewportRef )

inline

◆ UpdateMorphTargetPosition()

void SWindow::UpdateMorphTargetPosition ( const UE::Slate::FDeprecateVector2DParameter & TargetPosition )

Set a new morph position and force the morph to run for at least one frame in order to reach that target

◆ UpdateMorphTargetShape()

void SWindow::UpdateMorphTargetShape ( const FSlateRect & TargetShape )

Set a new morph shape and force the morph to run for at least one frame in order to reach that target

◆ UpdateWindowContentVisibility()

void SWindow::UpdateWindowContentVisibility ( )

protected

Member Data Documentation

◆ AutoCenterRule

EAutoCenter SWindow::AutoCenterRule

protected

How to auto center the window

◆ bAcceptsInput

bool SWindow::bAcceptsInput

protected

If true, window will accept user inputs

◆ bAllowFastUpdate

bool SWindow::bAllowFastUpdate

protected

True if this window allows global invalidation of its contents

◆ bCreateTitleBar

bool SWindow::bCreateTitleBar

protected

True if this window has a title bar

◆ bDragAnywhere

bool SWindow::bDragAnywhere

protected

When true, grabbing anywhere on the window will allow it to be dragged.

◆ bFocusWhenFirstShown

bool SWindow::bFocusWhenFirstShown

protected

Focus this window immediately as it is shown

◆ bHasCloseButton

bool SWindow::bHasCloseButton

protected

True if this window displays an enabled close button on the toolbar area

◆ bHasEverBeenShown

bool SWindow::bHasEverBeenShown

protected

True if this window has been shown yet

◆ bHasMaximizeButton

bool SWindow::bHasMaximizeButton

protected

True if this window displays an enabled maximize button on the toolbar area

◆ bHasMinimizeButton

bool SWindow::bHasMinimizeButton

protected

True if this window displays an enabled minimize button on the toolbar area

◆ bHasOSWindowBorder

bool SWindow::bHasOSWindowBorder

protected

True if this window displays the os window border instead of drawing one in slate

◆ bHasSizingFrame

bool SWindow::bHasSizingFrame

protected

True if this window displays thick edge that can be used to resize the window

◆ bInitiallyMaximized

bool SWindow::bInitiallyMaximized

protected

true if this window is maximized when its created

◆ bInitiallyMinimized

bool SWindow::bInitiallyMinimized

protected

true if this window is minimized when its created

◆ bIsDrawingEnabled

bool SWindow::bIsDrawingEnabled

protected

◆ bIsHDR

bool SWindow::bIsHDR

protected

True if the window is being displayed on a HDR capable monitor

◆ bIsMirrorWindow

bool SWindow::bIsMirrorWindow

protected

True if the window is a mirror window for HMD content

◆ bIsModalWindow

bool SWindow::bIsModalWindow

protected

True if the window is modal

◆ bIsPopupWindow

bool SWindow::bIsPopupWindow

protected

True if this is a pop up window

◆ bIsTopmostWindow

bool SWindow::bIsTopmostWindow

protected

True if this is a topmost window

◆ bManualManageDPI

bool SWindow::bManualManageDPI

protected

◆ bShouldPreserveAspectRatio

bool SWindow::bShouldPreserveAspectRatio

protected

True if the window should preserve its aspect ratio when resized by user

◆ bShouldShowWindowContentDuringOverlay

bool SWindow::bShouldShowWindowContentDuringOverlay

protected

Whether or not we should show content of the window which could be occluded by full screen window content. This is used to hide content when there is a full screen overlay occluding it

◆ bSizeWillChangeOften

bool SWindow::bSizeWillChangeOften

protected

True if we expect the size of this window to change often, such as if its animated, or if it recycled for tool-tips, and we'd like to avoid costly GPU buffer resizes when that happens. Enabling this may incur memory overhead or other platform-specific side effects

◆ bVirtualWindow

bool SWindow::bVirtualWindow

protected

True if this window is virtual and not directly rendered by slate application or the OS.

◆ ChildWindows

TArray< TSharedRef<SWindow> > SWindow::ChildWindows

protected

Child windows of this window

◆ CloseButtonToolTipText

TAttribute<FText> SWindow::CloseButtonToolTipText

protected

Tooltip text displayed over the window's Close button (on Windows only).

◆ ContentSlot

SVerticalBox::FSlot* SWindow::ContentSlot

protected

◆ ExpectedMaxHeight

int32 SWindow::ExpectedMaxHeight

protected

The expected maximum height of the window. May be used for performance optimization when bSizeWillChangeOften is set.

◆ ExpectedMaxWidth

int32 SWindow::ExpectedMaxWidth

protected

The expected maximum width of the window. May be used for performance optimization when bSizeWillChangeOften is set.

◆ FocusUserIndex

int32 SWindow::FocusUserIndex

protected

The index of the user that should focus this window on activation. INDEX_NONE for all users

◆ FullWindowOverlayWidget

TSharedPtr<SWidget> SWindow::FullWindowOverlayWidget

protected

Full window overlay widget

◆ HittestGrid

TUniquePtr<FHittestGrid> SWindow::HittestGrid

protected

Each window has its own hittest grid for accelerated widget picking.

◆ InitialDesiredScreenPosition

UE::Slate::FDeprecateVector2DResult SWindow::InitialDesiredScreenPosition

protected

Initial desired position of the window's content in screen space

◆ InitialDesiredSize

UE::Slate::FDeprecateVector2DResult SWindow::InitialDesiredSize

protected

Initial desired size of the window's content in screen space

◆ LayoutBorder

FMargin SWindow::LayoutBorder

protected

◆ Morpher

struct SWindow::FMorpher SWindow::Morpher

protected

◆ MoveResizeRect

FSlateRect SWindow::MoveResizeRect

◆ MoveResizeStart

UE::Slate::FDeprecateVector2DResult SWindow::MoveResizeStart

◆ MoveResizeZone

EWindowZone::Type SWindow::MoveResizeZone

Used to store the zone where the mouse down event occurred during move / drag

◆ NativeWindow

TSharedPtr<FGenericWindow> SWindow::NativeWindow

protected

The native window that is backing this Slate Window

◆ OnWindowActivated

FOnWindowActivated SWindow::OnWindowActivated

protected

Invoked when the window has been activated.

◆ OnWindowClosed

FOnWindowClosed SWindow::OnWindowClosed

protected

Invoked when the window is about to be closed.

◆ OnWindowDeactivated

FOnWindowDeactivated SWindow::OnWindowDeactivated

protected

Invoked when the window has been deactivated.

◆ OnWindowMoved

FOnWindowMoved SWindow::OnWindowMoved

protected

Invoked when the window is moved

◆ OnWorldSwitchHack

FOnSwitchWorldHack SWindow::OnWorldSwitchHack

protected

World switch delegate

◆ Opacity

float SWindow::Opacity

protected

Current opacity of the window

◆ ParentWindowPtr

TWeakPtr<SWindow> SWindow::ParentWindowPtr

protected

When not null, this window will always appear on top of the parent and be closed when the parent is closed.

◆ PopupLayer

TSharedPtr<class SPopupLayer> SWindow::PopupLayer

protected

This layer provides mechanism for tooltips, drag-drop decorators, and popups without creating a new window.

◆ PreFullscreenPosition

UE::Slate::FDeprecateVector2DResult SWindow::PreFullscreenPosition

protected

The position of the window before entering fullscreen

◆ RequestDestroyWindowOverride

FRequestDestroyWindowOverride SWindow::RequestDestroyWindowOverride

protected

Invoked when the window is requested to be destroyed.

◆ ScreenPosition

UE::Slate::FDeprecateVector2DResult SWindow::ScreenPosition

protected

Position of the window's content in screen space

◆ Size

UE::Slate::FDeprecateVector2DResult SWindow::Size

protected

Size of the window's content area in screen space

◆ SizeLimits

FWindowSizeLimits SWindow::SizeLimits

protected

Min and Max values for Width and Height; all optional.

◆ SizingRule

ESizingRule SWindow::SizingRule

protected

How to size the window

◆ Title

TAttribute<FText> SWindow::Title

protected

Title of the window, displayed in the title bar as well as potentially in the task bar (Windows platform)

◆ TitleArea

TSharedPtr<SWidget> SWindow::TitleArea

protected

◆ TitleBar

TSharedPtr<IWindowTitleBar> SWindow::TitleBar

protected

◆ TitleBarSize

float SWindow::TitleBarSize

protected

Size of this window's title bar. Can be zero. Set at construction and should not be changed afterwards.

◆ TransparencySupport

EWindowTransparency SWindow::TransparencySupport

protected

Transparency setting for this window

◆ Type

EWindowType SWindow::Type

protected

Type of the window

◆ UserResizeBorder

FMargin SWindow::UserResizeBorder

protected

◆ Viewport

TWeakPtr<ISlateViewport> SWindow::Viewport

protected

Pointer to the viewport registered with this window if any

◆ ViewportScaleUIOverride

float SWindow::ViewportScaleUIOverride

protected

Mix of aspect ratio + DPI + UI Zoom. Used in shaders / materials. Can be overriden by child widgets, is reset after draw every frame. Negative value indicates not used, in which case application level UI scale will be used.

◆ ViewportSize

UE::Slate::FDeprecateVector2DResult SWindow::ViewportSize

protected

Size of the viewport. If (0,0) then it is equal to Size

◆ WidgetFocusedOnDeactivate

TWeakPtr< SWidget > SWindow::WidgetFocusedOnDeactivate

protected

Widget that had keyboard focus when this window was last de-activated, if any. This is used to restore focus to a widget after the window regains focus.

◆ WidgetToFocusOnActivate

TWeakPtr< SWidget > SWindow::WidgetToFocusOnActivate

protected

Widget to transfer keyboard focus to when this window becomes active, if any. This is used to restore focus to a widget after a popup has been dismissed.

◆ WindowActivatedEvent

FOnWindowActivatedEvent SWindow::WindowActivatedEvent

protected

◆ WindowActivationPolicy

EWindowActivationPolicy SWindow::WindowActivationPolicy

protected

When should the window be activated upon being shown

◆ WindowClosedEvent

FOnWindowClosedEvent SWindow::WindowClosedEvent

protected

◆ WindowDeactivatedEvent

FOnWindowDeactivatedEvent SWindow::WindowDeactivatedEvent

protected

◆ WindowOverlay

TSharedPtr<SOverlay> SWindow::WindowOverlay

protected

Window overlay widget

◆ WindowZone

EWindowZone::Type SWindow::WindowZone

protected

Cached "zone" the cursor was over in the window the last time that someone called GetCurrentWindowZone()

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

Engine/Source/Runtime/SlateCore/Public/Widgets/SWindow.h
Engine/Source/Runtime/SlateCore/Private/Widgets/SWindow.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FScopedWidgetSlotArguments

Constructor & Destructor Documentation

◆ SWindow()

◆ ~SWindow()

Member Function Documentation

◆ AcceptsInput()

◆ ActivationPolicy()

◆ AddChildWindow()

◆ AddOverlaySlot()

◆ AddPopupLayerSlot()

◆ Advanced_AsInvalidationRoot()

◆ Advanced_IsInvalidationRoot()

◆ Advanced_IsWindow()

◆ AppearsInTaskbar()

◆ BeginFullWindowOverlayTransition()

◆ BringToFront()

◆ ComputeWindowSizeForContent()

◆ Construct()

◆ ConstructWindowInternals()

◆ CustomPrepass()

◆ DestroyWindowImmediately()

◆ DrawAttention()

◆ EnableWindow()

◆ EndFullWindowOverlayTransition()

◆ FlashWindow()

◆ GetChildWindows() [1/2]

◆ GetChildWindows() [2/2]

◆ GetClientRectInScreen()

◆ GetClientSizeInScreen()

◆ GetClippingRectangleInWindow()

◆ GetContent()

◆ GetCornerRadius()

◆ GetCurrentWindowZone()

◆ GetDesiredSizeDesktopPixels()

◆ GetDPIScaleFactor()

◆ GetExpectedMaxHeight()

◆ GetExpectedMaxWidth()

◆ GetFullScreenInfo()

◆ GetHittestGrid()

◆ GetInitialDesiredPositionInScreen()

◆ GetInitialDesiredSizeInScreen()

◆ GetIsHDR()

◆ GetLocalToScreenTransform()

◆ GetLocalToWindowTransform()

◆ GetMorphTargetPosition()

◆ GetMorphTargetShape()

◆ GetNativeWindow() [1/2]

◆ GetNativeWindow() [2/2]

◆ GetNonMaximizedRectInScreen()

◆ GetNonMaximizedWindowBorderSize()

◆ GetOnWindowActivatedEvent()

◆ GetOnWindowClosedEvent()

◆ GetOnWindowDeactivatedEvent()

◆ GetOpacity()

◆ GetParentWindow()

◆ GetPositionInScreen()

◆ GetRectInScreen()

◆ GetRootWidget()

◆ GetSizeInScreen()

◆ GetSizeLimits()

◆ GetTitle()

◆ GetTitleAlignment()

◆ GetTitleBar()

◆ GetTitleBarSize()

◆ GetTopmostAncestor()

◆ GetTransparencySupport()

◆ GetType()

◆ GetViewport()

◆ GetViewportScaleUIOverride()

◆ GetViewportSize()