Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Widgets > SWindow

Light Theme

Dark Theme

SWindow

[SWindow](API\Runtime\SlateCore\Widgets\SWindow) is a platform-agnostic representation of a top-level window.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

SCompoundWidget

FSlateInvalidationRoot

SWindow

	SCreateAnimationAssetDlg
	SCustomDialog
	SDlgPickAssetPath
	SDlgPickPath
	SLogWindow
	SSelectExportPathDialog
	SSelectFolderDlg
	SVirtualWindow

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Widgets/SWindow.h
Include	#include "Widgets/SWindow.h"

Syntax

class SWindow :
public SCompoundWidget,
public FSlateInvalidationRoot

Remarks

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

Variables

	Name	Description
EAutoCenter	AutoCenterRule	How to auto center the window
bool: 1	bAllowFastUpdate	True if this window allows global invalidation of its contents
bool: 1	bCreateTitleBar	True if this window has a title bar
bool	bDragAnywhere	When true, grabbing anywhere on the window will allow it to be dragged.
bool: 1	bFocusWhenFirstShown	Focus this window immediately as it is shown
bool: 1	bHasCloseButton	True if this window displays an enabled close button on the toolbar area
bool: 1	bHasEverBeenShown	True if this window has been shown yet
bool: 1	bHasMaximizeButton	True if this window displays an enabled maximize button on the toolbar area
bool: 1	bHasMinimizeButton	True if this window displays an enabled minimize button on the toolbar area
bool: 1	bHasOSWindowBorder	True if this window displays the os window border instead of drawing one in slate
bool: 1	bHasSizingFrame	True if this window displays thick edge that can be used to resize the window
bool: 1	bInitiallyMaximized	True if this window is maximized when its created
bool: 1	bInitiallyMinimized	True if this window is minimized when its created
bool	bIsDrawingEnabled	Whether or not drawing is enabled for this window.
bool: 1	bIsHDR	True if the window is being displayed on a HDR capable monitor
bool: 1	bIsMirrorWindow	True if the window is a mirror window for HMD content
bool: 1	bIsModalWindow	True if the window is modal
bool: 1	bIsPopupWindow	True if this is a pop up window
bool: 1	bIsTopmostWindow	True if this is a topmost window
bool: 1	bManualManageDPI
bool: 1	bShouldPreserveAspectRatio	True if the window should preserve its aspect ratio when resized by user
bool	bShouldShowWindowContentDuringOverlay	Whether or not we should show content of the window which could be occluded by full screen window content.
bool: 1	bSizeWillChangeOften	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.
bool: 1	bVirtualWindow	True if this window is virtual and not directly rendered by slate application or the OS.
TArray< TShared...	ChildWindows	Child windows of this window
SVerticalBox::F...	ContentSlot
int32	ExpectedMaxHeight	The expected maximum height of the window.
int32	ExpectedMaxWidth	The expected maximum width of the window.
TSharedPtr< SWi...	FullWindowOverlayWidget	Full window overlay widget
TUniquePtr< FHi...	HittestGrid	Each window has its own hittest grid for accelerated widget picking.
FVector2D	InitialDesiredScreenPosition	Initial desired position of the window's content in screen space
FVector2D	InitialDesiredSize	Initial desired size of the window's content in screen space
FMargin	LayoutBorder	The padding for between the edges of the window and it's content.
SWindow::FMorph...	Morpher
FSlateRect	MoveResizeRect
FVector2D	MoveResizeStart
EWindowZone::Ty...	MoveResizeZone	Used to store the zone where the mouse down event occurred during move / drag
TSharedPtr< FGe...	NativeWindow	The native window that is backing this Slate Window
FOnWindowActiva...	OnWindowActivated	Invoked when the window has been activated.
FOnWindowClosed	OnWindowClosed	Invoked when the window is about to be closed.
FOnWindowDeacti...	OnWindowDeactivated	Invoked when the window has been deactivated.
FOnWindowMoved	OnWindowMoved	Invoked when the window is moved
FOnSwitchWorldH...	OnWorldSwitchHack	World switch delegate
float	Opacity	Current opacity of the window
TWeakPtr< SWind...	ParentWindowPtr	When not null, this window will always appear on top of the parent and be closed when the parent is closed.
TSharedPtr< cla...	PopupLayer	This layer provides mechanism for tooltips, drag-drop decorators, and popups without creating a new window.
FVector2D	PreFullscreenPosition	The position of the window before entering fullscreen
FRequestDestroy...	RequestDestroyWindowOverride	Invoked when the window is requested to be destroyed.
FVector2D	ScreenPosition	Position of the window's content in screen space
FVector2D	Size	Size of the window's content area in screen space
FWindowSizeLimi...	SizeLimits	Min and Max values for Width and Height; all optional.
ESizingRule	SizingRule	How to size the window
TAttribute< FTe...	Title	Title of the window, displayed in the title bar as well as potentially in the task bar (Windows platform)
TSharedPtr< SWi...	TitleArea
TSharedPtr< IWi...	TitleBar	The window title bar.
float	TitleBarSize	Size of this window's title bar.
EWindowTranspar...	TransparencySupport	Transparency setting for this window
EWindowType	Type	Type of the window
FMargin	UserResizeBorder	The margin around the edges of the window that will be detected as places the user can grab to resize the window.
TWeakPtr< ISlat...	Viewport	Pointer to the viewport registered with this window if any
FVector2D	ViewportSize	Size of the viewport. If (0,0) then it is equal to Size
TWeakPtr< SWidg...	WidgetFocusedOnDeactivate	Widget that had keyboard focus when this window was last de-activated, if any.
TWeakPtr< SWidg...	WidgetToFocusOnActivate	Widget to transfer keyboard focus to when this window becomes active, if any.
FOnWindowActiva...	WindowActivatedEvent
EWindowActivati...	WindowActivationPolicy	When should the window be activated upon being shown
FOnWindowClosed...	WindowClosedEvent
FOnWindowDeacti...	WindowDeactivatedEvent
TSharedPtr< SOv...	WindowOverlay	Window overlay widget
EWindowZone::Ty...	WindowZone	Cached "zone" the cursor was over in the window the last time that someone called GetCurrentWindowZone()

