FArguments

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

SlateCore

Header

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

Include

#include "Widgets/SWindow.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SWindow >

Constructors

Name Description

Public function

FArguments()

Functions

Name Description

Public function

WidgetArgsTy...

 

ActivationPolicy

(
    EWindowActivationPolicy InArg
)

When should this window be activated upon being shown?

Public function

WidgetArgsTy...

 

AdjustInitialSizeAndPositionForDPIScale

(
    bool InArg
)

If the initial ClientSize and ScreenPosition arguments should be automatically adjusted to account for DPI scale

Public function

WidgetArgsTy...

 

AutoCenter

(
    EAutoCenter InArg
)

The windows auto-centering mode.

Public function

WidgetArgsTy...

 

bDragAnywhere

(
    bool InArg
)

When true, the window can be dragged from anywhere.

Public function

WidgetArgsTy...

 

bManualManageDPI

(
    bool InArg
)

True if this window will self handle any eventual DPI adjustments

Public function

WidgetArgsTy...

 

ClientSize

(
    FVector2D InArg
)

What the initial size of the window should be.

Public function

NamedSlotPro...

 

Content()

Public function

WidgetArgsTy...

 

CreateTitleBar

(
    bool InArg
)

True if we should initially create a traditional title bar area.

Public function

WidgetArgsTy...

 

FocusWhenFirstShown

(
    bool InArg
)

Should this window be focused immediately after it is shown?

Public function

WidgetArgsTy...

 

HasCloseButton

(
    bool InArg
)

Does this window have a close button?

Public function

WidgetArgsTy...

 

InitialOpacity

(
    float InArg
)

The initial opacity of the window

Public function

WidgetArgsTy...

 

IsInitiallyMaximized

(
    bool InArg
)

Is the window initially maximized

Public function

WidgetArgsTy...

 

IsInitiallyMinimized

(
    bool InArg
)

Is the window initially minimized

Public function

WidgetArgsTy...

 

IsPopupWindow

(
    bool InArg
)

True if this should be a 'pop-up' window

Public function

WidgetArgsTy...

 

IsTopmostWindow

(
    bool InArg
)

True if this window should always be on top of all other windows

Public function

WidgetArgsTy...

 

LayoutBorder

(
    FMargin InArg
)

The padding around the edges of the window applied to it's content.

Public function

WidgetArgsTy...

 

MaxHeight

(
    TOptional< float > InArg
)

The biggest height this window can be in Desktop Pixel Units.

Public function

WidgetArgsTy...

 

MaxWidth

(
    TOptional< float > InArg
)

The biggest width this window can be in Desktop Pixel Units.

Public function

WidgetArgsTy...

 

MinHeight

(
    TOptional< float > InArg
)

The smallest height this window can be in Desktop Pixel Units.

Public function

WidgetArgsTy...

 

MinWidth

(
    TOptional< float > InArg
)

The smallest width this window can be in Desktop Pixel Units.

Public function

WidgetArgsTy...

 

SaneWindowPlacement

(
    bool InArg
)

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.

Public function

WidgetArgsTy...

 

ScreenPosition

(
    FVector2D InArg
)

Screen-space position where the window should be initially located.

Public function

WidgetArgsTy...

 

ShouldPreserveAspectRatio

(
    bool InArg
)

Should this window preserve its aspect ratio when resized by user?

Public function

WidgetArgsTy...

 

SizingRule

(
    ESizingRule InArg
)

How the window should be sized

Public function

WidgetArgsTy...

 

Style

(
    const FWindowStyle* InArg
)

Style used to draw this window

Public function

WidgetArgsTy...

 

SupportsMaximize

(
    bool InArg
)

Can this window be maximized?

Public function

WidgetArgsTy...

 

SupportsMinimize

(
    bool InArg
)

Can this window be minimized?

Public function

WidgetArgsTy...

 

SupportsTransparency

(
    FWindowTransparency InArg
)

Should this window support transparency

Public function

WidgetArgsTy...

 

Title

(
    const TAttribute< FText >& InAttri...
)

Title of the window

Public function

WidgetArgsTy...

 

Type

(
    EWindowType InArg
)

Type of this window

Public function

WidgetArgsTy...

 

UseOSWindowBorder

(
    bool InArg
)

Use the default os look for the border of the window

Public function

WidgetArgsTy...

 

UserResizeBorder

(
    FMargin InArg
)

The margin around the edges of the window that will be detected as places the user can grab to resize the window.

Operators

Name Description

Public function

FArguments &

 

operator[]

(
    const TSharedRef< SWidget > InChild
)

Typedefs

Name

Description

WidgetArgsType

Deprecated Functions

Name Description

Public function

FArguments &

 

ActivateWhenFirstShown

(
    bool bActivateWhenFirstShown
)

ActivateWhenFirstShown(bool) is deprecated. Please use ActivationPolicy(EWindowActivationPolicy) instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss