description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


module: UMG

code: virtual void HandleListEntryUnhovered ( [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) & EntryWidget )


code: virtual void HandleListEntryHovered ( [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) & EntryWidget )


description: Get the scroll offset of this view (in items)

code: float GetScrollOffset() const


description: Expected to be bound to the actual ListView widget created by a child class (automatically taken care of via the construction helpers withinITypedUMGListView)

code: void HandleRowReleased ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITableRow](API\Runtime\Slate\Widgets\Views\ITableRow) > & Row )


code: virtual void NativeOnEntryReleased ( [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) * EntryWidget )


code: virtual void NativeOnEntryGenerated ( [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) * EntryWidget )


description: UListView::OnRefreshDesignerItemsfor a usage example

code: virtual void OnRefreshDesignerItems()


description: Implement in child classes to construct the actual ListView Slate widget

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [STableViewBase](API\Runtime\Slate\Widgets\Views\STableViewBase) > RebuildListWidget()


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: template<typename PlaceholderItemT> void RefreshDesignerItems ( [TArray](API\Runtime\Core\Containers\TArray)< PlaceholderItemT > & ListItems, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< PlaceholderItemT()> CreateItemFunc )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: It does NOT account for changes within existing items - that is up to the item to announce and an entry to listen to as needed. This can be onerous to set up for simple cases, so it's also reasonable (though not ideal) to call RegenerateAllEntries when changes within N list items need to be reflected.

code: void RequestRefresh()


description: Scroll the entire list down to the bottom-most item

code: void ScrollToBottom()


code: void SetScrollbarVisibility ( ESlateVisibility InVisibility )


description: Set the scroll offset of this view (in items)

code: void SetScrollOffset ( const float InScrollOffset )


description: Scroll the entire list up to the first item

code: void ScrollToTop()


code: void SetWheelScrollMultiplier ( float NewWheelScrollMultiplier )


description: Full regeneration of all entries in the list. Note that the entryUWidgetinstances will not be destroyed, but they will be released and re-generated. In other words, entry widgets will not receive Destruct/Construct events. They will receive OnEntryReleased andIUserObjectListEntryimplementations will receive OnListItemObjectSet.

code: void RegenerateAllEntries()


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Called at the end of Widget Blueprint compilation. Allows UMG elements to evaluate their default states and determine whether they are acceptable. To trigger compilation failure, add an error to the log. Warnings and notes will be visible, but will not cause compiles to fail.

code: virtual void ValidateCompiledDefaults ( [IWidgetCompilerLog](API\Runtime\UMG\Editor\IWidgetCompilerLog) & CompileLog ) const


code: UListViewBase ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UListViewBase

description:
Example: class UMyUserWidget : publicUUserWidget{ UListView* ListView_InventoryItems;
 }

code: class UListViewBase : public [UWidget](API\Runtime\UMG\Components\UWidget)

AllowOverscroll

type: bool

description: Disable to stop scrollbars from activating inertial overscrolling

bAllowDragging

description: True to allow dragging of row widgets in the list

bEnableRightClickScrolling

description: True to allow right click drag scrolling.

bEnableScrollAnimation

description: True to enable lerped animation when scrolling through the list

type: FOnListEntryGen...

description: Called when a row widget is generated for a list item

type: FOnListEntryRel...

description: Called when a row widget is released by the list (i.e. when it no longer represents a list item)

EntryWidgetClass

type: TSubclassOf<UU...

description: Note: Options for this property can be configured via class and property metadata. See class declaration comment above.

FixedLineScrollOffset

type: float

description: Optional fixed offset (in lines) to always apply to the top/left (depending on orientation) of the list.

GeneratedEntriesToAnnounce

type: TArray<TWeakOb...

description: Normally these are processed byUListViewBase::FinishGeneratingEntrywhich uses World->GetTimerManager() to generate entries next frame However when for example using a listview in editor utility widgets a world there is not reliable and an alternative is to useFTSTicker::GetCoreTicker()

WheelScrollMultiplier

description: The multiplier to apply when wheel scrolling


description: Closes the menu if it is currently open.

code: void Close()


description: Returns the current menu position

code: FVector2D GetMenuPosition() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


code: void HandleMenuOpenChanged ( bool bIsOpen )


description: Initialize ShouldDeferPaintingAfterWindowContent in the constructor before theSWidgetis constructed.

code: void InitShouldDeferPaintingAfterWindowContent ( bool InShouldDeferPaintingAfterWindowContent )


description: Initialize UseApplicationMenuStack in the constructor before theSWidgetis constructed.

code: void InitUseApplicationMenuStack ( bool InUseApplicationMenuStack )


description: Returns whether this menu has open submenus

code: bool HasOpenSubMenus() const


description: Returns true if the popup is open; false otherwise.

code: bool IsOpen() const


description: UPanelWidget.

code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: bool IsUseApplicationMenuStack() const


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Opens the menu if it is not already open

code: void Open ( bool bFocusMenu )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetPlacement ( EMenuPlacement InPlacement )


description: Returns true if we should open the menu due to a click. Sometimes we should not, if the same MouseDownEvent that just closed the menu is about to re-open it because it happens to land on the button.

code: bool ShouldOpenDueToClick() const


description: Toggles the menus open state.

code: void ToggleOpen ( bool bFocusOnOpen )


code: UMenuAnchor ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: FOnMultiLineEditableTextCommittedEvent


className: UMenuAnchor

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

code: class UMenuAnchor : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

MenuClass

type: TSubclassOf< cl...

description: The widget class to spawn when the menu is required.

MyMenuAnchor

type: TSharedPtr<SMe...

OnGetUserMenuContentEvent

type: FGetUserWidget

description: Called when the menu content is requested to allow a more customized handling over what to display

OnMenuOpenChanged

type: FOnMenuOpenChan...

description: Called when the opened state of the menu changes


description: Whether to clear keyboard focus when pressing enter to commit changes


code: const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & GetFont() const


description: Whether to clear text selection when focus is lost


description: Returns the Hint text that appears when there is no text in the text box


description: Return true when this text cannot be modified interactively by the user

code: bool GetIsReadOnly() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description:
Gets the widget text
The widget text


description: Whether to allow the user to back out of changes when they press the escape key

code: bool GetRevertTextOnEscape() const


description: Whether to select all text when the user clicks to give focus on the widget


code: void HandleOnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & Text, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) CommitMethod )


code: void HandleOnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & Text )


description: Set to true to clear keyboard focus when pressing enter to commit changes

code: void SetClearKeyboardFocusOnCommit ( bool bClearKeyboardFocusOnCommit )


description: Set to true to clear text selection when focus is lost

code: void SetClearTextSelectionOnFocusLoss ( bool bClearTextSelectionOnFocusLoss )


code: void SetFont ( [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) InFontInfo )


code: void SetFontMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InMaterial )


code: void SetFontOutlineMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InMaterial )


code: virtual void SetJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


description: Sets the Hint text that appears when there is no text in the text box

code: void SetHintText ( [FText](API\Runtime\Core\Internationalization\FText) InHintText )


description: Sets the Text as Readonly to prevent it from being modified interactively by the user

code: void SetIsReadOnly ( bool bReadOnly )


description: Set to true to select all text when the user clicks to give focus on the widget

code: void SetSelectAllTextWhenFocused ( bool bSelectAllTextWhenFocused )


description: Set to true to allow the user to back out of changes when they press the escape key

code: void SetRevertTextOnEscape ( bool bRevertTextOnEscape )


description: Directly sets the widget text.

code: void SetText ( [FText](API\Runtime\Core\Internationalization\FText) InText )


code: void SetWidgetStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InWidgetStyle )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


className: UMultiLineEditableText

description: Editable text box widget

