Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/SlateCore/Public/Widgets/SWindow.h |
Include |
#include "Widgets/SWindow.h" |
class SWindow :
public SCompoundWidget,
public FSlateInvalidationRoot
SWindow is a platform-agnostic representation of a top-level window.
Name | Description | ||
---|---|---|---|
|
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 |
|
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 |
|
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 |
|
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. |
|
ChildWindows |
Child windows of this window |
|
|
ContentSlot |
||
|
ExpectedMaxHeight |
The expected maximum height of the window. |
|
|
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. |
|
InitialDesiredScreenPosition |
Initial desired position of the window's content in screen space |
|
|
InitialDesiredSize |
Initial desired size of the window's content in screen space |
|
|
LayoutBorder |
The padding for between the edges of the window and it's content. |
|
|
Morpher |
||
|
MoveResizeRect |
||
|
MoveResizeStart |
||
|
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 |
|
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. |
|
PreFullscreenPosition |
The position of the window before entering fullscreen |
|
|
FRequestDestroy... |
RequestDestroyWindowOverride |
Invoked when the window is requested to be destroyed. |
|
ScreenPosition |
Position of the window's content in screen space |
|
|
Size |
Size of the window's content area in screen space |
|
|
SizeLimits |
Min and Max values for Width and Height; all optional. |
|
|
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. |
|
TransparencySupport |
Transparency setting for this window |
|
|
Type |
Type of the window |
|
|
UserResizeBorder |
The margin around the edges of the window that will be detected as places the user can grab to resize the window. |
|
|
Viewport |
Pointer to the viewport registered with this window if any |
|
|
ViewportSize |
Size of the viewport. If (0,0) then it is equal to Size |
|
|
WidgetFocusedOnDeactivate |
Widget that had keyboard focus when this window was last de-activated, if any. |
|
|
WidgetToFocusOnActivate |
Widget to transfer keyboard focus to when this window becomes active, if any. |
|
|
FOnWindowActiva... |
WindowActivatedEvent |
|
|
WindowActivationPolicy |
When should the window be activated upon being shown |
|
|
FOnWindowClosed... |
WindowClosedEvent |
|
|
FOnWindowDeacti... |
WindowDeactivatedEvent |
|
|
TSharedPtr< SOv... |
WindowOverlay |
Window overlay widget |
|
WindowZone |
Cached "zone" the cursor was over in the window the last time that someone called GetCurrentWindowZone() |
Name | Description | |
---|---|---|
|
SWindow() |
Default constructor. |
Name | Description | |
---|---|---|
|
~SWindow() |
Name | Description | ||
---|---|---|---|
|
AcceptsInput() |
||
|
EWindowActiv... |
ActivationPolicy() |
|
|
AddChildWindow ( |
Add ChildWindow as this window's child |
|
|
SOverlay::FS... |
AddOverlaySlot ( |
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. |
|
AppearsInTaskbar() |
||
|
BeginFullWindowOverlayTransition() |
Begins a transition from showing regular window content to overlay content During the transition we show both sets of content |
|
|
BringToFront ( |
Bring the window to the front |
|
|
ComputeWindowSizeForContent ( |
||
|
Construct ( |
||
|
ConstructWindowInternals() |
||
|
DestroyWindowImmediately() |
Warning: use Request Destroy Window whenever possible! This method destroys the window immediately! |
|
|
DrawAttention ( |
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 |
|
|
EnableWindow ( |
Enables or disables this window and all of its children |
|
|
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() |
Flashed the window, used for drawing attention to modal dialogs |
|
|
GetChildWindows() |
||
|
const TArray... |
GetChildWindows() |
|
|
GetClientRectInScreen() |
||
|
GetClientSizeInScreen() |
||
|
GetClippingRectangleInWindow() |
||
|
TSharedRef< ... |
GetContent() |
Gets the widget content for this window |
|
GetCornerRadius() |
||
|
EWindowZone:... |
GetCurrentWindowZone ( |
Gets the current Window Zone that mouse position is over. |
|
GetDesiredSizeDesktopPixels() |
||
|
float |
GetDPIScaleFactor() |
Returns the DPI scale factor of the native window |
|
GetExpectedMaxHeight() |
||
|
GetExpectedMaxWidth() |
||
|
GetFullScreenInfo() |
Returns the rectangle of the screen the window is associated with |
|
|
FHittestGrid... |
GetHittestGrid() |
Access the hittest acceleration data structure for this window. |
|
GetInitialDesiredPositionInScreen() |
||
|
GetInitialDesiredSizeInScreen() |
||
|
GetIsHDR() |
||
|
FSlateLayout... |
GetLocalToScreenTransform() |
|
|
FSlateLayout... |
GetLocalToWindowTransform() |
|
|
GetMorphTargetPosition() |
||
|
GetMorphTargetShape() |
||
|
TSharedPtr< ... |
GetNativeWindow() |
|
|
TSharedPtr< ... |
GetNativeWindow() |
|
|
GetNonMaximizedRectInScreen() |
||
|
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() |
|
|
GetPositionInScreen() |
||
|
GetRectInScreen() |
||
|
GetSizeInScreen() |
||
|
FWindowSizeL... |
GetSizeLimits() |
Optional constraints on min and max sizes that this window can be. |
|
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() |
|
|
GetType() |
Grabs the window type |
|
|
TSharedPtr< ... |
GetViewport() |
|
|
GetViewportSize() |
Returns the viewport size, taking into consideration if the window size should drive the viewport size |
|
|
GetWidgetFocusedOnDeactivate() |
Returns widget last focused on deactivate |
|
|
GetWindowBorderSize ( |
Returns the margins used for the window border. This varies based on whether it's maximized or not. |
|
|
GetWindowGeometryInScreen() |
Get the Geometry that describes this window. |
|
|
GetWindowGeometryInWindow() |
||
|
EWindowMode:... |
GetWindowMode() |
|
|
GetWindowSizeFromClientSize |
For a given client size, calculate the window size required to accommodate any potential non-OS borders and title bars |
|
|
GetWindowVisibility() |
Windows that are not hittestable should not show up in the hittest grid. |
|
|
HACK_ForceToFront() |
Force a window to front even if a different application is in front. |
|
|
HasActiveChildren() |
Are any of our child windows active? |
|
|
HasActiveParent() |
Are any of our parent windows active? |
|
|
HasCloseBox() |
||
|
HasFullWindowOverlayContent() |
Checks to see if there is content assigned as a full window overlay |
|
|
HasMaximizeBox() |
||
|
HasMinimizeBox() |
||
|
HasOSWindowBorder() |
||
|
HasOverlay() |
Check whether we have a full window overlay, used to draw content over the entire window. |
|
|
HasSizingFrame() |
||
|
HideWindow() |
Make the window invisible |
|
|
InitialMaximize() |
Maximize the window if bInitiallyMaximized is set |
|
|
InitialMinimize() |
Maximize the window if bInitiallyMinimized is set |
|
|
IsActive() |
Is this window active? Are any of our child windows active? |
|
|
IsAutosized() |
||
|
IsDescendantOf ( |
Returns whether or not this window is a descendant of the specfied parent window |
|
|
IsDrawingEnabled() |
||
|
IsFocusedInitially() |
||
|
IsManualManageDPIChanges() |
||
|
IsMirrorWindow() |
||
|
IsModalWindow() |
||
|
IsMorphing() |
||
|
IsMorphingSize() |
||
|
IsRegularWindow() |
||
|
IsScreenspaceMouseWithin ( |
||
|
IsTopmostWindow() |
||
|
IsUserSized() |
||
|
IsViewportSizeDrivenByWindow() |
Returns whether or not the viewport and window size should be linked together. |
|
|
IsVirtualWindow() |
||
|
IsVisible() |
||
|
IsWindowMaximized() |
||
|
IsWindowMinimized() |
||
|
TSharedRef< ... |
MakeCursorDecorator() |
Make cursor decorator window |
|
TSharedRef< ... |
MakeNotificationWindow() |
Make a notification window |
|
TSharedRef< ... |
MakeStyledCursorDecorator ( |
Make cursor decorator window with a non-default style |
|
TSharedRef< ... |
MakeToolTipWindow() |
Make a tool tip window |
|
TSharedRef< ... |
MakeWindowTitleBar ( |
Returns swindow title bar widgets. |
|
Maximize() |
Windows functions |
|
|
Minimize() |
||
|
MorphToPosition ( |
Animate the window to TargetOpacity and TargetPosition over a short period of time |
|
|
MorphToShape ( |
Animate the window to TargetOpacity and TargetShape over a short period of time |
|
|
MoveWindowTo ( |
Relocate the window to a screenspace position specified by NewPosition |
|
|
NotifyWindowBeingDestroyed() |
Calls the OnWindowClosed delegate when this window is about to be closed |
|
|
OnIsActiveChanged ( |
The system will call this method to notify the window that it has been places in the foreground or background. |
|
|
PaintWindow ( |
Paint the window and all of its contents. |
|
|
ProcessWindowInvalidation() |
Process the invalidation of the widget contained by the window in GlobalInvalidation. |
|
|
RemoveDescendantWindow ( |
Remove DescendantToRemove from this window's children or their children. |
|
|
RemoveOverlaySlot ( |
Removes a widget that is being drawn over the entire window |
|
|
RemovePopupLayerSlot ( |
Counterpart to AddPopupLayerSlot |
|
|
RequestDestroyWindow() |
Request that this window be destroyed. |
|
|
ReshapeWindow ( |
Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize |
|
|
ReshapeWindow |
Relocate the window to a screenspace position specified by NewPosition and resize it to NewSize |
|
|
Resize ( |
Resize the window to be dpi scaled NewClientSize immediately |
|
|
Restore() |
||
|
SetAllowFastUpdate ( |
||
|
SetAsModalWindow() |
Set modal window related flags - called by Slate app code during FSlateApplication::AddModalWindow() |
|
|
SetCachedScreenPosition ( |
Sets the actual screen position of the window. THIS SHOULD ONLY BE CALLED BY THE OS |
|
|
SetCachedSize ( |
Sets the actual size of the window. THIS SHOULD ONLY BE CALLED BY THE OS |
|
|
SetContent ( |
Sets the widget content for this window |
|
|
SetDPIScaleFactor ( |
Overrides the DPI scale factor of the native window |
|
|
SetFullWindowOverlayContent ( |
Sets a widget to use as a full window overlay, or clears an existing widget if set. |
|
|
SetIndependentViewportSize ( |
Sets the viewport size independently of the window size, if non-zero. |
|
|
SetIsHDR ( |
||
|
SetManualManageDPIChanges ( |
Will inform the native window that we need to handle any DPI changes from within the application |
|
|
SetMirrorWindow ( |
Set mirror window flag |
|
|
SetNativeWindow ( |
Sets the native OS window associated with this SWindow |
|
|
SetNativeWindowButtonsVisibility ( |
Shows or hides native window buttons on platforms that use them |
|
|
SetOnWindowClosed ( |
Sets the delegate to execute right before the window is closed |
|
|
SetOnWindowMoved ( |
Sets the delegate to execute right after the window has been moved |
|
|
SetOnWorldSwitchHack ( |
Sets the delegate to call when switching worlds in before ticking,drawing, or sending messages to widgets in this window |
|
|
SetOpacity ( |
Sets the opacity of this window |
|
|
SetRequestDestroyWindowOverride ( |
Sets the delegate to override RequestDestroyWindow |
|
|
SetSizingRule ( |
Should this window automatically derive its size based on its content or be user-drive? |
|
|
SetTitle ( |
Sets the current window title |
|
|
SetTitleBar ( |
||
|
SetViewport ( |
||
|
SetViewportSizeDrivenByWindow ( |
Sets whether or not the viewport size should be driven by the window's size. |
|
|
SetWidgetToFocusOnActivate ( |
Sets a widget that should become focused when this window is next activated |
|
|
SetWindowBackground ( |
||
|
SetWindowMode ( |
Toggle window between window modes (fullscreen, windowed, etc) |
|
|
ShouldPreserveAspectRatio() |
||
|
ShowWindow() |
Make the window visible |
|
|
SizeWillChangeOften() |
||
|
StartMorph() |
Kick off a morph to whatever the target shape happens to be. |
|
|
SwitchWorlds ( |
Hack to switch worlds |
|
|
EActiveTimer... |
TriggerPlayMorphSequence ( |
One-off active timer to trigger a the morph sequence to play |
|
UpdateMorphTargetPosition ( |
Set a new morph position and force the morph to run for at least one frame in order to reach that target |
|
|
UpdateMorphTargetShape ( |
Set a new morph shape and force the morph to run for at least one frame in order to reach that target |
|
|
UpdateWindowContentVisibility() |
Name | Description | ||
---|---|---|---|
|
const FSlate... |
Advanced_AsInvalidationRoot() |
|
|
Advanced_IsInvalidationRoot() |
||
|
Advanced_IsWindow() |
Is this widget derivative of SWindow |
|
|
TSharedRef< ... |
CreateAccessibleWidget() |
|
|
CustomPrepass ( |
||
|
GetDefaultAccessibleText ( |
Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom. |
|
|
OnCursorQuery ( |
Events. |
|
|
TSharedPtr< ... |
OnVisualizePopup ( |
Visualize a new pop-up if possible. |
|
SupportsKeyboardFocus() |
Checks to see if this widget supports keyboard focus. Override this in derived classes. |
|
|
Tick ( |
Ticks this widget with Geometry. |
|
|
ToString() |
Name | Description | ||
---|---|---|---|
|
TSharedRef< ... |
GetRootWidget() |
|
|
PaintSlowPath ( |
Name |
Description |
|
---|---|---|
|
FArguments |
|
|
FMorpher |
Utility for animating the window size. |
Name |
Description |
---|---|
FScopedWidgetSlotArguments |
Name | Description | ||
---|---|---|---|
|
ActivateWhenFirstShown() |
ActivateWhenFirstShown() is deprecated. Please use ActivationPolicy() instead. |