Components

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FAnchorData

Public struct

FDesignerChangedEventArgs

Event args that are sent whenever the designer is changed in some big way, allows for more accurate previews for widgets that need to anticipate things about the size of the screen, or other similar device factors.

Public struct

FEventReply

Allows users to handle events and return information to the underlying UI layer.

Public class

FOnButtonClickedEvent

Public class

FOnButtonHoverEvent

Public class

FOnButtonPressedEvent

Public class

FOnButtonReleasedEvent

Public class

FOnCheckBoxComponentStateChanged

Public class

FOnControllerCaptureBeginEvent

Public class

FOnControllerCaptureEndEvent

Public class

FOnExpandableAreaExpansionChanged

Public class

FOnFloatValueChangedEvent

Public class

FOnGetItemChildrenDynamic

Public class

FOnHoveredWidgetChanged

TODO CenterScreen needs to be able to work with multiple player controllers, perhaps finding the PC via the outer/owner chain? Maybe you need to set the PC that owns this guy? Maybe we should key off the Virtual User Index?

Public class

FOnItemExpansionChangedDynamic

Public class

FOnItemIsHoveredChangedDynamic

Public class

FOnListEntryGeneratedDynamic

Public class

FOnListEntryInitializedDynamic

Public class

FOnListEntryReleasedDynamic

Public class

FOnListItemScrolledIntoViewDynamic

Public class

FOnListItemSelectionChangedDynamic

Public class

FOnMenuOpenChangedEvent

Public class

FOnMouseCaptureBeginEvent

Public class

FOnMouseCaptureEndEvent

Public class

FOnUserScrolledEvent

Public struct

FRichImageRow

Simple struct for rich text styles

Public class

FRichTextDecorator

Public struct

FRichTextStyleRow

Simple struct for rich text styles

Public struct

FShapedTextOptions

Common data for all widgets that use shaped text.

Public class

FSimpleListItemEventDynamic

Public struct

FSlateChildSize

A struct exposing size param related properties to UMG.

Public struct

FUMGViewportCameraTransform

Stores the transformation data for the viewport camera

Public class

FUMGViewportClient

Public struct

FWidgetComponentInstanceData

Public class

INamedSlotInterface

Public class

ITypedUMGListView

ITypedUMGListView

Public class

UBackgroundBlur

A background blur is a container widget that can contain one child widget, providing an opportunity to surround it with adjustable padding and apply a post-process Gaussian blur to all content beneath the widget.

Public class

UBackgroundBlurSlot

The Slot for the UBackgroundBlurSlot, contains the widget displayed in a BackgroundBlur's single slot

Public class

UBorder

A border is a container widget that can contain one child widget, providing an opportunity to surround it with a background image and adjustable padding.

Public class

UBorderSlot

The Slot for the UBorderSlot, contains the widget displayed in a border's single slot

Public class

UButton

The button is a click-able primitive widget to enable basic interaction, you can place any other widget inside a button to make a more complex and interesting click-able element in your UI.

Public class

UButtonSlot

The Slot for the UButtonSlot, contains the widget displayed in a button's single slot

Public class

UCanvasPanel

The canvas panel is a designer friendly panel that allows widgets to be laid out at arbitrary locations, anchored and z-ordered with other children of the canvas.

Public class

UCanvasPanelSlot

Public class

UCheckBox

The checkbox widget allows you to display a toggled state of 'unchecked', 'checked' and 'indeterminable.

Public class

UCircularThrobber

A throbber widget that orients images in a spinning circle.

  • No Children

  • Spinner Progress

Public class

UComboBox

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

Public class

UComboBoxString

The combobox allows you to display a list of options to the user in a dropdown menu for them to select one.

Public class

UContentWidget

Public class

UDynamicEntryBox

A special box panel that auto-generates its entries at both design-time and runtime.

Public class

UDynamicEntryBoxBase

Base for widgets that support a dynamic number of auto-generated entries at both design- and run-time.

Public class

UEditableText

Editable text box widget

Public class

UEditableTextBox

Allows the user to type in custom text.

Public class

UExpandableArea

Public class

UGridPanel

A panel that evenly divides up available space between all of its children.

  • Many Children

Public class

UGridSlot

A slot for UGridPanel, these slots all share the same size as the largest slot in the grid.

Public class

UHorizontalBox

Allows widgets to be laid out in a flow horizontally.

  • Many Children

  • Flow Horizontal

Public class

UHorizontalBoxSlot

Public class

UImage

The image widget allows you to display a Slate Brush, or texture or material in the UI.

Public class

UInputKeySelector

A widget for selecting a single key or a single key with a modifier.

Public class

UInvalidationBox

Invalidate

  • Single Child

  • Caching / Performance

Public class

UListView

A virtualized list that allows up to thousands of items to be displayed.

Public class

UListViewBase

UListViewBase.

Public class

UMenuAnchor

The Menu Anchor allows you to specify an location that a popup menu should be anchored to, and should be summoned from.

Public class

UMultiLineEditableText

Editable text box widget

Public class

UMultiLineEditableTextBox

Allows a user to enter multiple lines of text

Public class

UNamedSlot

Allows you to expose an external slot for your user widget.

Public class

UNamedSlotInterface

Public class

UNativeWidgetHost

A NativeWidgetHost is a container widget that can contain one child slate widget.

Public class

UOverlay

Allows widgets to be stacked on top of each other, uses simple flow layout for content on each layer.

Public class

UOverlaySlot

Slot for the UOverlay panel.

Public class

UPanelSlot

The base class for all Slots in UMG.

Public class

UPanelWidget

The base class for all UMG panel widgets. Panel widgets layout a collection of child widgets.

Public class

UProgressBar

The progress bar widget is a simple bar that fills up that can be restyled to fit any number of uses.

Public class

URetainerBox

The Retainer Box renders children widgets to a render target first before later rendering that render target to the screen.

Public class

URichTextBlock

The rich text block

  • Fancy Text

  • No Children

Public class

URichTextBlockDecorator

Public class

URichTextBlockImageDecorator

Allows you to setup an image decorator that can be configured to map certain keys to certain images.

Public class

USafeZone

The Safe-Zone widget is an essential part of developing a game UI that can run on lots of different non-PC platforms.

Public class

USafeZoneSlot

Public class

UScaleBox

Allows you to place content with a desired size and have it scale to meet the constraints placed on this box's alloted area.

Public class

UScaleBoxSlot

The Slot for the UScaleBoxSlot, contains the widget displayed in a button's single slot

Public class

UScrollBar

Public class

UScrollBox

An arbitrary scrollable collection of widgets.

Public class

UScrollBoxSlot

The Slot for the UScrollBox, contains the widget that are scrollable

Public class

USizeBox

A widget that allows you to specify the size it reports to have and desire.

Public class

USizeBoxSlot

The Slot for the USizeBoxSlot, contains the widget displayed in a button's single slot

Public class

USlider

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

Public class

USpacer

A spacer widget; it does not have a visual representation, and just provides padding between other widgets.

Public class

USpinBox

A numerical entry box that allows for direct entry of the number or allows the user to click and slide the number.

Public class

UTextBlock

A simple static text widget.

  • No Children

  • Text

Public class

UTextLayoutWidget

Base class for all widgets that use a text layout.

Public class

UThrobber

A Throbber widget that shows several zooming circles in a row.

Public class

UTileView

A ListView that presents the contents as a set of tiles all uniformly sized.

Public class

UTreeView

Similar to ListView, but can display a hierarchical tree of elements.

Public class

UUniformGridPanel

A panel that evenly divides up available space between all of its children.

Public class

UUniformGridSlot

A slot for UUniformGridPanel, these slots all share the same size as the largest slot in the grid.

Public class

UVerticalBox

A vertical box widget is a layout panel allowing child widgets to be automatically laid out vertically.

Public class

UVerticalBoxSlot

The Slot for the UVerticalBox, contains the widget that is flowed vertically

Public class

UViewport

Public class

UVisual

The base class for elements in UMG: slots and widgets.

Public class

UWidget

This is the base class for all wrapped Slate controls that are exposed to UObjects.

Public class

UWidgetComponent

The widget component provides a surface in the 3D environment on which to render widgets normally rendered to the screen.

Public class

UWidgetInteractionComponent

This is a component to allow interaction with the Widget Component.

Public class

UWidgetSwitcher

A widget switcher is like a tab control, but without tabs. At most one widget is visible at time.

Public class

UWidgetSwitcherSlot

The Slot for the UWidgetSwitcher, contains the widget that is flowed vertically

Public class

UWindowTitleBarArea

A panel for defining a region of the UI that should allow users to drag the window on desktop platforms.

Public class

UWindowTitleBarAreaSlot

The Slot for the UWindowTitleBarArea

Public class

UWrapBox

Arranges widgets left-to-right.

Public class

UWrapBoxSlot

The Slot for the UWrapBox, contains the widget that is flowed vertically

Enums

Name

Description

Public enum

EDynamicBoxType

Public enum

ESlateAccessibleBehavior

Whether a widget should be included in accessibility, and if so, how its text should be retrieved.

Public enum

ESlateSizeRule::Type

The sizing options of UWidgets

Public enum

ESlateVisibility

Is an entity visible?

Public enum

EVirtualKeyboardType::Type

Public enum

EWidgetBlendMode

Public enum

EWidgetDesignFlags::Type

Flags used by the widget designer.

Public enum

EWidgetGeometryMode

Public enum

EWidgetInteractionSource

The interaction source for the widget interaction component, e.g. where do we try and trace from to try to find a widget under a virtual pointer device.

Public enum

EWidgetSpace

Public enum

EWidgetTimingPolicy

Public enum

EWindowVisibility

Public enum

UMWidget::

Valid metadata keywords for the UPROPERTY macro

Public enum

UMWidget::

Valid keywords for the UCLASS macro

Functions

Name Description

Public function Static

EKeyboardTyp...

 

EVirtualKeyboardType::AsKeyboardType

(
    Type InType
)

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