code: class UMultiLineEditableText : public [UTextLayoutWidget](API\Runtime\UMG\Components\UTextLayoutWidget)

AllowContextMenu

description: Whether the context menu can be opened

HintTextDelegate

type: FGetText

description: A bindable delegate to allow logic to drive the hint text of the widget

type: FText

MyMultiLineEditableText

type: TSharedPtr<SMu...

OnTextChanged

type: FOnMultiLineEdi...

description: Called whenever the text is changed programmatically or interactively by the user

OnTextCommitted

description: Called whenever the text is committed.

VirtualKeyboardDismissAction

type: EVirtualKeyboar...

description: What action should be taken when the virtual keyboard is dismissed?

VirtualKeyboardOptions

type: FVirtualKeyboar...

description: Additional options for the virtual keyboard

WidgetStyle

type: FTextBlockStyle

description: The style


className: FOnMultiLineEditableTextBoxChangedEvent


code: UMultiLineEditableText ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: bool GetIsReadOnly() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description:
Provide a alternative mechanism for error reporting. Gets the widget text
The widget text


code: void HandleOnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & Text, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) CommitMethod )


code: void HandleOnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & Text )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: void SetError ( [FText](API\Runtime\Core\Internationalization\FText) InError )


code: void SetForegroundColor ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) color )


code: void SetIsReadOnly ( bool bReadOnly )


description: TODO UMG Add Set ReadOnlyForegroundColor TODO UMG Add Set BackgroundColor TODO UMG Add Set Font

code: virtual void SetJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


description: Directly sets the widget text. Warning: This will wipe any binding created for the Text property!


code: void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


code: UMultiLineEditableTextBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UMultiLineEditableTextBox

description: Allows a user to enter multiple lines of text

code: class UMultiLineEditableTextBox : public [UTextLayoutWidget](API\Runtime\UMG\Components\UTextLayoutWidget)

AllowContextMenu

type: bool

description: Whether the context menu can be opened

OnTextCommitted

description: Called whenever the text is committed.

VirtualKeyboardOptions

description: Additional options to be used by the virtual keyboard summoned from this widget

type: FEditableTextBo...

description: The style


className: UMWidget::

description: Valid keywords for the UCLASS macro

code: namespace UMWidget { enum { EntryClass, EntryInterface, } }


description: Valid metadata keywords for the UPROPERTY macro

code: namespace UMWidget { enum { DesignerRebuild, BindWidget, BindWidgetOptional, OptionalWidget, BindWidgetAnim, BindWidgetAnimOptional, IsBindableEvent, } }


description: Gets the palette category of the widget


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: BeginUObject.

code: virtual void PostLoad()


code: UNamedSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNamedSlot

description: Allows you to expose an external slot for your user widget. When others reuse your user control, they can put whatever they want in this named slot.

code: class UNamedSlot : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

bExposeOnInstanceOnly

description: Named slots exposed on the instance only follow a slightly different set of rules.

MyBox

type: TSharedPtr<SBo...


code: UNamedSlotInterface ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNamedSlotInterface

code: class UNamedSlotInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetContent() const


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )


code: UNativeWidgetHost ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UNativeWidgetHost

description: A NativeWidgetHost is a container widget that can contain one child slate widget. This should be used when all you need is to nest a native widget inside a UMG widget.

code: class UNativeWidgetHost : public [UWidget](API\Runtime\UMG\Components\UWidget)

NativeWidget

type: TSharedPtr<SWi...


code: [UOverlaySlot](API\Runtime\UMG\Components\UOverlaySlot) * AddChildToOverlay ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


description: Builds the underlying FSlot for the Slate layout panel.

code: virtual void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SOverlay](API\Runtime\SlateCore\Widgets\SOverlay) > InOverlay )


description: Replace the widget at the given index it with a different widget.

