1. Epic GamesDeveloper
  3. Widgets

Widgets

Unreal Engine C++ API Reference > Runtime > SlateCore

Filters

Classes

  Type Name Description
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 FSlateBaseNamedArgs Base class for named arguments. Provides settings necessary for all widgets.  
Public class FSlateControlledConstruction    
Public class FSlateWidgetClassData    
Public struct FSlateWidgetClassRegistration    
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 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 SPanel A Panel arranges its child widgets on the screen.  
Public class SStackBox A Stack Box Panel that stack vertically or horizontally.  
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 SWidget HOW TO DEPRECATE SLATE_ATTRIBUTES  
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 TSlateBaseNamedArgs Base class for named arguments. Provides settings necessary for all widgets.  
Public struct TSlateDecl Utility class used during widget instantiation.  

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.
FOnSwitchWorldHack Called when we need to switch game worlds for a window
FOnWindowActivated Notification that a window has been activated
FOnWindowActivatedEvent  
FOnWindowClosed Notification that a window is about to be closed
FOnWindowClosedEvent  
FOnWindowDeactivated Notification that a window has been deactivated
FOnWindowDeactivatedEvent  
FOnWindowMoved Notification that a window has been moved
FRequestDestroyWindowOverride Override delegate for RequestDestroyWindow

Enums

  Type Name Description
Public enum EAccessibleType    
Public enum EAutoCenter 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  
Public enum UEnum EWidgetPixelSnapping The different states of pixel snapping a widget can be in.  

Functions

  Type Name Description
Public function    
Public function void

LexFromString ( EInvalidateWidgetReason& OutMode,
const TCHAR* InBuffer
)

  
Public function bool

LexTryParseString ( EInvalidateWidgetReason& OutMode,
const TCHAR* InBuffer
)

  
Public function TSlateDecl< WidgetType, RequiredArgsPayloadType >

MakeTDecl ( const ANSICHAR* InType,
const ANSICHAR* InFile,
int32 OnLine,
RequiredArgsPayloadType&& InRequiredArgs
)

  
Public function WidgetArgsType &

operator+ ( SlotType& SlotToAdd
)

  
Public function T0RequiredArgs  
Public function T1RequiredArgs< Arg0Type && >

RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0
)

  
Public function T2RequiredArgs< Arg0Type &&, Arg1Type && >

RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0,
Arg1Type&& InArg1
)

  
Public function T3RequiredArgs< Arg0Type &&, Arg1Type &&, Arg2Type && >

RequiredArgs::MakeRequiredArgs ( Arg0Type&& InArg0,
Arg1Type&& InArg1,
Arg2Type&& InArg2
)

  
Public function T4RequiredArgs< Arg0Type &&, Arg1Type &&, Arg2Type &&, Arg3Type && >

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

  
Public function T5RequiredArgs< Arg0Type &&, Arg1Type &&, Arg2Type &&, Arg3Type &&, Arg4Type && >

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

  
Public function Static bool

SetWidgetAttribute ( SWidget& ThisWidget,
TAttribute< TargetValueType >& TargetValue,
const TAttribute< SourceValueType >& SourceValue,
EInvalidateWidgetReason BaseInvalidationReason
)

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

SetWidgetAttribute ( SWidget& ThisWidget,
TAttribute< TargetValueType >& TargetValue,
const TAttribute< SourceValueType >& SourceValue,
EInvalidateWidgetReason BaseInvalidationReason
)

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

Variables

  Type Name Description
Public variable TArray< SlotType * > Slots  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page