Constructors

	Name	Description
	SWindow()	Default constructor.

Destructors

	Name	Description
	~SWindow()

Functions

	Name	Description
bool	AcceptsInput()
EWindowActiv...	ActivationPolicy()
void	AddChildWindow ( const TSharedRef< SWindow >& Child... )	Add ChildWindow as this window's child
SOverlay::FS...	AddOverlaySlot ( const int32 ZOrder )	Adds content to draw on top of the entire window
FScopedWidge...	AddPopupLayerSlot()	Return a new slot in the popup layer. Assumes that the window has a popup layer.
bool	AppearsInTaskbar()
void	BeginFullWindowOverlayTransition()	Begins a transition from showing regular window content to overlay content During the transition we show both sets of content
void	BringToFront ( bool bForce )	Bring the window to the front
FVector2D	ComputeWindowSizeForContent ( FVector2D ContentSize )
void	Construct ( const FArguments& InArgs )
void	ConstructWindowInternals()
void	DestroyWindowImmediately()	Warning: use Request Destroy Window whenever possible! This method destroys the window immediately!
void	DrawAttention ( const FWindowDrawAttentionParameter... )	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
void	EnableWindow ( bool bEnable )	Enables or disables this window and all of its children
void	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
void	FlashWindow()	Flashed the window, used for drawing attention to modal dialogs
TArray< TSha...	GetChildWindows()
const TArray...	GetChildWindows()
FSlateRect	GetClientRectInScreen()
FVector2D	GetClientSizeInScreen()
FSlateRect	GetClippingRectangleInWindow()
TSharedRef< ...	GetContent()	Gets the widget content for this window
int32	GetCornerRadius()
EWindowZone:...	GetCurrentWindowZone ( FVector2D LocalMousePosition )	Gets the current Window Zone that mouse position is over.
FVector2D	GetDesiredSizeDesktopPixels()
float	GetDPIScaleFactor()	Returns the DPI scale factor of the native window
int32	GetExpectedMaxHeight()
int32	GetExpectedMaxWidth()
FSlateRect	GetFullScreenInfo()	Returns the rectangle of the screen the window is associated with
FHittestGrid...	GetHittestGrid()	Access the hittest acceleration data structure for this window.
FVector2D	GetInitialDesiredPositionInScreen()
FVector2D	GetInitialDesiredSizeInScreen()
bool	GetIsHDR()
FSlateLayout...	GetLocalToScreenTransform()
FSlateLayout...	GetLocalToWindowTransform()
FVector2D	GetMorphTargetPosition()
FSlateRect	GetMorphTargetShape()
TSharedPtr< ...	GetNativeWindow()
TSharedPtr< ...	GetNativeWindow()
FSlateRect	GetNonMaximizedRectInScreen()
FMargin	GetNonMaximizedWindowBorderSize()	Returns the margins used for the window border if it's not maximized
FOnWindowAct...	GetOnWindowActivatedEvent()	Gets the multicast delegate executed when the window is deactivated
FOnWindowClo...	GetOnWindowClosedEvent()	Gets the multicast delegate to execute right before the window is closed
FOnWindowDea...	GetOnWindowDeactivatedEvent()	Gets the multicast delegate executed when the window is deactivated
float	GetOpacity()
TSharedPtr< ...	GetParentWindow()
FVector2D	GetPositionInScreen()
FSlateRect	GetRectInScreen()
FVector2D	GetSizeInScreen()
FWindowSizeL...	GetSizeLimits()	Optional constraints on min and max sizes that this window can be.
FText	GetTitle()	Grabs the current window title
EHorizontalA...	GetTitleAlignment()	Returns the alignment type for the titlebar's title text.
TSharedPtr< ...	GetTitleBar()
FOptionalSiz...	GetTitleBarSize()	Returns the size of the title bar as a Slate size parameter.
TSharedPtr< ...	GetTopmostAncestor()	Look up the parent chain until we find the top-level window that owns this window
EWindowTrans...	GetTransparencySupport()
EWindowType	GetType()	Grabs the window type
TSharedPtr< ...	GetViewport()
FVector2D	GetViewportSize()	Returns the viewport size, taking into consideration if the window size should drive the viewport size
TWeakPtr< SW...	GetWidgetFocusedOnDeactivate()	Returns widget last focused on deactivate
FMargin	GetWindowBorderSize ( bool bIncTitleBar )	Returns the margins used for the window border. This varies based on whether it's maximized or not.
FGeometry	GetWindowGeometryInScreen()	Get the Geometry that describes this window.
FGeometry	GetWindowGeometryInWindow()
EWindowMode:...	GetWindowMode()
FVector2D	GetWindowSizeFromClientSize ( FVector2D InClientSize, TOptional< float > DPIScale )	For a given client size, calculate the window size required to accommodate any potential non-OS borders and title bars
EVisibility	GetWindowVisibility()	Windows that are not hittestable should not show up in the hittest grid.
void	HACK_ForceToFront()	Force a window to front even if a different application is in front.
bool	HasActiveChildren()	Are any of our child windows active?
bool	HasActiveParent()	Are any of our parent windows active?
bool	HasCloseBox()
bool	HasFullWindowOverlayContent()	Checks to see if there is content assigned as a full window overlay
bool	HasMaximizeBox()
bool	HasMinimizeBox()
bool	HasOSWindowBorder()
bool	HasOverlay()	Check whether we have a full window overlay, used to draw content over the entire window.
bool	HasSizingFrame()
void	HideWindow()	Make the window invisible
void	InitialMaximize()	Maximize the window if bInitiallyMaximized is set
void	InitialMinimize()	Maximize the window if bInitiallyMinimized is set
bool	IsActive()	Is this window active? Are any of our child windows active?
bool	IsAutosized()
bool	IsDescendantOf ( const TSharedPtr< SWindow >& Paren... )	Returns whether or not this window is a descendant of the specfied parent window
bool	IsDrawingEnabled()
bool	IsFocusedInitially()
bool	IsManualManageDPIChanges()
bool	IsMirrorWindow()
bool	IsModalWindow()
bool	IsMorphing()
bool	IsMorphingSize()
bool	IsRegularWindow()
bool	IsScreenspaceMouseWithin ( FVector2D ScreenspaceMouseCoordinat... )
bool	IsTopmostWindow()
bool	IsUserSized()
bool	IsViewportSizeDrivenByWindow()	Returns whether or not the viewport and window size should be linked together.
bool	IsVirtualWindow()
bool	IsVisible()
bool	IsWindowMaximized()
bool	IsWindowMinimized()
TSharedRef< ...	MakeCursorDecorator()	Make cursor decorator window
TSharedRef< ...	MakeNotificationWindow()	Make a notification window
TSharedRef< ...	MakeStyledCursorDecorator ( const FWindowStyle& InStyle )	Make cursor decorator window with a non-default style
TSharedRef< ...	MakeToolTipWindow()	Make a tool tip window
TSharedRef< ...	MakeWindowTitleBar ( const TSharedRef< SWindow >& Windo..., const TSharedPtr< SWidget >& Cente..., EHorizontalAlignment CenterContentA... )	Returns swindow title bar widgets.
void	Maximize()	Windows functions
void	Minimize()
void	MorphToPosition ( const FCurveSequence& Sequence, const float TargetOpacity, const FVector2D& TargetPosition )	Animate the window to TargetOpacity and TargetPosition over a short period of time
void	MorphToShape ( const FCurveSequence& Sequence, const float TargetOpacity, const FSlateRect& TargetShape )	Animate the window to TargetOpacity and TargetShape over a short period of time
void	MoveWindowTo ( FVector2D NewPosition )	Relocate the window to a screenspace position specified by NewPosition
void	NotifyWindowBeingDestroyed()	Calls the OnWindowClosed delegate when this window is about to be closed
bool	OnIsActiveChanged ( const FWindowActivateEvent& Activa... )	The system will call this method to notify the window that it has been places in the foreground or background.
int32	PaintWindow ( double CurrentTime, float DeltaTime, FSlateWindowElementList& OutDrawEl..., const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Paint the window and all of its contents.
void	ProcessWindowInvalidation()	Process the invalidation of the widget contained by the window in GlobalInvalidation.
bool	RemoveDescendantWindow ( const TSharedRef< SWindow >& Desce... )	Remove DescendantToRemove from this window's children or their children.
bool	RemoveOverlaySlot ( const TSharedRef< SWidget >& InCon... )	Removes a widget that is being drawn over the entire window
void	RemovePopupLayerSlot ( const TSharedRef< SWidget >& Widge... )	Counterpart to AddPopupLayerSlot
void	RequestDestroyWindow()	Request that this window be destroyed.
void	ReshapeWindow ( const FSlateRect& InNewShape )	Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize
void	ReshapeWindow ( FVector2D NewPosition, FVector2D NewSize )	Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize
void	Resize ( FVector2D NewClientSize )	Resize the window to be dpi scaled NewClientSize immediately
void	Restore()
void	SetAllowFastUpdate ( bool bInAllowFastUpdate )
void	SetAsModalWindow()	Set modal window related flags - called by Slate app code during FSlateApplication::AddModalWindow()
void	SetCachedScreenPosition ( FVector2D NewPosition )	Sets the actual screen position of the window. THIS SHOULD ONLY BE CALLED BY THE OS
void	SetCachedSize ( FVector2D NewSize )	Sets the actual size of the window. THIS SHOULD ONLY BE CALLED BY THE OS
void	SetContent ( TSharedRef< SWidget > InContent )	Sets the widget content for this window
void	SetDPIScaleFactor ( const float Factor )	Overrides the DPI scale factor of the native window
void	SetFullWindowOverlayContent ( TSharedPtr< SWidget > InContent )	Sets a widget to use as a full window overlay, or clears an existing widget if set.
void	SetIndependentViewportSize ( const FVector2D& VP )	Sets the viewport size independently of the window size, if non-zero.
void	SetIsHDR ( bool bHDR )
void	SetManualManageDPIChanges ( const bool bManualDPI )	Will inform the native window that we need to handle any DPI changes from within the application
void	SetMirrorWindow ( bool bSetMirrorWindow )	Set mirror window flag
void	SetNativeWindow ( TSharedRef< FGenericWindow > InNati... )	Sets the native OS window associated with this SWindow
void	SetNativeWindowButtonsVisibility ( bool bVisible )	Shows or hides native window buttons on platforms that use them
void	SetOnWindowClosed ( const FOnWindowClosed& InDelegate )	Sets the delegate to execute right before the window is closed
void	SetOnWindowMoved ( const FOnWindowMoved& InDelegate )	Sets the delegate to execute right after the window has been moved
void	SetOnWorldSwitchHack ( FOnSwitchWorldHack& InOnWorldSwitc... )	Sets the delegate to call when switching worlds in before ticking,drawing, or sending messages to widgets in this window
void	SetOpacity ( const float InOpacity )	Sets the opacity of this window
void	SetRequestDestroyWindowOverride ( const FRequestDestroyWindowOverride... )	Sets the delegate to override RequestDestroyWindow
void	SetSizingRule ( ESizingRule InSizingRule )	Should this window automatically derive its size based on its content or be user-drive?
void	SetTitle ( const FText& InTitle )	Sets the current window title
void	SetTitleBar ( const TSharedPtr< IWindowTitleBar >... )
void	SetViewport ( TSharedRef< ISlateViewport > Viewpo... )
void	SetViewportSizeDrivenByWindow ( bool bDrivenByWindow )	Sets whether or not the viewport size should be driven by the window's size.
void	SetWidgetToFocusOnActivate ( TSharedPtr< SWidget > InWidget )	Sets a widget that should become focused when this window is next activated
void	SetWindowBackground ( const FSlateBrush* InWindowBac... )
void	SetWindowMode ( EWindowMode::Type WindowMode )	Toggle window between window modes (fullscreen, windowed, etc)
bool	ShouldPreserveAspectRatio()
void	ShowWindow()	Make the window visible
bool	SizeWillChangeOften()
void	StartMorph()	Kick off a morph to whatever the target shape happens to be.
int32	SwitchWorlds ( int32 WorldId )	Hack to switch worlds
EActiveTimer...	TriggerPlayMorphSequence ( double InCurrentTime, float InDeltaTime )	One-off active timer to trigger a the morph sequence to play
void	UpdateMorphTargetPosition ( const FVector2D& TargetPosition )	Set a new morph position and force the morph to run for at least one frame in order to reach that target
void	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
void	UpdateWindowContentVisibility()

Overridden from SWidget

	Name	Description
const FSlate...	Advanced_AsInvalidationRoot()
bool	Advanced_IsInvalidationRoot()
bool	Advanced_IsWindow()	Is this widget derivative of SWindow
TSharedRef< ...	CreateAccessibleWidget()
bool	CustomPrepass ( float LayoutScaleMultiplier )
TOptional< F...	GetDefaultAccessibleText ( EAccessibleType AccessibleType )	Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	Events.
TSharedPtr< ...	OnVisualizePopup ( const TSharedRef< SWidget >& Popup... )	Visualize a new pop-up if possible.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.
FString	ToString()

Overridden from FSlateInvalidationRoot

		Name	Description
	TSharedRef< ...	GetRootWidget()
	int32	PaintSlowPath ( const FSlateInvalidationContext& I... )

Classes

	Name	Description
	FArguments
	FMorpher	Utility for animating the window size.

Typedefs

Name	Description
FScopedWidgetSlotArguments

Deprecated Functions

		Name	Description
	bool	ActivateWhenFirstShown()	ActivateWhenFirstShown() is deprecated. Please use ActivationPolicy() instead.