code: bool ReplaceOverlayChildAt ( int32 Index, [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


code: UOverlay ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UOverlay

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

code: class UOverlay : public [UPanelWidget](API\Runtime\UMG\Components\UPanelWidget)

MyOverlay

type: TSharedPtr< cla...


description: Get the alignment of the object horizontally.


description: Get padding area between the slot and the content it contains.


description: Get the alignment of the object vertically.


description: Replace the slot content.

code: void ReplaceContent ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: Set padding area between the slot and the content it contains.

code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


description: Set the alignment of the object horizontally.

code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


code: UOverlaySlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Set the alignment of the object vertically.

code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


className: UOverlaySlot

description: Slot for theUOverlaypanel. Allows content to be hover above other content.

code: class UOverlaySlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)

Slot

description: A raw pointer to the slot to allow us to adjust the size, padding...etc at runtime.


description: Called by the designer when a design-time widget is dragged. Returns true if the drag had any effect, false otherwise.

code: virtual bool DragDropPreviewByDesigner ( const FVector2D & LocalCursorPosition, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & XGridSnapSize, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & YGridSnapSize )


description: Called by the designer to "nudge" a widget in a direction. Returns true if the nudge had any effect, false otherwise.

code: virtual bool NudgeByDesigner ( const FVector2D & NudgeDirection, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & GridSnapSize )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( struct [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Applies all properties to the live slot if possible.

code: virtual void SynchronizeProperties()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Called by the designer when a design-time widget needs to have changes to its associated template synchronized.

code: virtual void SynchronizeFromTemplate ( const [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) *const TemplateSlot )


code: UPanelSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Adds a new child widget to the container. Returns the base slot type, requires casting to turn it into the type specific to the container.

code: [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * AddChild ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: Returns true if the panel can accept another child widget.

code: bool CanAddMoreChildren() const


description: Returns true if the panel supports more than one child.

code: bool CanHaveMultipleChildren() const


description: Remove all child widgets from the panel widget.

code: virtual void ClearChildren()


description: Allows general fixups and connections only used at editor time.

code: virtual void ConnectEditorData()


description: Gets all widgets in the container

code: [TArray](API\Runtime\Core\Containers\TArray)< [UWidget](API\Runtime\UMG\Components\UWidget) * > GetAllChildren() const


className: UPanelSlot

description: The base class for all Slots in UMG.

code: class UPanelSlot : public [UVisual](API\Runtime\UMG\Components\UVisual)

Content

type: TObjectPtr< cla...


description:
Gets the widget at an index.
The widget at the given index, or nothing if there is no widget there.

code: [UWidget](API\Runtime\UMG\Components\UWidget) * GetChildAt ( int32 Index ) const


description: Gets number of child widgets in the container.

code: int32 GetChildrenCount() const


description: Gets the index of a specific child widget

code: int32 GetChildIndex ( const [UWidget](API\Runtime\UMG\Components\UWidget) * Content ) const


code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


description: The slots in the widget holding the child widgets of this panel.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * > & GetSlots() const


description: Returns true if there are any child widgets in the panel

code: bool HasAnyChildren() const


description: Returns true if panel contains this widget

code: bool HasChild ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content ) const


description: Inserts a widget at a specific index. This does not update the live slate version, it requires a rebuild of the whole UI to see a change.

code: [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * InsertChildAt ( int32 Index, [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


code: virtual bool LockToPanelOnDrag() const


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * InSlot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * InSlot )


description: BeginUObject.

code: virtual void PostLoad()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildDesignWidget ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > Content )


description:
Removes a specific widget from the container.
true if the widget was found and removed.

code: bool RemoveChild ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description:
Swaps the child widget out of the slot, and replaces it with the new child widget.
true if the CurrentChild was found and the swap occurred, otherwise false.

code: virtual bool ReplaceChild ( [UWidget](API\Runtime\UMG\Components\UWidget) * CurrentChild, [UWidget](API\Runtime\UMG\Components\UWidget) * NewChild )


description: Sets the designer flags on the widget.

code: virtual void SetDesignerFlags ( EWidgetDesignFlags NewFlags )


description: Removes a child by it's index.

code: bool RemoveChildAt ( int32 Index )


description:
Swaps the widget out of the slot at the given index, replacing it with a different widget.
true if the index existed and the child could be replaced.

code: bool ReplaceChildAt ( int32 Index, [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: Moves the child widget from its current index to the new index provided.

code: void ShiftChild ( int32 Index, [UWidget](API\Runtime\UMG\Components\UWidget) * Child )


code: UPanelWidget ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UPanelWidget

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

code: class UPanelWidget : public [UWidget](API\Runtime\UMG\Components\UWidget)

bCanHaveMultipleChildren

description: Can this panel allow for multiple children?

Slots

type: TArray<TObject...


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Called after constructing a new widget from the palette. Allows the widget to perform interesting default setup that we don't want to beUObjectDefaults.

code: virtual void OnCreationFromPalette()


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: void SetBarFillType ( [EProgressBarFillType::Type](API\Runtime\Slate\Widgets\Notifications\EProgressBarFillType__Type) InBarFillType )


code: void SetBarFillStyle ( [EProgressBarFillStyle::Type](API\Runtime\Slate\Widgets\Notifications\EProgressBarFillStyle__Type) InBarFillStyle )


code: const [FProgressBarStyle](API\Runtime\SlateCore\Styling\FProgressBarStyle) & GetWidgetStyle() const


code: void SetBorderPadding ( FVector2D InBorderPadding )


description: Sets the fill color of the progress bar.

code: void SetFillColorAndOpacity ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InColor )


description: Sets the progress bar to show as a marquee.

code: void SetIsMarquee ( bool InbIsMarquee )


description: Sets the current value of the ProgressBar.

code: void SetPercent ( float InPercent )


code: void SetWidgetStyle ( const [FProgressBarStyle](API\Runtime\SlateCore\Styling\FProgressBarStyle) & InStyle )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


code: UProgressBar ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UProgressBar

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

code: class UProgressBar : public [UWidget](API\Runtime\UMG\Components\UWidget)

FillColorAndOpacityDelegate

type: FGetLinearColor

type: FSlateColor

MyProgressBar

type: TSharedPtr<SPr...

description: Native Slate Widget

PercentDelegate

type: FGetFloat

description: A bindable delegate to allow logic to drive the text of the widget


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Get the current dynamic effect material applied to the retainer box.

code: [UMaterialInstanceDynamic](API\Runtime\Engine\Materials\UMaterialInstanceDynamic) * GetEffectMaterial() const


description: Gets the current dynamic effect material applied to the retainer box.

code: const [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * GetEffectMaterialInterface() const


description: Get the total number of phases.

code: int32 GetPhaseCount() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Get the phase to render on.

code: int32 GetPhase() const


description: Initialize Phase in the constructor before theSWidgetis constructed.

code: void InitPhase ( int32 InPhase )


description: Initialize RenderOnInvalidation in the constructor before theSWidgetis constructed.

code: void InitRenderOnInvalidation ( bool InRenderOnInvalidation )


description: Gets the name of the texture parameter to set the render target to on the material.

code: const [FName](API\Runtime\Core\UObject\FName) & GetTextureParameter() const


description: Initialize RenderOnPhase in the constructor before theSWidgetis constructed.

code: void InitRenderOnPhase ( bool InRenderOnPhase )


description: Initialize PhaseCount in the constructor before theSWidgetis constructed.

code: void InitPhaseCount ( int32 InPhaseCount )


description: Get whether this widget should redraw the contents it has every time the phase occurs.

code: bool IsRenderOnPhase() const


description: Get whether this widget should redraw the contents it has every time it receives an invalidation request.

code: bool IsRenderOnInvalidation() const


description: Get the flag for if we retain the render or pass-through.

code: bool IsRetainRendering() const


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Requests the retainer redrawn the contents it has.

code: void RequestRender()


description: Set a new effect material to the retainer widget.

code: void SetEffectMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * EffectMaterial )


code: void SetRenderingPhase ( int32 RenderPhase, int32 TotalPhases )


description: Sets the name of the texture parameter to set the render target to on the material.

code: void SetTextureParameter ( [FName](API\Runtime\Core\UObject\FName) TextureParameter )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Set the flag for if we retain the render or pass-through

code: void SetRetainRendering ( bool bInRetainRendering )


code: URetainerBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: URetainerBox

description: The Retainer Box renders children widgets to a render target first before later rendering that render target to the screen. This allows both frequency and phase to be controlled so that the UI can actually render less often than the frequency of the main game render. It also has the side benefit of allow materials to be applied to the render target after drawing the widgets to apply a simple post process.

code: class URetainerBox : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

bShowEffectsInDesigner

description: If true, retained rendering occurs in designer


description: Remove all overrides made to the default text style and return to the style specified in the style set data table

code: void ClearAllDefaultStyleOverrides()


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IRichTextMarkupParser](API\Runtime\Slate\Framework\Text\IRichTextMarkupParser) > CreateMarkupParser()


code: virtual void CreateDecorators ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > > & OutDecorators )


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IRichTextMarkupWriter](API\Runtime\Slate\Framework\Text\IRichTextMarkupWriter) > CreateMarkupWriter()


code: const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & GetCurrentDefaultTextStyle() const


code: const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & GetDefaultTextStyleOverride() const


code: [URichTextBlockDecorator](API\Runtime\UMG\Components\URichTextBlockDecorator) * GetDecoratorByClass ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [URichTextBlockDecorator](API\Runtime\UMG\Components\URichTextBlockDecorator) > DecoratorClass )


description: Creates a dynamic material for the default font or returns it if it already exists


code: const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & GetDefaultTextStyle() const


description: Returns widgets text.


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


code: [UDataTable](API\Runtime\Engine\Engine\UDataTable) * GetTextStyleSet() const


description: Called after constructing a new widget from the palette. Allows the widget to perform interesting default setup that we don't want to beUObjectDefaults.

code: virtual void OnCreationFromPalette()


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Causes the text to reflow it's layout and re-evaluate any decorators

code: void RefreshTextLayout()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Set the auto wrap for this rich text block

code: void SetAutoWrapText ( bool InAutoTextWrap )


description: Replaces the existing decorators with the list provided

code: void SetDecorators ( const [TArray](API\Runtime\Core\Containers\TArray)< [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [URichTextBlockDecorator](API\Runtime\UMG\Components\URichTextBlockDecorator) >> & InDecoratorClasses )


description: Dynamically set the default font info for this rich text block

code: void SetDefaultFont ( [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) InFontInfo )


description: Sets the color and opacity of the default text in this rich text block

code: void SetDefaultColorAndOpacity ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColorAndOpacity )


description: Sets the color and opacity of the default text drop shadow Note: if opacity is zero no shadow will be drawn

code: void SetDefaultShadowColorAndOpacity ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InShadowColorAndOpacity )


code: void SetDefaultMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InMaterial )


description: Dynamically set the default strike brush for this rich text block

code: void SetDefaultStrikeBrush ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InStrikeBrush )


description: Sets the offset that the default text drop shadow should be drawn at

code: void SetDefaultShadowOffset ( FVector2D InShadowOffset )


description: Wholesale override of the currently established default text style

code: void SetDefaultTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InDefaultTextStyle )


code: virtual void SetJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


description: Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

code: virtual void SetText ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


description: Set the minimum desired width for this rich text block

code: void SetMinDesiredWidth ( float InMinDesiredWidth )


description: Set the text overflow policy for this text block.

code: void SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Set the text transformation policy for this text block.

code: void SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy )


description: Called at the end of Widget Blueprint compilation. Allows UMG elements to evaluate their default states and determine whether they are acceptable. To trigger compilation failure, add an error to the log. Warnings and notes will be visible, but will not cause compiles to fail.

code: virtual void ValidateCompiledDefaults ( [IWidgetCompilerLog](API\Runtime\UMG\Editor\IWidgetCompilerLog) & CompileLog ) const


code: URichTextBlock ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: URichTextBlockDecorator ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > CreateDecorator ( [URichTextBlock](API\Runtime\UMG\Components\URichTextBlock) * InOwner )


className: URichTextBlock

description: The rich text block

code: class URichTextBlock : public [UTextLayoutWidget](API\Runtime\UMG\Components\UTextLayoutWidget)

bOverrideDefaultStyle

description: True to specify the default text style for this rich text inline, overriding any default provided in the style set table

DecoratorClasses

type: TArray<TSubcla...

MyRichTextBlock

type: TSharedPtr<SRi...


className: URichTextBlockDecorator

code: class URichTextBlockDecorator : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: void SetTextStyleSet ( [UDataTable](API\Runtime\Engine\Engine\UDataTable) * NewTextStyleSet )


code: [FRichImageRow](API\Runtime\UMG\Components\FRichImageRow) * FindImageRow ( [FName](API\Runtime\Core\UObject\FName) TagOrId, bool bWarnIfMissing )


code: virtual const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * FindImageBrush ( [FName](API\Runtime\Core\UObject\FName) TagOrId, bool bWarnIfMissing )


className: URichTextBlockImageDecorator

description: Understands the format

code: class URichTextBlockImageDecorator : public [URichTextBlockDecorator](API\Runtime\UMG\Components\URichTextBlockDecorator)


code: URichTextBlockImageDecorator ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: virtual void OnDesignerChanged ( const [FDesignerChangedEventArgs](API\Runtime\UMG\Components\FDesignerChangedEventArgs) & EventArgs )


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetPadBottom ( bool InPadBottom )


code: void SetSidesToPad ( bool InPadLeft, bool InPadRight, bool InPadTop, bool InPadBottom )


className: USafeZone

description: To enable a red band to visualize the safe zone, use this console command, r.DebugSafeZone.Mode controls the debug visualization overlay (0..2, default 0). 0: Do not display the safe zone overlay. 1: Display the overlay for the title safe zone. 2: Display the overlay for the action safe zone.

code: class USafeZone : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

DesignerDpi

type: TOptional< floa...

DesignerSize

type: TOptional< FVec...


code: const EHorizontalAlignment GetHorizontalAlignment() const


description: Builds the underlying slot for the slate button.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SSafeZone](API\Runtime\Slate\Widgets\Layout\SSafeZone) > InSafeZone )


code: const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & GetSafeAreaScale() const


code: const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & GetPadding() const


code: const EVerticalAlignment GetVerticalAlignment() const


code: void SetHorizontalAlignment ( EHorizontalAlignment InHAlign )


code: void SetIsTitleSafe ( bool InIsTitleSafe )


code: void SetPadding ( const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & InPadding )


code: void SetSafeAreaScale ( const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & InSafeAreaScale )


code: void SetVerticalAlignment ( EVerticalAlignment InVAlign )


description: Applies all properties to the live slot if possible.

code: virtual void SynchronizeProperties()


className: USafeZoneSlot

code: class USafeZoneSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnDesignerChanged ( const [FDesignerChangedEventArgs](API\Runtime\UMG\Components\FDesignerChangedEventArgs) & EventArgs )


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetStretch ( [EStretch::Type](API\Runtime\Slate\Widgets\Layout\EStretch__Type) InStretch )


code: void SetStretchDirection ( [EStretchDirection::Type](API\Runtime\Slate\Widgets\Layout\EStretchDirection__Type) InStretchDirection )


code: void SetIgnoreInheritedScale ( bool bInIgnoreInheritedScale )


code: void SetUserSpecifiedScale ( float InUserSpecifiedScale )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


className: UScaleBox

description: Allows you to place content with a desired size and have it scale to meet the constraints placed on this box's alloted area. If you needed to have a background image scale to fill an area but not become distorted with different aspect ratios, or if you need to auto fit some text to an area, this is the control for you.

code: class UScaleBox : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

MyScaleBox

type: TSharedPtr<SSc...


description: Builds the underlying slot for the slate ScaleBox.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SScaleBox](API\Runtime\Slate\Widgets\Layout\SScaleBox) > InScaleBox )


code: UScaleBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


description: Deprecated* SetPadding is deprecated

code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


code: virtual void SynchronizeProperties()


code: UScaleBoxSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UScaleBoxSlot

description: The Slot for theUScaleBoxSlot, contains the widget displayed in a button's single slot

code: class UScaleBoxSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


description: the orientation of the scrollbar.

code: EOrientation GetOrientation() const


description: Sets the padding of the scrollbar.


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: the style of scrollbar.

code: const [FScrollBarStyle](API\Runtime\SlateCore\Styling\FScrollBarStyle) & GetWidgetStyle() const


description: Initialize the orientation of the scrollbar in the constructor before theSWidgetis constructed.

code: void InitOrientation ( EOrientation InOrientation )


description: True if the scrollbar should always show.

code: bool IsAlwaysShowScrollbar() const


description: the thickness of the scrollbar.

code: FVector2D GetThickness() const


description: True if the scrollbar track should always show.

code: bool IsAlwaysShowScrollbarTrack() const


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Sets whether the scrollbar should always show.

code: void SetAlwaysShowScrollbar ( bool bNewValue )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Sets whether the scrollbar track should always show

code: void SetAlwaysShowScrollbarTrack ( bool bNewValue )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Set the offset and size of the track's thumb. Note that the maximum offset is 1.0-ThumbSizeFraction. If the user can view 1/3 of the items in a single page, the maximum offset will be ~0.667f

code: void SetState ( float InOffsetFraction, float InThumbSizeFraction )


description: the padding of the scrollbar.

code: void SetPadding ( const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & InPadding )


description: Sets the thickness of the scrollbar.

code: void SetThickness ( const FVector2D & InThickness )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Instantly stops any inertial scrolling that is currently in progress

code: void EndInertialScrolling()


className: UScrollBar

code: class UScrollBar : public [UWidget](API\Runtime\UMG\Components\UWidget)


description: Sets the style of scrollbar.

code: void SetWidgetStyle ( const [FScrollBarStyle](API\Runtime\SlateCore\Styling\FScrollBarStyle) & InWidgetStyle )


code: UScrollBar ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


code: FVector2D GetScrollbarThickness() const


description: Gets the scroll offset of the scrollbox in Slate Units.

code: float GetScrollOffset() const


description: Gets the scroll offset of the bottom of the ScrollBox in Slate Units.

code: float GetScrollOffsetOfEnd() const


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: const [FScrollBarStyle](API\Runtime\SlateCore\Styling\FScrollBarStyle) & GetWidgetBarStyle() const


description: Gets the fraction currently visible in the scrollbox

code: float GetViewFraction() const


code: float GetWheelScrollMultiplier() const


code: const [FScrollBoxStyle](API\Runtime\SlateCore\Styling\FScrollBoxStyle) & GetWidgetStyle() const


description: Initialize IsFocusable in the constructor before theSWidgetis constructed.

code: void InitFrontPadScrolling ( bool InFrontPadScrolling )


code: void InitBackPadScrolling ( bool InBackPadScrolling )


code: void InitNavigationScrollPadding ( float InNavigationScrollPadding )


code: bool IsAlwaysShowScrollbarTrack() const


code: virtual void OnDescendantSelectedByDesigner ( [UWidget](API\Runtime\UMG\Components\UWidget) * DescendantWidget )


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnDescendantDeselectedByDesigner ( [UWidget](API\Runtime\UMG\Components\UWidget) * DescendantWidget )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Scrolls the ScrollBox to the bottom instantly during the next layout pass.

code: void ScrollToEnd()


description: Scrolls the ScrollBox to the top instantly

code: void ScrollToStart()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetAllowOverscroll ( bool NewAllowOverscroll )


description: Scrolls the ScrollBox to the widget during the next layout pass.

code: void ScrollWidgetIntoView ( [UWidget](API\Runtime\UMG\Components\UWidget) * WidgetToFind, bool AnimateScroll, EDescendantScrollDestination ScrollDestination, float Padding )


code: void SetAllowRightClickDragScrolling ( bool bShouldAllowRightClickDragScrolling )


code: void SetAlwaysShowScrollbar ( bool NewAlwaysShowScrollbar )


code: void SetAlwaysShowScrollbarTrack ( bool NewAlwaysShowScrollbarTrack )


code: void SetAnimateWheelScrolling ( bool bShouldAnimateWheelScrolling )


code: void SetConsumeMouseWheel ( EConsumeMouseWheel NewConsumeMouseWheel )


code: void SetOrientation ( EOrientation NewOrientation )


code: void SetNavigationDestination ( const EDescendantScrollDestination NewNavigationDestination )


code: void SetScrollbarThickness ( const FVector2D & NewScrollbarThickness )


code: void SetScrollbarPadding ( const [FMargin](API\Runtime\SlateCore\Layout\FMargin) & NewScrollbarPadding )


code: void SetScrollBarVisibility ( ESlateVisibility NewScrollBarVisibility )


description: Updates the scroll offset of the scrollbox.

code: void SetScrollOffset ( float NewScrollOffset )


code: void SetScrollWhenFocusChanges ( EScrollWhenFocusChanges NewScrollWhenFocusChanges )


code: void SetWheelScrollMultiplier ( float NewWheelScrollMultiplier )


code: void SetWidgetStyle ( const [FScrollBoxStyle](API\Runtime\SlateCore\Styling\FScrollBoxStyle) & NewWidgetStyle )


code: void SlateHandleUserScrolled ( float CurrentOffset )


code: void SetWidgetBarStyle ( const [FScrollBarStyle](API\Runtime\SlateCore\Styling\FScrollBarStyle) & NewWidgetBarStyle )


code: virtual void SynchronizeProperties()


description: Builds the underlying FSlot for the Slate layout panel.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SScrollBox](API\Runtime\Slate\Widgets\Layout\SScrollBox) > ScrollBox )


code: UScrollBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UScrollBox

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

code: class UScrollBox : public [UPanelWidget](API\Runtime\UMG\Components\UPanelWidget)

DesiredScrollOffset

type: float

description: The desired scroll offset for the underlying scrollbox.

OnUserScrolled

type: FOnUserScrolled...

description: Called when the scroll has changed


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


code: void SetSize ( [FSlateChildSize](API\Runtime\UMG\Components\FSlateChildSize) InSize )


description: Applies all properties to the live slot if possible.


code: UScrollBoxSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UScrollBoxSlot

description: The Slot for theUScrollBox, contains the widget that are scrollable

code: class UScrollBoxSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.

code: void SetHeightOverride ( float InHeightOverride )


description: When specified, will report the MaxDesiredHeight if smaller than the content's desired height.

code: void SetMaxDesiredHeight ( float InMaxDesiredHeight )


code: void SetMaxAspectRatio ( float InMaxAspectRatio )


code: void SetMinAspectRatio ( float InMinAspectRatio )


description: When specified, will report the MinDesiredHeight if larger than the content's desired height.

code: void SetMinDesiredHeight ( float InMinDesiredHeight )


description: When specified, will report the MaxDesiredWidth if smaller than the content's desired width.

code: void SetMaxDesiredWidth ( float InMaxDesiredWidth )


description: When specified, will report the MinDesiredWidth if larger than the content's desired width.

code: void SetMinDesiredWidth ( float InMinDesiredWidth )


code: USizeBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


className: USizeBox

description: A widget that allows you to specify the size it reports to have and desire. Not all widgets report a desired size that you actually desire. Wrapping them in a SizeBox lets you have the Size Box force them to be a particular size.

code: class USizeBox : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)


description: Builds the underlying slot for the slate SizeBox.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SBox](API\Runtime\Slate\Widgets\Layout\SBox) > InSizeBox )


description: When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width.

code: void SetWidthOverride ( float InWidthOverride )


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


code: USizeBoxSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USizeBoxSlot

description: The Slot for theUSizeBoxSlot, contains the widget displayed in a button's single slot

code: class USizeBoxSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


className: USlateAccessibleWidgetData

description: A container for all accessible properties for aUWidgetthat will be passed to the underlyingSWidget. Any property here must also be added to UWidget.h and synchronized. SeeUWidgetfor more information.

code: class USlateAccessibleWidgetData : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

AccessibleBehavior

type: ESlateAccessibl...

AccessibleSummaryText

type: FText

AccessibleSummaryTextDelegate

type: FGetText

bCanChildrenBeAccessible

type: bool


description: Gets the widget that accessibility properties should synchronize to.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetAccessibleWidget() const


description: Gets the maximum value of the slider.

code: float GetMaxValue() const


description: Gets the minimum value of the slider.

code: float GetMinValue() const


description: Get the current value scaled from 0 to 1

code: float GetNormalizedValue() const


description: Getg the slider's orientation.

code: EOrientation GetOrientation() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Gets the color of the handle bar


description: Gets the color of the slider bar.


description: Gets the amount to adjust the value by.

code: float GetStepSize() const


code: void HandleOnControllerCaptureBegin()


description: Get the style used by the widget.

code: const [FSliderStyle](API\Runtime\SlateCore\Styling\FSliderStyle) & GetWidgetStyle() const


description: Gets the current value of the slider.

code: float GetValue() const


code: void HandleOnValueChanged ( float InValue )


description: Gets if the slidable area should be indented to fit the handle.

code: bool HasIndentHandle() const


description: Returns true when the handle is fixed.

code: bool IsLocked() const


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Sets if the slidable area should be indented to fit the handle.

code: void SetIndentHandle ( bool InValue )


description: Sets the handle to be interactive or fixed.

code: void SetLocked ( bool InValue )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Sets the maximum value of the slider.

code: void SetMaxValue ( float InValue )


description: Sets the minimum value of the slider.

code: void SetMinValue ( float InValue )


description: Sets the color of the slider bar.

code: void SetSliderBarColor ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InValue )


description: Sets the color of the handle bar

code: void SetSliderHandleColor ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InValue )


description: Sets the current value of the slider.

code: void SetValue ( float InValue )


description: Set the style used by the widget.

code: void SetWidgetStyle ( const [FSliderStyle](API\Runtime\SlateCore\Styling\FSliderStyle) & InStyle )


code: USlider ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USlider

description: A simple widget that shows a sliding bar with a handle that allows you to control the value in a user define range (between 0..1 by default).

code: class USlider : public [UWidget](API\Runtime\UMG\Components\UWidget)

IsFocusable

description: Should the slider be focusable?

MouseUsesStep

description: Sets new value if mouse position is greater/less than half the step size.

MySlider

type: TSharedPtr<SSl...

description: Native Slate Widget

OnControllerCaptureBegin

type: FOnControllerCa...

description: Invoked when the controller capture begins.

OnControllerCaptureEnd

description: Invoked when the controller capture ends.

OnMouseCaptureBegin

type: FOnMouseCapture...

description: Invoked when the mouse is pressed and a capture begins.

OnMouseCaptureEnd

description: Invoked when the mouse is released and a capture ends.

OnValueChanged

type: FOnFloatValueCh...

description: Called when the value is changed by slider or typing.

RequiresControllerLock

description: Sets whether we have to lock input to change the slider value.

ValueDelegate

description: A bindable delegate to allow logic to drive the value of the widget


description: Sets the slider's orientation.

code: void SetOrientation ( EOrientation InOrientation )


description: Sets the amount to adjust the value by, when using a controller or keyboard.

code: void SetStepSize ( float InValue )


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Sets the size of the spacer

code: void SetSize ( FVector2D InSize )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


code: USpacer ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USpacer

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

code: class USpacer : public [UWidget](API\Runtime\UMG\Components\UWidget)

MySpacer

type: TSharedPtr<SSp...


description: Clear the maximum value that can be specified using the slider.

code: void ClearMaxSliderValue()


description: Clear the maximum value that can be manually set in the spin box.

code: void ClearMaxValue()


description: Clear the minimum value that can be specified using the slider.

code: void ClearMinSliderValue()


description: Clear the minimum value that can be manually set in the spin box.

code: void ClearMinValue()


className: FOnSpinBoxBeginSliderMovement

code: class FOnSpinBoxBeginSliderMovement


className: FOnSpinBoxValueChangedEvent

code: class FOnSpinBoxValueChangedEvent


description: Get whether the spin box uses delta snap on type.

code: bool GetAlwaysUsesDeltaSnap() const


className: FOnSpinBoxValueCommittedEvent

code: class FOnSpinBoxValueCommittedEvent


description: Get whether the keyboard focus is removed from the spin box when the value is committed.


description: Get the current delta for the spin box.

code: float GetDelta() const


description: Get whether the spin box uses the slider feature.

code: bool GetEnableSlider() const


description: Get the font color and opacity that overrides the style font.

code: const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & GetFont() const


description: Get the foreground color of the spin box.


description: Get the justification for value text.

code: const [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) GetJustification() const


description: Get the current Max Fractional Digits for the spin box.

code: int32 GetMaxFractionalDigits() const


description: Get the current maximum value that can be specified using the slider.

code: float GetMaxSliderValue() const


description: Get the minimum width of the spin box.

code: float GetMinDesiredWidth() const


description: Get the current maximum value that can be manually set in the spin box.

code: float GetMaxValue() const


description: Get the current Min Fractional Digits for the spin box.

code: int32 GetMinFractionalDigits() const


description: Get the current minimum value that can be specified using the slider.

code: float GetMinSliderValue() const


description: Get the current minimum value that can be manually set in the spin box.

code: float GetMinValue() const


description: Get whether to select the text in the spin box when the value is committed.

code: bool GetSelectAllTextOnCommit() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Get the current slider exponent for the spin box.

code: float GetSliderExponent() const


description: Set the style for the spin box.

code: const [FSpinBoxStyle](API\Runtime\SlateCore\Styling\FSpinBoxStyle) & GetWidgetStyle() const


code: void HandleOnEndSliderMovement ( float InValue )


code: void HandleOnValueChanged ( float InValue )


code: void HandleOnValueCommitted ( float InValue, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) CommitMethod )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Get the current value of the spin box.

code: float GetValue() const


description: Set whether the spin box uses delta snap on type.

code: void SetAlwaysUsesDeltaSnap ( bool bNewValue )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Set the delta for the spin box.

code: void SetDelta ( float NewValue )


description: Set whether the spin box uses the slider feature.

code: void SetEnableSlider ( bool bNewValue )


description: Set whether the keyboard focus is removed from the spin box when the value is committed.

code: void SetClearKeyboardFocusOnCommit ( bool bNewValue )


description: Set the font color and opacity that overrides the style font.

code: void SetFont ( const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & InFont )


code: void SetForegroundColor ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InForegroundColor )


description: Set the justification for value text.

code: void SetJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


description: Set the maximum value that can be manually set in the spin box.

code: void SetMaxValue ( float NewValue )


description: Set the maximum value that can be specified using the slider.

code: void SetMaxSliderValue ( float NewValue )


description: Set the Max Fractional Digits for the spin box.

code: void SetMaxFractionalDigits ( int32 NewValue )


description: Set the minimum width of the spin box.

code: void SetMinDesiredWidth ( float NewValue )


description: Set the minimum value that can be manually set in the spin box.

code: void SetMinValue ( float NewValue )


description: Set the Min Fractional Digits for the spin box.

code: void SetMinFractionalDigits ( int32 NewValue )


description: Set the minimum value that can be specified using the slider.

code: void SetMinSliderValue ( float NewValue )


description: Set whether to select the text in the spin box when the value is committed.

code: void SetSelectAllTextOnCommit ( bool bNewValue )


description: Set the slider exponent for the spin box.

code: void SetSliderExponent ( float NewValue )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Set the value of the spin box.

code: void SetValue ( float NewValue )


description: Get the style for the spin box.

code: void SetWidgetStyle ( const [FSpinBoxStyle](API\Runtime\SlateCore\Styling\FSpinBoxStyle) & InWidgetStyle )


description: Get the orientation of the stack box.

code: EOrientation GetOrientation() const


className: USpinBox

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

code: class USpinBox : public [UWidget](API\Runtime\UMG\Components\UWidget)

type: uint32:  1

description: Whether the optional MaxSliderValue attribute of the widget is set

description: Whether the optional MaxValue attribute of the widget is set

description: Whether the optional MinSliderValue attribute of the widget is set

description: Whether the optional MinValue attribute of the widget is set

KeyboardType

type: TEnumAsByte<EV...

description: If we're on a platform that requires a virtual keyboard, what kind of keyboard should this widget use?

OnBeginSliderMovement

type: FOnSpinBoxBegin...

description: Called right before the slider begins to move

OnEndSliderMovement

type: FOnSpinBoxValue...

description: Called right after the slider handle is released by the user

OnValueChanged

description: Called when the value is changed interactively by the user

OnValueCommitted

description: Called when the value is committed. Occurs when the user presses Enter or the text box loses focus.

ValueDelegate

type: FGetFloat

description: A bindable delegate to allow logic to drive the value of the widget


code: USpinBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Adds a new child widget to the container.

code: [UStackBoxSlot](API\Runtime\UMG\Components\UStackBoxSlot) * AddChildToStackBox ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Replace the widget at the given index it with a different widget.

code: bool ReplaceStackBoxChildAt ( int32 Index, [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


description: Set the orientation of the stack box. The existing elements will be rearranged.

code: void SetOrientation ( EOrientation InType )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


className: UStackBox

description: No constructors are accessible with public or protected access.

code: class UStackBox : public [UPanelWidget](API\Runtime\UMG\Components\UPanelWidget)


description: Builds the underlying FSlot for the Slate layout panel.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SStackBox](API\Runtime\SlateCore\Widgets\SStackBox) > InBox )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


description: Called by the designer to "nudge" a widget in a direction. Returns true if the nudge had any effect, false otherwise.

code: virtual bool NudgeByDesigner ( const FVector2D & NudgeDirection, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & GridSnapSize )


description: Replace the slot content.

code: void ReplaceContent ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


description: Called by the designer when a design-time widget needs to have changes to its associated template synchronized.

code: virtual void SynchronizeFromTemplate ( const [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) *const TemplateSlot )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


description: Applies all properties to the live slot if possible.


code: void SetSize ( [FSlateChildSize](API\Runtime\UMG\Components\FSlateChildSize) InSize )


description: Gets the widget that accessibility properties should synchronize to.

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetAccessibleWidget() const


className: UStackBoxSlot

description: The Slot for theUStackBox, contains the widget that is flowed vertically or horizontally.

code: class UStackBoxSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


description:
Called by the editor to query whether a property of this object is allowed to be modified. The property editor uses this to disable controls for properties that should not be changed. When overriding this function you should always call the parent implementation first.
true if the property can be modified in the editor, otherwise false

code: virtual bool CanEditChange ( const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * InProperty ) const


description: the color and opacity of the text in this text block.


description: Get the text that should be displayed in the internal Slate widget (allows flags to mutate the display text without modifying the persistent designer property data)

code: virtual [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > GetDisplayText()


description: the font info for this text block.

code: const [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) & GetFont() const


description: Get Label Metadata, which may be as simple as a bit of string data to help identify an anonymous text block.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetLabelMetadata() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: the color and opacity of the text drop shadow.


description: the brush to use to strike through text.

code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & GetStrikeBrush() const


description: the offset that the text drop shadow should be drawn at.

code: FVector2D GetShadowOffset() const


description:
Gets the widget text
The widget text


description: the text overflow policy for this text block.


description: the minimum desired width for this text block

code: float GetMinDesiredWidth() const


code: void HandleTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) CommitteType )


description: the text transformation policy for this text block.


code: virtual void OnBindingChanged ( const [FName](API\Runtime\Core\UObject\FName) & Property )


description: Called after constructing a new widget from the palette. Allows the widget to perform interesting default setup that we don't want to beUObjectDefaults.

code: virtual void OnCreationFromPalette()


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Set the auto wrap for this text block.

code: void SetAutoWrapText ( bool InAutoTextWrap )


description: Sets the color and opacity of the text in this text block

code: void SetColorAndOpacity ( [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) InColorAndOpacity )


description: Dynamically set the font info for this text block

code: void SetFont ( [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) InFontInfo )


code: void SetFontMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InMaterial )


code: virtual void SetJustification ( [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) InJustification )


code: void SetFontOutlineMaterial ( [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * InMaterial )


description: Set the minimum desired width for this text block

code: void SetMinDesiredWidth ( float InMinDesiredWidth )


description: Sets the opacity of the text in this text block

code: void SetOpacity ( float InOpacity )


description: Sets the color and opacity of the text drop shadow Note: if opacity is zero no shadow will be drawn

code: void SetShadowColorAndOpacity ( [FLinearColor](API\Runtime\Core\Math\FLinearColor) InShadowColorAndOpacity )


description: Dynamically set the strike brush for this text block

code: void SetStrikeBrush ( [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) InStrikeBrush )


description: Sets the offset that the text drop shadow should be drawn at

code: void SetShadowOffset ( FVector2D InShadowOffset )


description: Directly sets the widget text. Warning: This will wipe any binding created for the Text property!

code: virtual void SetText ( [FText](API\Runtime\Core\Internationalization\FText) InText )


description: Set the text transformation policy for this text block.

code: void SetTextTransformPolicy ( ETextTransformPolicy InTransformPolicy )


description: Set the text overflow policy for this text block.

code: void SetTextOverflowPolicy ( ETextOverflowPolicy InOverflowPolicy )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


code: UTextBlock ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UTextBlock

description: A simple static text widget.

code: class UTextBlock : public [UTextLayoutWidget](API\Runtime\UMG\Components\UTextLayoutWidget)

bSimpleTextMode

description: If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement.

bWrapWithInvalidationPanel

description: If true, it will automatically wrap this text widget with an invalidation panel

ColorAndOpacityDelegate

type: FGetSlateColor

description: A bindable delegate for the ColorAndOpacity.

type: FSlateColor

type: FLinearColor

MyTextBlock

type: TSharedPtr<STe...

ShadowColorAndOpacityDelegate

type: FGetLinearColor

description: A bindable delegate for the ShadowColorAndOpacity.

TextDelegate

description: A bindable delegate to allow logic to drive the text of the widget


code: UTextLayoutWidget ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & GetImage() const


className: UTextLayoutWidget

description: Base class for all widgets that use a text layout. Contains the common options that should be exposed for the underlying Slate widget.

code: class UTextLayoutWidget : public [UWidget](API\Runtime\UMG\Components\UWidget)

AutoWrapText

type: uint8: 1

description: True if we're wrapping text automatically based on the computed horizontal space for this widget.

Justification

type: TEnumAsByte<ET...

description: How the text should be aligned with the margin.

LineHeightPercentage

type: float

description: The amount to scale each lines height by.

Margin

type: FMargin

description: The amount of blank space left around the edges of text area.

ShapedTextOptions

type: FShapedTextOpti...

description: Controls how the text within this widget should be shaped.

WrappingPolicy

type: ETextWrappingPo...

description: The wrapping policy to use.

WrapTextAt

description: Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.


description: Synchronize the properties with the given widget. A template as the Slate widgets conform to the same API, but don't derive from a common base.

code: template<typename TWidgetType> void SynchronizeTextLayoutProperties ( TWidgetType & InWidget )


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


description: Sets whether the pieces animate horizontally.

code: void SetAnimateHorizontally ( bool bInAnimateHorizontally )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Sets whether the pieces animate vertically.

code: void SetAnimateVertically ( bool bInAnimateVertically )


description: Sets whether the pieces animate their opacity.

code: void SetAnimateOpacity ( bool bInAnimateOpacity )


description: Sets how many pieces there are

code: void SetNumberOfPieces ( int32 InNumberOfPieces )


code: void SetImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & Brush )


code: UThrobber ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UThrobber

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

code: class UThrobber : public [UWidget](API\Runtime\UMG\Components\UWidget)


description: STileViewconstruction helper - useful if using a customSTileViewsubclass

code: template<template< typename > class TileViewT> [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< TileViewT< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > > ConstructTileView()


description: Gets the height of tile entries

code: float GetEntryHeight() const


description: Gets the desired padding for the entry representing the given item

code: virtual [FMargin](API\Runtime\SlateCore\Layout\FMargin) GetDesiredEntryPadding ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Item ) const


description: Gets the width of tile entries

code: float GetEntryWidth() const


description: Implement in child classes to construct the actual ListView Slate widget

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [STableViewBase](API\Runtime\Slate\Widgets\Views\STableViewBase) > RebuildListWidget()


description: Sets the height of every tile entry

code: void SetEntryHeight ( float NewHeight )


description: Sets the width of every tile entry

code: void SetEntryWidth ( float NewWidth )


code: UTileView ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UTileView

description: To make a widget usable as an entry in a TileView, it must inherit from theIUserObjectListEntryinterface.

code: class UTileView : public [UListView](API\Runtime\UMG\Components\UListView)

bWrapHorizontalNavigation

type: bool

description: True to allow left/right navigation to wrap back to the tile on the opposite edge

EntryHeight

description: The height of each tile

EntryWidth

description: The width of each tile

MyTileView

type: TSharedPtr<STi...

TileAlignment

type: EListItemAlignm...

description: The method by which to align the tile entries in the available space for the tile view


description: Collapses all currently expanded items

code: void CollapseAll()


description: Expands all items with children

code: void ExpandAll()


description: STreeViewconstruction helper - useful if using a customSTreeViewsubclass

code: template<template< typename > class TreeViewT> [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< TreeViewT< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > > ConstructTreeView()


description: ListView events - implement these instead of binding handlers directly to a list

code: virtual void OnItemClickedInternal ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Item )


description: TreeViews only. Gets the items to consider children of the given item when generating child entries.

code: virtual void OnGetChildrenInternal ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Item, [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & OutChildren ) const


code: virtual void OnItemExpansionChangedInternal ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Item, bool bIsExpanded )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Attempts to expand/collapse the given item (only relevant if the item has children)

code: void SetItemExpansion ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * Item, bool bExpandItem )


code: template<typename ObjectT> void SetOnGetItemChildren ( ObjectT * InUserObject, typename TSlateDelegates< [UObject](API\Runtime\CoreUObject\UObject\UObject) * >::FOnGetChildren::TMethodPtr< ObjectT > InMethodPtr )


code: template<typename ObjectT> void SetOnGetItemChildren ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< ObjectT > InUserObject, typename TSlateDelegates< [UObject](API\Runtime\CoreUObject\UObject\UObject) * >::FOnGetChildren::TMethodPtr< ObjectT > InMethodPtr )


code: UTreeView ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UTreeView

description: To make a widget usable as an entry in a TreeView, it must inherit from theIUserObjectListEntryinterface.

code: class UTreeView : public [UListView](API\Runtime\UMG\Components\UListView)

MyTreeView

type: TSharedPtr<STr...


code: [UUniformGridSlot](API\Runtime\UMG\Components\UUniformGridSlot) * AddChildToUniformGrid ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content, int32 InRow, int32 InColumn )


code: float GetMinDesiredSlotHeight() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: void SetMinDesiredSlotHeight ( float InMinDesiredSlotHeight )


code: void SetMinDesiredSlotWidth ( float InMinDesiredSlotWidth )


description: Applies all properties to the native widget if possible. This is called after a widget is constructed. It can also be called by the editor to update modified state, so ensure all initialization to a widgets properties are performed here, or the property and visual state may become unsynced.

code: virtual void SynchronizeProperties()


code: void SetSlotPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InSlotPadding )


code: UUniformGridPanel ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UUniformGridPanel

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

code: class UUniformGridPanel : public [UPanelWidget](API\Runtime\UMG\Components\UPanelWidget)

MyUniformGridPanel

type: TSharedPtr<SUn...


description: Builds the underlying FSlot for the Slate layout panel.

code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SUniformGridPanel](API\Runtime\Slate\Widgets\Layout\SUniformGridPanel) > GridPanel )


description: Gets the row index of the slot

code: int32 GetRow() const


description: Gets the column index of the slot.

code: int32 GetColumn() const


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description: Called by the designer to "nudge" a widget in a direction. Returns true if the nudge had any effect, false otherwise.

code: virtual bool NudgeByDesigner ( const FVector2D & NudgeDirection, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & GridSnapSize )


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


description: Sets the row index of the slot, this determines what cell the slot is in the panel

code: void SetRow ( int32 InRow )


description: Sets the column index of the slot, this determines what cell the slot is in the panel

code: void SetColumn ( int32 InColumn )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


code: UUniformGridSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Called by the designer when a design-time widget needs to have changes to its associated template synchronized.

code: virtual void SynchronizeFromTemplate ( const [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) *const TemplateSlot )


className: UUniformGridSlot

description: A slot forUUniformGridPanel, these slots all share the same size as the largest slot in the grid.

code: class UUniformGridSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


description: Applies all properties to the live slot if possible.


code: [UVerticalBoxSlot](API\Runtime\UMG\Components\UVerticalBoxSlot) * AddChildToVerticalBox ( [UWidget](API\Runtime\UMG\Components\UWidget) * Content )


code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


description: UPanelWidget.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSlotClass() const


description: Gets the palette category of the widget

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Function implemented by all subclasses ofUWidgetis called when the underlyingSWidgetneeds to be constructed.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: UVerticalBox ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: void BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SVerticalBox](API\Runtime\SlateCore\Widgets\SVerticalBox) > InVerticalBox )


className: UVerticalBox

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

code: class UVerticalBox : public [UPanelWidget](API\Runtime\UMG\Components\UPanelWidget)

MyVerticalBox

type: TSharedPtr< cla...


code: virtual bool NudgeByDesigner ( const FVector2D & NudgeDirection, const [TOptional](API\Runtime\Core\IO\TOptional)< int32 > & GridSnapSize )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


code: void SetHorizontalAlignment ( EHorizontalAlignment InHorizontalAlignment )


code: void SetPadding ( [FMargin](API\Runtime\SlateCore\Layout\FMargin) InPadding )


code: void SetVerticalAlignment ( EVerticalAlignment InVerticalAlignment )


code: void SetSize ( [FSlateChildSize](API\Runtime\UMG\Components\FSlateChildSize) InSize )


code: virtual void SynchronizeFromTemplate ( const [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) *const TemplateSlot )


code: UVerticalBoxSlot ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UVerticalBoxSlot

description: The Slot for theUVerticalBox, contains the widget that is flowed vertically

code: class UVerticalBoxSlot : public [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot)


code: virtual void SynchronizeProperties()


code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetViewportWorld() const


code: const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & GetBackgroundColor() const


description: UPanelWidget.

code: virtual void OnSlotAdded ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual void OnSlotRemoved ( [UPanelSlot](API\Runtime\UMG\Components\UPanelSlot) * Slot )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > RebuildWidget()


code: void SetBackgroundColor ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor )


code: void SetViewRotation ( FRotator Rotation )


code: void SetViewLocation ( FVector Location )


code: [AActor](API\Runtime\Engine\GameFramework\AActor) * Spawn ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [AActor](API\Runtime\Engine\GameFramework\AActor) > ActorClass )


className: UViewport

code: class UViewport : public [UContentWidget](API\Runtime\UMG\Components\UContentWidget)

ShowFlags

type: FEngineShowFlag...

description: Show flags for the engine for this viewport


code: UViewport ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: virtual void ReleaseSlateResources ( bool bReleaseChildren )


description:
Called during saving to determine the load flags to save with the object. If false, this object will be discarded on servers
true if this object should be loaded on servers

code: virtual bool NeedsLoadForServer() const


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


code: UVisual ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UVisual

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

code: class UVisual : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: bool AddBinding ( [FDelegateProperty](API\Runtime\CoreUObject\UObject\FDelegateProperty) * DelegateProperty, [UObject](API\Runtime\CoreUObject\UObject\UObject) * SourceObject, const [FDynamicPropertyPath](API\Runtime\UMG\Binding\FDynamicPropertyPath) & BindingPath )


description: Add a delegate that will be notified when the FieldId is value changed.

code: virtual [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) AddFieldValueChangedDelegate ( [UE::FieldNotification::FFieldId](API\Runtime\FieldNotification\FFieldId) InFieldId, [FFieldValueChangedDelegate](API\Runtime\FieldNotification\INotifyFieldValueChanged\FFieldValueChangedDelegate) InNewDelegate )


description: Broadcast a binary state post change

code: void BroadcastBinaryPostStateChange ( const [FWidgetStateBitfield](API\Runtime\UMG\Binding\States\FWidgetStateBitfield) & StateChange, bool bInValue )


className: BinderClasses

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UPropertyBinding](API\Runtime\UMG\Binding\UPropertyBinding) > > BinderClasses;


description: Broadcast to the registered delegate that the FieldId value changed.

code: virtual void BroadcastFieldValueChanged ( [UE::FieldNotification::FFieldId](API\Runtime\FieldNotification\FFieldId) InFieldId )


description: Broadcast an enum state post change

code: void BroadcastEnumPostStateChange ( const [FWidgetStateBitfield](API\Runtime\UMG\Binding\States\FWidgetStateBitfield) & StateChange )


description: Called by the owning user widget after the slate widget has been created. After the entire widget tree has been initialized, any widget reference that was needed to support navigating to another widget will now be initialized and ready for usage.

code: void BuildNavigation()


description: Allows general fixups and connections only used at editor time.

code: virtual void ConnectEditorData()


className: ConstructMethodType

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SObjectWidget](API\Runtime\UMG\Slate\SObjectWidget) > [UUserWidget](API\Runtime\UMG\Blueprint\UUserWidget) *, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) >)> ConstructMethodType


code: [FSlateColor](API\Runtime\SlateCore\Styling\FSlateColor) ConvertLinearColorToSlateColor ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > InLinearColor ) const