1. Epic GamesDeveloper
  3. SWindow

SWindow

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

API > API/Runtime > API/Runtime/SlateCore

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

   
Name SWindow
Type class
Header File /Engine/Source/Runtime/SlateCore/Public/Widgets/SWindow.h
Include Path #include "Widgets/SWindow.h"

Syntax

class SWindow :  
    public SCompoundWidget ,  
    public FSlateInvalidationRoot

Inheritance Hierarchy

Derived Classes

SWindow derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SWindow()

 Default constructor. Widgets/SWindow.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SWindow()

   Widgets/SWindow.h  

Structs

Name Remarks
FArguments  
FMorpher Utility for animating the window size.

Typedefs

Name Type Remarks Include Path
FScopedWidgetSlotArguments TPanelChildren< FPopupLayerSlot >::FScopedWidgetSlotArguments   Widgets/SWindow.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MoveResizeRect FSlateRect   Widgets/SWindow.h  
MoveResizeStart UE::Slate::FDeprecateVector2DResult   Widgets/SWindow.h  
MoveResizeZone EWindowZone::Type Used to store the zone where the mouse down event occurred during move / drag Widgets/SWindow.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTimerHandle TWeakPtr< FActiveTimerHandle > The handle to the active timer Widgets/SWindow.h  
ContentAreaVBox TSharedPtr< SWidget >   Widgets/SWindow.h  
Style const FWindowStyle * Style used to draw this window Widgets/SWindow.h  
WindowBackground const FSlateBrush *   Widgets/SWindow.h  
WindowBackgroundImage TSharedPtr< SImage >   Widgets/SWindow.h  
WindowBorder TSharedPtr< SImage >   Widgets/SWindow.h  
WindowContentVisibility EVisibility   Widgets/SWindow.h  
WindowOutline TSharedPtr< SImage >   Widgets/SWindow.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AcceptsInput()

   Widgets/SWindow.h  

EWindowActivationPolicy ActivationPolicy()

   Widgets/SWindow.h  

void AddChildWindow ( const TSharedRef< SWindow >& ChildWindow
)

 Add ChildWindow as this window's child Widgets/SWindow.h  

SOverlay::FScopedWidgetSlotArguments AddOverlaySlot ( const int32 ZOrder
)

 Adds content to draw on top of the entire window Widgets/SWindow.h  

FScopedWidgetSlotArguments AddPopupLayerSlot()

 Return a new slot in the popup layer. Assumes that the window has a popup layer. Widgets/SWindow.h  

bool AppearsInTaskbar()

   Widgets/SWindow.h  

void BeginFullWindowOverlayTransition()

 Begins a transition from showing regular window content to overlay content During the transition we show both sets of content Widgets/SWindow.h  

void BringToFront ( bool bForce
)

 Bring the window to the front Widgets/SWindow.h  

void Construct ( const FArguments& InArgs
)

   Widgets/SWindow.h  

void DestroyWindowImmediately()

 Warning: use Request Destroy Window whenever possible! This method destroys the window immediately! Widgets/SWindow.h  

void 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 Widgets/SWindow.h  

void EnableWindow ( bool bEnable
)

 Enables or disables this window and all of its children Widgets/SWindow.h  

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 Widgets/SWindow.h  

void FlashWindow()

 Flashed the window, used for drawing attention to modal dialogs Widgets/SWindow.h  
  Widgets/SWindow.h  
  Widgets/SWindow.h  

FSlateRect GetClientRectInScreen()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetClientSizeInScreen()

   Widgets/SWindow.h  

FSlateRect GetClippingRectangleInWindow()

   Widgets/SWindow.h  

TSharedRef< SWidget > GetContent()

 Gets the widget content for this window Widgets/SWindow.h  

int32 GetCornerRadius()

   Widgets/SWindow.h  

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

 Gets the current Window Zone that mouse position is over. Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetDesiredSizeDesktopPixels()

   Widgets/SWindow.h  

float GetDPIScaleFactor()

 Returns the DPI scale factor of the native window Widgets/SWindow.h  

int32 GetExpectedMaxHeight()

   Widgets/SWindow.h  

int32 GetExpectedMaxWidth()

   Widgets/SWindow.h  

FSlateRect GetFullScreenInfo()

 Returns the rectangle of the screen the window is associated with Widgets/SWindow.h  
Access the hittest acceleration data structure for this window. Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetInitialDesiredPositionInScreen()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetInitialDesiredSizeInScreen()

   Widgets/SWindow.h  

bool GetIsHDR()

   Widgets/SWindow.h  

FSlateLayoutTransform GetLocalToScreenTransform()

   Widgets/SWindow.h  

FSlateLayoutTransform GetLocalToWindowTransform()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetMorphTargetPosition()

   Widgets/SWindow.h  

FSlateRect GetMorphTargetShape()

   Widgets/SWindow.h  
  Widgets/SWindow.h  
  Widgets/SWindow.h  

FSlateRect GetNonMaximizedRectInScreen()

   Widgets/SWindow.h  

FMargin GetNonMaximizedWindowBorderSize()

 Returns the margins used for the window border if it's not maximized Widgets/SWindow.h  

FOnWindowActivatedEvent & GetOnWindowActivatedEvent()

 Gets the multicast delegate executed when the window is activated Widgets/SWindow.h  

FOnWindowClosedEvent & GetOnWindowClosedEvent()

 Gets the multicast delegate to execute right before the window is closed Widgets/SWindow.h  

FOnWindowDeactivatedEvent & GetOnWindowDeactivatedEvent()

 Gets the multicast delegate executed when the window is deactivated Widgets/SWindow.h  

float GetOpacity()

   Widgets/SWindow.h  

TSharedPtr< SWindow > GetParentWindow()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetPositionInScreen()

   Widgets/SWindow.h  

FSlateRect GetRectInScreen()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetSizeInScreen()

   Widgets/SWindow.h  

FWindowSizeLimits GetSizeLimits()

 Optional constraints on min and max sizes that this window can be. Widgets/SWindow.h  

FText GetTitle()

 Grabs the current window title Widgets/SWindow.h  

TSharedPtr< IWindowTitleBar > GetTitleBar()

   Widgets/SWindow.h  
Returns the size of the title bar as a Slate size parameter. Widgets/SWindow.h  

TSharedPtr< SWindow > GetTopmostAncestor()

 Look up the parent chain until we find the top-level window that owns this window Widgets/SWindow.h  

EWindowTransparency GetTransparencySupport()

   Widgets/SWindow.h  

EWindowType GetType()

 Grabs the window type Widgets/SWindow.h  

TSharedPtr< ISlateViewport > GetViewport()

   Widgets/SWindow.h  

float GetViewportScaleUIOverride()

   Widgets/SWindow.h  

UE::Slate::FDeprecateVector2DResult GetViewportSize()

 Returns the viewport size, taking into consideration if the window size should drive the viewport size Widgets/SWindow.h  

TWeakPtr< SWidget > GetWidgetFocusedOnDeactivate()

 Returns widget last focused on deactivate Widgets/SWindow.h  

FMargin GetWindowBorderSize ( bool bIncTitleBar
) const

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

TAttribute< FText > GetWindowCloseButtonToolTipText()

 Return the tooltip text that should be used for the window's Close button. Widgets/SWindow.h  
Get the Geometry that describes this window. Widgets/SWindow.h  

FGeometry GetWindowGeometryInWindow()

   Widgets/SWindow.h  

EWindowMode::Type GetWindowMode()

   Widgets/SWindow.h  

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

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

EVisibility GetWindowVisibility()

 Windows that are not hittestable should not show up in the hittest grid. Widgets/SWindow.h  

void HACK_ForceToFront()

 @hack Force a window to front even if a different application is in front. Widgets/SWindow.h  

bool HasActiveChildren()

 Are any of our child windows active? Widgets/SWindow.h  

bool HasActiveParent()

 Are any of our parent windows active? Widgets/SWindow.h  

bool HasCloseBox()

   Widgets/SWindow.h  

bool HasFullWindowOverlayContent()

 Checks to see if there is content assigned as a full window overlay Widgets/SWindow.h  

bool HasMaximizeBox()

   Widgets/SWindow.h  

bool HasMinimizeBox()

   Widgets/SWindow.h  

bool HasOSWindowBorder()

   Widgets/SWindow.h  

bool HasOverlay()

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

bool HasSizingFrame()

   Widgets/SWindow.h  

void HideWindow()

 Make the window invisible Widgets/SWindow.h  

void InitialMaximize()

 Maximize the window if bInitiallyMaximized is set Widgets/SWindow.h  

void InitialMinimize()

 Maximize the window if bInitiallyMinimized is set Widgets/SWindow.h  

bool IsActive()

 Is this window active?Are any of our child windows active? Widgets/SWindow.h  

bool IsAutosized()

   Widgets/SWindow.h  

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

 Returns whether or not this window is a descendant of the specfied parent window Widgets/SWindow.h  

bool IsDrawingEnabled()

   Widgets/SWindow.h  

bool IsFocusedInitially()

   Widgets/SWindow.h  

bool IsManualManageDPIChanges()

   Widgets/SWindow.h  

bool IsMirrorWindow()

   Widgets/SWindow.h  

bool IsModalWindow()

   Widgets/SWindow.h  

bool IsMorphing()

   Widgets/SWindow.h  

bool IsMorphingSize()

   Widgets/SWindow.h  

bool IsRegularWindow()

   Widgets/SWindow.h  

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

   Widgets/SWindow.h  

bool IsTopmostWindow()

   Widgets/SWindow.h  

bool IsUserSized()

   Widgets/SWindow.h  
Returns whether or not the viewport and window size should be linked together. Widgets/SWindow.h  

bool IsVirtualWindow()

   Widgets/SWindow.h  

bool IsVisible()

   Widgets/SWindow.h  

bool IsWindowMaximized()

   Widgets/SWindow.h  

bool IsWindowMinimized()

   Widgets/SWindow.h  

void Maximize()

 Windows functions Widgets/SWindow.h  

void Minimize()

   Widgets/SWindow.h  

void 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 Widgets/SWindow.h  

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

 Animate the window to TargetOpacity and TargetShape over a short period of time Widgets/SWindow.h  

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

 Relocate the window to a screenspace position specified by NewPosition Widgets/SWindow.h  
Calls the OnWindowClosed delegate when this window is about to be closed Widgets/SWindow.h  

virtual bool OnIsActiveChanged ( const FWindowActivateEvent& ActivateEvent
)

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

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

 Paint the window and all of its contents. Widgets/SWindow.h  

void ProcessWindowInvalidation()

 Process the invalidation of the widget contained by the window in GlobalInvalidation. Widgets/SWindow.h  

bool RemoveDescendantWindow ( const TSharedRef< SWindow >& DescendantToRemove
)

 Remove DescendantToRemove from this window's children or their children. Widgets/SWindow.h  

bool RemoveOverlaySlot ( const TSharedRef< SWidget >& InContent
)

 Removes a widget that is being drawn over the entire window Widgets/SWindow.h  

void RemovePopupLayerSlot ( const TSharedRef< SWidget >& WidgetToRemove
)

 Counterpart to AddPopupLayerSlot Widgets/SWindow.h  
Request that this window be destroyed. Widgets/SWindow.h  

void ResetViewportScaleUIOverride()

   Widgets/SWindow.h  

void ReshapeWindow ( const FSlateRect& InNewShape
)

   Widgets/SWindow.h  

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

 Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize Widgets/SWindow.h  

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

 Resize the window to be dpi scaled NewClientSize immediately Widgets/SWindow.h  

void Restore()

   Widgets/SWindow.h  

void SetAcceptsInput ( bool bEnabled
)

 If true the window will accept input if window type supports it Widgets/SWindow.h  

void SetAllowFastUpdate ( bool bInAllowFastUpdate
)

   Widgets/SWindow.h  

void SetAsModalWindow()

 Set modal window related flags - called by Slate app code during FSlateApplication::AddModalWindow() Widgets/SWindow.h  

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

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

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

 Sets the actual size of the window. THIS SHOULD ONLY BE CALLED BY THE OS Widgets/SWindow.h  

void SetContent ( TSharedRef< SWidget > InContent
)

 Sets the widget content for this window Widgets/SWindow.h  

void SetDPIScaleFactor ( const float Factor
)

 Overrides the DPI scale factor of the native window Widgets/SWindow.h  
Sets a widget to use as a full window overlay, or clears an existing widget if set. Widgets/SWindow.h  

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

 Sets the viewport size independently of the window size, if non-zero. Widgets/SWindow.h  

void SetIsHDR ( bool bHDR
)

   Widgets/SWindow.h  

void SetManualManageDPIChanges ( const bool bManualDPI
)

 Will inform the native window that we need to handle any DPI changes from within the application Widgets/SWindow.h  

void SetMirrorWindow ( bool bSetMirrorWindow
)

 Set mirror window flag Widgets/SWindow.h  

void SetNativeWindow ( TSharedRef< FGenericWindow > InNativeWindow
)

 Sets the native OS window associated with this SWindow Widgets/SWindow.h  

void SetNativeWindowButtonsVisibility ( bool bVisible
)

 Shows or hides native window buttons on platforms that use them Widgets/SWindow.h  

void SetOnWindowClosed ( const FOnWindowClosed& InDelegate
)

 Sets the delegate to execute right before the window is closed Widgets/SWindow.h  

void SetOnWindowMoved ( const FOnWindowMoved& InDelegate
)

 Sets the delegate to execute right after the window has been moved Widgets/SWindow.h  

void SetOnWorldSwitchHack ( FOnSwitchWorldHack& InOnWorldSwitchHack
)

 Sets the delegate to call when switching worlds in before ticking,drawing, or sending messages to widgets in this window Widgets/SWindow.h  

