1. Epic GamesDeveloper
  3. SWindow

SWindow

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

API > API/Runtime > API/Runtime/SlateCore > API/Runtime/SlateCore/Widgets

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function  

SWindow ()

 Default constructor.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool  
Public function Const EWindowActivationPolicy  
Public function void

AddChildWindow ( const TSharedRef< SWindow >& ChildWindow
)

 Add ChildWindow as this window's child
Public function SOverlay::FScopedWidgetSlotArguments

AddOverlaySlot ( const int32 ZOrder
)

 Adds content to draw on top of the entire window
Public function FScopedWidgetSlotArguments Return a new slot in the popup layer. Assumes that the window has a popup layer.
Public function Const bool  
Public function void Begins a transition from showing regular window content to overlay content During the transition we show both sets of content
Public function void

BringToFront ( bool bForce
)

 Bring the window to the front
Public function Static UE::Slate::FDeprecateVector2DResult  
Public function void

Construct ( const FArguments& InArgs
)

  
Protected function void  
Public function void Warning: use Request Destroy Window whenever possible! This method destroys the window immediately!
Public function void 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
Public function void

EnableWindow ( bool bEnable
)

 Enables or disables this window and all of its children
Public function void 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
Public function void Flashed the window, used for drawing attention to modal dialogs
Public function TArray< TSharedRef< SWindow > > &  
Public function Const const TArray< TSharedRef< SWindow > > &  
Public function Const FSlateRect  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const FSlateRect  
Public function TSharedRef< SWidget > Gets the widget content for this window
Public function int32  
Public function EWindowZone::Type Gets the current Window Zone that mouse position is over.
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const float Returns the DPI scale factor of the native window
Public function Const int32  
Public function Const int32  
Public function Const FSlateRect Returns the rectangle of the screen the window is associated with
Public function FHittestGrid & Access the hittest acceleration data structure for this window.
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const bool  
Public function Const FSlateLayoutTransform  
Public function Const FSlateLayoutTransform  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const FSlateRect  
Public function Const TSharedPtr< const FGenericWindow >  
Public function TSharedPtr< FGenericWindow >  
Public function Const FSlateRect  
Public function Const FMargin Returns the margins used for the window border if it's not maximized
Public function FOnWindowActivatedEvent & Gets the multicast delegate executed when the window is activated
Public function FOnWindowClosedEvent & Gets the multicast delegate to execute right before the window is closed
Public function FOnWindowDeactivatedEvent & Gets the multicast delegate executed when the window is deactivated
Public function Const float  
Public function Const TSharedPtr< SWindow >  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const FSlateRect  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const FWindowSizeLimits Optional constraints on min and max sizes that this window can be.
Public function Const FText Grabs the current window title
Protected function Virtual EHorizontalAlignment Returns the alignment type for the titlebar's title text.
Public function Const TSharedPtr< IWindowTitleBar >  
Public function Const FOptionalSize Returns the size of the title bar as a Slate size parameter.
Public function TSharedPtr< SWindow > Look up the parent chain until we find the top-level window that owns this window
Public function Const EWindowTransparency  
Public function Const EWindowType

GetType ()

 Grabs the window type
Public function TSharedPtr< ISlateViewport >  
Public function Const UE::Slate::FDeprecateVector2DResult Returns the viewport size, taking into consideration if the window size should drive the viewport size
Public function TWeakPtr< SWidget > Returns widget last focused on deactivate
Public function Const FMargin

GetWindowBorderSize ( bool bIncTitleBar
)

 Returns the margins used for the window border. This varies based on whether it's maximized or not.
Public function Const FGeometry Get the Geometry that describes this window.
Public function Const FGeometry  
Public function Const EWindowMode::Type  
Public function UE::Slate::FDeprecateVector2DResult For a given client size, calculate the window size required to accommodate any potential non-OS borders and title bars
Public function Const EVisibility Windows that are not hittestable should not show up in the hittest grid.
Public function void Force a window to front even if a different application is in front.
Public function Const bool Are any of our child windows active?
Public function Const bool Are any of our parent windows active?
Public function Const bool  
Public function Const bool Checks to see if there is content assigned as a full window overlay
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Check whether we have a full window overlay, used to draw content over the entire window.
Public function Const bool  
Public function void Make the window invisible
Public function void Maximize the window if bInitiallyMaximized is set
Public function void Maximize the window if bInitiallyMinimized is set
Public function Const bool Is this window active?Are any of our child windows active?
Public function Const bool  
Public function Const bool

IsDescendantOf ( const TSharedPtr< SWindow >& ParentWindow
)

 Returns whether or not this window is a descendant of the specfied parent window
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function bool  
Public function bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Returns whether or not the viewport and window size should be linked together.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Static TSharedRef< SWindow > Make cursor decorator window
Public function Static TSharedRef< SWindow > Make a notification window
Public function Static TSharedRef< SWindow > Make cursor decorator window with a non-default style
Public function Static TSharedRef< SWindow > Make a tool tip window
Protected function Virtual TSharedRef< SWidget >

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

 Returns swindow title bar widgets.
Public function void Windows functions
Public function void  
Public function 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
Public function void

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

 Animate the window to TargetOpacity and TargetShape over a short period of time
Public function void Relocate the window to a screenspace position specified by NewPosition
Public function void Calls the OnWindowClosed delegate when this window is about to be closed
Public function 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.
Public function int32

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

 Paint the window and all of its contents.
Public function void Process the invalidation of the widget contained by the window in GlobalInvalidation.
Public function bool

RemoveDescendantWindow ( const TSharedRef< SWindow >& DescendantToRemove
)

 Remove DescendantToRemove from this window's children or their children.
Public function bool

RemoveOverlaySlot ( const TSharedRef< SWidget >& InContent
)

 Removes a widget that is being drawn over the entire window
Public function void

RemovePopupLayerSlot ( const TSharedRef< SWidget >& WidgetToRemove
)

 Counterpart to AddPopupLayerSlot
Public function void Request that this window be destroyed.
Public function void

ReshapeWindow ( const FSlateRect& InNewShape
)

 Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize
Public function void Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize
Public function void Resize the window to be dpi scaled NewClientSize immediately
Public function void

Restore ()

  
Public function void

SetAllowFastUpdate ( bool bInAllowFastUpdate
)

  
Public function void Set modal window related flags - called by Slate app code during FSlateApplication::AddModalWindow()
Public function void Sets the actual screen position of the window. THIS SHOULD ONLY BE CALLED BY THE OS
Public function void Sets the actual size of the window. THIS SHOULD ONLY BE CALLED BY THE OS
Public function void

SetContent ( TSharedRef< SWidget > InContent
)

 Sets the widget content for this window
Public function void

SetDPIScaleFactor ( const float Factor
)

 Overrides the DPI scale factor of the native window
Public function void Sets a widget to use as a full window overlay, or clears an existing widget if set.
Public function void Sets the viewport size independently of the window size, if non-zero.
Public function void

SetIsHDR ( bool bHDR
)

  
Public function void

SetManualManageDPIChanges ( const bool bManualDPI
)

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

SetMirrorWindow ( bool bSetMirrorWindow
)

 Set mirror window flag
Public function void

SetNativeWindow ( TSharedRef< FGenericWindow > InNativeWindow
)

 Sets the native OS window associated with this SWindow
Public function void Shows or hides native window buttons on platforms that use them
Public function void

SetOnWindowClosed ( const FOnWindowClosed& InDelegate
)

 Sets the delegate to execute right before the window is closed
Public function void

SetOnWindowMoved ( const FOnWindowMoved& InDelegate
)

 Sets the delegate to execute right after the window has been moved
Public function void

SetOnWorldSwitchHack ( FOnSwitchWorldHack& InOnWorldSwitchHack
)

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

SetOpacity ( const float InOpacity
)

 Sets the opacity of this window
Public function void

SetRequestDestroyWindowOverride ( const FRequestDestroyWindowOverride& InDelegate
)

 Sets the delegate to override RequestDestroyWindow
Public function void

SetSizeLimits ( const FWindowSizeLimits& InSizeLimits
)

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

SetSizingRule ( ESizingRule InSizingRule
)

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

SetTitle ( const FText& InTitle
)

 Sets the current window title
Public function void

SetTitleBar ( const TSharedPtr< IWindowTitleBar > InTitleBar
)

  
Public function void  
Public function void

SetViewportSizeDrivenByWindow ( bool bDrivenByWindow
)

 Sets whether or not the viewport size should be driven by the window's size.
Public function void Sets a widget that should become focused when this window is next activated
Protected function void

SetWindowBackground ( const FSlateBrush* InWindowBackground
)

  
Public function void Toggle window between window modes (fullscreen, windowed, etc)
Public function Const bool  
Public function void Make the window visible
Public function Const bool  
Protected function void Kick off a morph to whatever the target shape happens to be.
Public function Const int32

SwitchWorlds ( int32 WorldId
)

 Hack to switch worlds
Protected function EActiveTimerReturnType

TriggerPlayMorphSequence ( double InCurrentTime,
float InDeltaTime
)

 One-off active timer to trigger a the morph sequence to play
Public function void Set a new morph position and force the morph to run for at least one frame in order to reach that target
Public function 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
Protected function void  

Overridden from SWidget

  Type Name Description
Public function Virtual Const const FSlateInvalidationRoot *  
Public function Virtual Const bool  
Public function Virtual Const bool Is this widget derivative of SWindow
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Protected function Virtual bool

CustomPrepass ( float LayoutScaleMultiplier
)

  
Public function Virtual Const TOptional< FText >

GetDefaultAccessibleText ( EAccessibleType AccessibleType
)

 Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
Public function Virtual Const FCursorReply

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

 Events.
Public function Virtual TSharedPtr< FPopupLayer >

OnVisualizePopup ( const TSharedRef< SWidget >& PopupContent
)

 Visualize a new pop-up if possible.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.
Public function Virtual void

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

 Ticks this widget with Geometry.
Public function Virtual Const FString  

Overridden from FSlateInvalidationRoot

  Type Name Description
Protected function Virtual TSharedRef< SWidget >  
Protected function Virtual int32

PaintSlowPath ( const FSlateInvalidationContext& InvalidationContext
)

  

Classes

  Type Name Description
Public struct FArguments    
Protected struct FMorpher Utility for animating the window size.  

Typedefs

Name Description
FScopedWidgetSlotArguments  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page