Show / Hide Table of Contents

Namespace UE4.UMG

Classes

AsyncTaskDownloadImage

Async Task Download Image

BackgroundBlur

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.

BackgroundBlurSlot

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

BoolBinding

Bool Binding

Border

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.

BorderSlot

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

BrushBinding

Brush Binding

Button

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.

ButtonSlot

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

CanvasPanel

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.

CanvasPanelSlot

Canvas Panel Slot

CheckBox

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

CheckedStateBinding

Checked State Binding

CircularThrobber

A throbber widget that orients images in a spinning circle.

ColorBinding

Color Binding

ComboBox

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

ComboBoxString

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

ContentWidget

Content Widget

DragDropOperation

This class is the base drag drop operation for UMG, extend it to add additional data and add new functionality.

DynamicEntryBox

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

EditableText

Editable text box widget

EditableTextBox

Allows the user to type in custom text.

ExpandableArea

Expandable Area

FloatBinding

Float Binding

GridPanel

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

GridSlot

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

HorizontalBox

Allows widgets to be laid out in a flow horizontally.

HorizontalBoxSlot

Horizontal Box Slot

Image

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

InputKeySelector

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

Int32Binding

Int 32Binding

InvalidationBox

Invalidate

  • Single Child

ListView

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

ListViewBase

ListViewDesignerPreviewItem

Empty dummy UObject used as the table view item during design time

MenuAnchor

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

MouseCursorBinding

Mouse Cursor Binding

MovieScene2DTransformSection

A transform section

MovieScene2DTransformTrack

Handles manipulation of 2D transforms in a movie scene

MovieSceneMarginSection

A section in a Margin track

MovieSceneMarginTrack

Handles manipulation of FMargins in a movie scene

MovieSceneWidgetMaterialTrack

A material track which is specialized for materials which are owned by widget brushes.

MultiLineEditableText

Editable text box widget

MultiLineEditableTextBox

Allows a user to enter multiple lines of text

NamedSlot

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

NamedSlotInterface

Named Slot Interface

NativeUserListEntry

Native User List Entry

NativeWidgetHost

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

Overlay

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

OverlaySlot

Slot for the UOverlay panel. Allows content to be hover above other content.

PanelSlot

The base class for all Slots in UMG.

PanelWidget

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

ProgressBar

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

PropertyBinding

Property Binding

RetainerBox

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

RichTextBlock

The rich text block

  • Fancy Text

RichTextBlockDecorator

Rich Text Block Decorator

RichTextBlockImageDecorator

SafeZone

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

SafeZoneSlot

Safe Zone Slot

ScaleBox

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

ScaleBoxSlot

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

ScrollBar

Scroll Bar

ScrollBox

An arbitrary scrollable collection of widgets. Great for presenting 10-100 widgets in a list. Doesn't support virtualization.

ScrollBoxSlot

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

SizeBox

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

SizeBoxSlot

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

SlateBlueprintLibrary

Slate Blueprint Library

SlateVectorArtData

Turn static mesh data into Slate's simple vector art format.

Slider

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

Spacer

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

SpinBox

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

TextBinding

Text Binding

TextBlock

A simple static text widget.

TextLayoutWidget

Base class for all widgets that use a text layout.

Throbber

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

TileView

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

TreeView

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

UMGSequencePlayer

UMGSequence Player

UniformGridPanel

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

UniformGridSlot

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

UserListEntry

User List Entry

UserObjectListEntry

User Object List Entry

UserWidget

The user widget is extensible by users through the WidgetBlueprint.

VerticalBox

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

VerticalBoxSlot

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

Viewport

Viewport

VisibilityBinding

Visibility Binding

Visual

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

Widget

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

WidgetAnimation

Widget Animation

WidgetBinding

Widget Binding

WidgetBlueprintGeneratedClass

The widget blueprint generated class allows us to create blueprint-able widgets for UMG at runtime.

WidgetBlueprintLibrary

Widget Blueprint Library

WidgetComponent

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

WidgetInteractionComponent

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

WidgetLayoutLibrary

Widget Layout Library

WidgetNavigation

Widget Navigation

WidgetSwitcher

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

WidgetSwitcherSlot

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

WidgetTree

The widget tree manages the collection of widgets in a blueprint widget.

WindowTitleBarArea

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

WindowTitleBarAreaSlot

The Slot for the UWindowTitleBarArea

WrapBox

Arranges widgets left-to-right.

WrapBoxSlot

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

Structs

AnchorData

Anchor Data

DelegateRuntimeBinding

Delegate Runtime Binding

DynamicPropertyPath

Dynamic Property Path

EventReply

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

MovieScene2DTransformMask

Movie Scene 2DTransform Mask

MovieScene2DTransformSectionTemplate

Movie Scene 2DTransform Section Template

MovieSceneMarginSectionTemplate

Movie Scene Margin Section Template

MovieSceneWidgetMaterialSectionTemplate

Movie Scene Widget Material Section Template

NamedSlotBinding

The state passed into OnPaint that we can expose as a single painting structure to blueprints to allow script code to override OnPaint behavior.

PaintContext

The state passed into OnPaint that we can expose as a single painting structure to blueprints to allow script code to override OnPaint behavior.

RichImageRow

Simple struct for rich text styles

RichTextStyleRow

Simple struct for rich text styles

ShapedTextOptions

Common data for all widgets that use shaped text.

SlateChildSize

A struct exposing size param related properties to UMG.

SlateMeshVertex

Slate Mesh Vertex

WidgetAnimationBinding

A single object bound to a UMG sequence.

WidgetNavigationData

Widget Navigation Data

WidgetTransform

Describes the standard transformation of a widget

Enums

EBindingKind

EBinding Kind

EDesignPreviewSizeMode

EDesign Preview Size Mode

EDragPivot

Controls where the drag widget visual will appear when dragged relative to the pointer performing the drag operation.

EDynamicBoxType

EDynamic Box Type

ESlateSizeRule

The sizing options of UWidgets

ESlateVisibility

Is an entity visible?

EUMGSequencePlayMode

Describes playback modes for UMG sequences.

EVirtualKeyboardType

EVirtual Keyboard Type

EWidgetBlendMode

EWidget Blend Mode

EWidgetDesignFlags

Flags used by the widget designer.

EWidgetGeometryMode

EWidget Geometry Mode

EWidgetInteractionSource

The interaction source for the widget interaction component, e.

EWidgetSpace

EWidget Space

EWidgetTickFrequency

EWidget Tick Frequency

EWidgetTimingPolicy

EWidget Timing Policy

Delegates

DragDropOperation.DragCancelled_delegate

DragDropOperation.Dragged_delegate

DragDropOperation.Drop_delegate

UserListEntry.BP_OnEntryReleased_delegate

UserListEntry.BP_OnItemExpansionChanged_delegate

UserListEntry.BP_OnItemSelectionChanged_delegate

UserObjectListEntry.GetListItemObject_delegate

UserObjectListEntry.OnListItemObjectSet_delegate

UserWidget.Construct_delegate

UserWidget.Destruct_delegate

UserWidget.IsInteractable_delegate

UserWidget.OnAddedToFocusPath_delegate

UserWidget.OnAnalogValueChanged_delegate

UserWidget.OnAnimationFinished_delegate

UserWidget.OnAnimationStarted_delegate

UserWidget.OnDragCancelled_delegate

UserWidget.OnDragDetected_delegate

UserWidget.OnDragEnter_delegate

UserWidget.OnDragLeave_delegate

UserWidget.OnDragOver_delegate

UserWidget.OnDrop_delegate

UserWidget.OnFocusLost_delegate

UserWidget.OnFocusReceived_delegate

UserWidget.OnInitialized_delegate

UserWidget.OnKeyChar_delegate

UserWidget.OnKeyDown_delegate

UserWidget.OnKeyUp_delegate

UserWidget.OnMotionDetected_delegate

UserWidget.OnMouseButtonDoubleClick_delegate

UserWidget.OnMouseButtonDown_delegate

UserWidget.OnMouseButtonUp_delegate

UserWidget.OnMouseCaptureLost_delegate

UserWidget.OnMouseEnter_delegate

UserWidget.OnMouseLeave_delegate

UserWidget.OnMouseMove_delegate

UserWidget.OnMouseWheel_delegate

UserWidget.OnPaint_delegate

UserWidget.OnPreviewKeyDown_delegate

UserWidget.OnPreviewMouseButtonDown_delegate

UserWidget.OnRemovedFromFocusPath_delegate

UserWidget.OnTouchEnded_delegate

UserWidget.OnTouchForceChanged_delegate

UserWidget.OnTouchGesture_delegate

UserWidget.OnTouchMoved_delegate

UserWidget.OnTouchStarted_delegate

UserWidget.PreConstruct_delegate

UserWidget.Tick_delegate

Back to top Generated by DocFX