Widgets

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public class

FDragAndDropVerticalBoxOp

Public class

FOverlayPopupLayer

Simple overlay layer to allow content to be laid out on a Window or similar widget.

Public class

FPopupLayer

An FPopupLayer hosts the pop-up content which could be anything you want to appear on top of a widget.

Public struct

FPopupLayerSlot

Popups, tooltips, drag and drop decorators all can be executed without creating a new window.

Public struct

FScopedSwitchWorldHack

Hack to switch worlds in a scope and switch back when we fall out of scope

Public class

FSlateControlledConstruction

Public struct

FWindowTransparency

Proxy structure to handle deprecated construction from bool

Public class

IToolTip

Interface for tool tips.

Public struct

NamedSlotProperty

We want to be able to do: SNew( ContainerWidget ) .SomeContentArea() [ // Child widgets go here ]

Public class

SBoxPanel

A BoxPanel contains one child and describes how that child should be arranged on the screen.

Public class

SCompoundWidget

A CompoundWidget is the base from which most non-primitive widgets should be built.

Public class

SDragAndDropVerticalBox

A Vertical Box Panel. See SBoxPanel for more info.

Public class

SHorizontalBox

A Horizontal Box Panel. See SBoxPanel for more info.

Public class

SLeafWidget

Implements a leaf widget.

Public class

SNullWidget

Implements a widget that can be used as a placeholder.

Public class

SOverlay

Implements an overlay widget.

Public class

SPanel

A Panel arranges its child widgets on the screen.

Public class

SUserWidget

Use SUserWidget as a base class to build aggregate widgets that are not meant to serve as low-level building blocks.

Public class

SVerticalBox

A Vertical Box Panel. See SBoxPanel for more info.

Public class

SWidget

Abstract base class for Slate widgets.

Public class

SWindow

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

Public struct

T0RequiredArgs

Public struct

T1RequiredArgs

Public struct

T2RequiredArgs

Public struct

T3RequiredArgs

Public struct

T4RequiredArgs

Public struct

T5RequiredArgs

Public struct

TAlwaysValidWidget

A widget reference that is always a valid pointer; defaults to SNullWidget

Public struct

TDecl

Utility class used during widget instantiation.

Public struct

TSlateBaseNamedArgs

Base class for named arguments. Provides settings necessary for all widgets.

Public struct

TWidgetAllocator

Normal widgets are allocated directly by the TDecl .

Constants

Name

Description

SWindowDefs::CornerRadius

Size of the corner rounding radius.

SWindowDefs::DefaultTitleBarSize

Height of a Slate window title bar, in pixels

Typedefs

Name

Description

FNoReplyPointerEventHandler

FPointerEventHandler

Delegate type for handling mouse events

FSimpleNoReplyPointerEventHandler

Enums

Name

Description

Public enum

EAccessibleType

Public enum

EAutoCenter

Notification that a window has been activated Notification that a window has been deactivated Notification that a window is about to be closed Notification that a window has been moved Override delegate for RequestDestroyWindow Called when we need to switch game worlds for a window Enum to describe how to auto-center an SWindow

Public enum

EInvalidateWidgetReason

The different types of invalidation that are possible for a widget.

Public enum

ESizingRule

Enum to describe how windows are sized

Functions

Name Description

Public function

 

ENUM_CLASS_FLAGS

This typedefed because EInvalidateWidget will be deprecated soon.

Public function

*FArgume...

 

IsChecked

(
    bool InIsChecked
)

HOW TO DEPRECATE SLATE_ATTRIBUTES

Public function

**&#...

 

IsChecked

(
    ECheckBoxState InIsChecked
)

Public function

TDecl < Widge...

 

MakeTDecl

(
    const ANSICHAR * InType,
    const ANSICHAR * InFile,
    int32 OnLine,
    RequiredArgsPayloadType&& InRequir...
)

Public function

T0RequiredAr ...

 

RequiredArgs::MakeRequiredArgs()

Public function

T1RequiredAr ...

 

RequiredArgs::MakeRequiredArgs

(
    Arg0Type&& InArg0
)

Public function

T2RequiredAr ...

 

RequiredArgs::MakeRequiredArgs

(
    Arg0Type&& InArg0,
    Arg1Type&& InArg1
)

Public function

T3RequiredAr ...

 

RequiredArgs::MakeRequiredArgs

(
    Arg0Type&& InArg0,
    Arg1Type&& InArg1,
    Arg2Type&& InArg2
)

Public function

T4RequiredAr ...

 

RequiredArgs::MakeRequiredArgs

(
    Arg0Type&& InArg0,
    Arg1Type&& InArg1,
    Arg2Type&& InArg2,
    Arg3Type&& InArg3
)

Public function

T5RequiredAr ...

 

RequiredArgs::MakeRequiredArgs

(
    Arg0Type&& InArg0,
    Arg1Type&& InArg1,
    Arg2Type&& InArg2,
    Arg3Type&& InArg3,
    Arg4Type&& InArg4
)

Public function Static

bool

 

SetWidgetAttribute

(
    SWidget & ThisWidget,
    TAttribute < TargetValueType >& Tar...,
    const TAttribute < SourceValueType >...,
    EInvalidateWidgetReason BaseInvalid...
)

Performs the attribute assignment and invalidates the widget minimally based on what actually changed.

Public function

bool

 

SetWidgetAttribute

(
    SWidget & ThisWidget,
    TAttribute < TargetValueType >& Tar...,
    const TAttribute < SourceValueType >...,
    EInvalidateWidgetReason BaseInvalid...
)

Performs the attribute assignment and invalidates the widget minimally based on what actually changed.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback