Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Widgets

Light Theme

Dark Theme

Widgets

Choose your operating system:

Windows

macOS

Linux

Filters

Classes

	Name	Description
	FDragAndDropVerticalBoxOp
	FOverlayPopupLayer	Simple overlay layer to allow content to be laid out on a Window or similar widget.
	FPopupLayer	An FPopupLayer hosts the pop-up content which could be anything you want to appear on top of a widget.
	FPopupLayerSlot	Popups, tooltips, drag and drop decorators all can be executed without creating a new window.
	FScopedSwitchWorldHack	Hack to switch worlds in a scope and switch back when we fall out of scope
	FSlateBaseNamedArgs	Base class for named arguments. Provides settings necessary for all widgets.
	FSlateControlledConstruction
	FSlateWidgetClassData
	FSlateWidgetClassRegistration
	FWindowTransparency	Proxy structure to handle deprecated construction from bool
	IToolTip	Interface for tool tips.
	NamedSlotProperty	We want to be able to do: SNew( ContainerWidget ) .SomeContentArea() [ Child widgets go here ]
	SBoxPanel	A BoxPanel contains one child and describes how that child should be arranged on the screen.
	SCompoundWidget	A CompoundWidget is the base from which most non-primitive widgets should be built.
	SDragAndDropVerticalBox	A Vertical Box Panel. See SBoxPanel for more info.
	SHorizontalBox	A Horizontal Box Panel. See SBoxPanel for more info.
	SLeafWidget	Implements a leaf widget.
	SNullWidget	Implements a widget that can be used as a placeholder.
	SOverlay	Implements an overlay widget.
	SPanel	A Panel arranges its child widgets on the screen.
	SUserWidget	Use SUserWidget as a base class to build aggregate widgets that are not meant to serve as low-level building blocks.
	SVerticalBox	A Vertical Box Panel. See SBoxPanel for more info.
	SWidget	Abstract base class for Slate widgets.
	SWindow	SWindow is a platform-agnostic representation of a top-level window.
	T0RequiredArgs
	T1RequiredArgs
	T2RequiredArgs
	T3RequiredArgs
	T4RequiredArgs
	T5RequiredArgs
	TAlwaysValidWidget	A widget reference that is always a valid pointer; defaults to SNullWidget
	TSlateBaseNamedArgs	Base class for named arguments. Provides settings necessary for all widgets.
	TSlateDecl	Utility class used during widget instantiation.
	TWidgetAllocator	Normal widgets are allocated directly by the TSlateDecl.

Constants

Name	Description
SWindowDefs::DefaultTitleBarSize	Height of a Slate window title bar, in pixels

Typedefs

Name	Description
EInvalidateWidget	This typedefed because EInvalidateWidget will be deprecated soon.

Enums

	Name	Description
	EAccessibleType
	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
	EInvalidateWidgetReason	The different types of invalidation that are possible for a widget.
	ESizingRule	Enum to describe how windows are sized

Functions

	Name	Description
FArguments &	IsChecked ( ECheckBoxState InIsChecked )
FArguments &	IsChecked ( bool InIsChecked )	HOW TO DEPRECATE SLATE_ATTRIBUTES
void	LexFromString ( EInvalidateWidgetReason& OutMode, const TCHAR* InBuffer )
FString	LexToString ( EInvalidateWidgetReason Reason )
bool	LexTryParseString ( EInvalidateWidgetReason& OutMode, const TCHAR* InBuffer )
TSlateDecl< ...	MakeTDecl ( const ANSICHAR* InType, const ANSICHAR* InFile, int32 OnLine, RequiredArgsPayloadType&& InRequir... )
constexpr bo...	operator! ( EInvalidateWidgetReason E )
constexpr EI...	operator& ( EInvalidateWidgetReason Lhs, EInvalidateWidgetReason Rhs )
EInvalidateW...	operator&= ( EInvalidateWidgetReason& Lhs, EInvalidateWidgetReason Rhs )
constexpr EI...	operator^ ( EInvalidateWidgetReason Lhs, EInvalidateWidgetReason Rhs )
EInvalidateW...	operator^= ( EInvalidateWidgetReason& Lhs, EInvalidateWidgetReason Rhs )
constexpr EI...	operator\| ( EInvalidateWidgetReason Lhs, EInvalidateWidgetReason Rhs )
EInvalidateW...	operator\|= ( EInvalidateWidgetReason& Lhs, EInvalidateWidgetReason Rhs )
constexpr EI...	operator~ ( EInvalidateWidgetReason E )
WidgetArgsTy...	operator+ ( SlotType& SlotToAdd )
T0RequiredAr...	RequiredArgs::MakeRequiredArgs()
T1RequiredAr...	RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0 )
T2RequiredAr...	RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0, Arg1Type&& InArg1 )
T3RequiredAr...	RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0, Arg1Type&& InArg1, Arg2Type&& InArg2 )
T4RequiredAr...	RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0, Arg1Type&& InArg1, Arg2Type&& InArg2, Arg3Type&& InArg3 )
T5RequiredAr...	RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0, Arg1Type&& InArg1, Arg2Type&& InArg2, Arg3Type&& InArg3, Arg4Type&& InArg4 )
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.
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.

Variables

		Name	Description
	TArray< SlotTyp...	Slots	SLATE_SUPPORTS_SLOT is deprecated. Use SLATE_SLOT_ARGUMENT