void SetOpacity ( const float InOpacity
)

 Sets the opacity of this window Widgets/SWindow.h  

void SetRequestDestroyWindowOverride ( const FRequestDestroyWindowOverride& InDelegate
)

 Sets the delegate to override RequestDestroyWindow Widgets/SWindow.h  

void SetSizeLimits ( const FWindowSizeLimits& InSizeLimits
)

 Set optional constraints on min and max sizes that this window can be. Widgets/SWindow.h  

void SetSizingRule ( ESizingRule InSizingRule
)

 Should this window automatically derive its size based on its content or be user-drive? Widgets/SWindow.h  

void SetTitle ( const FText& InTitle
)

 Sets the current window title Widgets/SWindow.h  

void SetTitleBar ( const TSharedPtr< IWindowTitleBar > InTitleBar
)

   Widgets/SWindow.h  

void SetViewport ( TSharedRef< ISlateViewport > ViewportRef
)

   Widgets/SWindow.h  

void SetViewportScaleUIOverride ( float InViewportScaleUIOverride
)

   Widgets/SWindow.h  

void SetViewportSizeDrivenByWindow ( bool bDrivenByWindow
)

 Sets whether or not the viewport size should be driven by the window's size. Widgets/SWindow.h  

void SetWidgetToFocusOnActivate ( TSharedPtr< SWidget > InWidget
)

 Sets a widget that should become focused when this window is next activated Widgets/SWindow.h  

void SetWindowMode ( EWindowMode::Type WindowMode
)

 Toggle window between window modes (fullscreen, windowed, etc) Widgets/SWindow.h  

bool ShouldPreserveAspectRatio()

   Widgets/SWindow.h  

void ShowWindow()

 Make the window visible Widgets/SWindow.h  

bool SizeWillChangeOften()

   Widgets/SWindow.h  

int32 SwitchWorlds ( int32 WorldId
) const

 Hack to switch worlds Widgets/SWindow.h  

void UnsetViewport ( TSharedRef< ISlateViewport > ViewportRef
)

   Widgets/SWindow.h  

void 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 Widgets/SWindow.h  

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 Widgets/SWindow.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual const FSlateInvalidationRoot * Advanced_AsInvalidationRoot()

   Widgets/SWindow.h  

virtual bool Advanced_IsInvalidationRoot()

   Widgets/SWindow.h  

virtual bool Advanced_IsWindow()

 Is this widget derivative of SWindow Widgets/SWindow.h  

virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget()

   Widgets/SWindow.h  

virtual TOptional< FText > GetDefaultAccessibleText ( EAccessibleType AccessibleType
) const

 Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom. Widgets/SWindow.h  

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

 Events. Widgets/SWindow.h  

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

 Visualize a new pop-up if possible. Widgets/SWindow.h  

virtual bool SupportsKeyboardFocus()

 Checks to see if this widget supports keyboard focus. Override this in derived classes. Widgets/SWindow.h  

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

 Ticks this widget with Geometry. Widgets/SWindow.h  

virtual FString ToString()

   Widgets/SWindow.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ConstructWindowInternals()

   Widgets/SWindow.h  

virtual EHorizontalAlignment GetTitleAlignment()

 Returns the alignment type for the titlebar's title text. Widgets/SWindow.h  

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

 Returns swindow title bar widgets. Widgets/SWindow.h  

void SetWindowBackground ( const FSlateBrush* InWindowBackground
)

   Widgets/SWindow.h  

void StartMorph()

 Kick off a morph to whatever the target shape happens to be. Widgets/SWindow.h  

EActiveTimerReturnType TriggerPlayMorphSequence ( double InCurrentTime,
float InDeltaTime
)

 One-off active timer to trigger a the morph sequence to play Widgets/SWindow.h  

void UpdateWindowContentVisibility()

   Widgets/SWindow.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual bool CustomPrepass ( float LayoutScaleMultiplier
)

   Widgets/SWindow.h  

Overridden from FSlateInvalidationRoot

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > GetRootWidget()

   Widgets/SWindow.h  

virtual int32 PaintSlowPath ( const FSlateInvalidationContext& InvalidationContext
)

   Widgets/SWindow.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   Widgets/SWindow.h  

static TSharedRef< SWindow > MakeCursorDecorator()

 Make cursor decorator window Widgets/SWindow.h  

static TSharedRef< SWindow > MakeNotificationWindow()

 Make a notification window Widgets/SWindow.h  

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

 Make cursor decorator window with a non-default style Widgets/SWindow.h  

static TSharedRef< SWindow > MakeToolTipWindow()

 Make a tool tip window Widgets/SWindow.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page