UDynamicEntryBoxBase

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Components/DynamicEntryBoxBase.h

Include

#include "Components/DynamicEntryBoxBase.h"

Syntax

class UDynamicEntryBoxBase : public UWidget

Remarks

Base for widgets that support a dynamic number of auto-generated entries at both design- and run-time. Contains all functionality needed to create, construct, and cache an arbitrary number of entry widgets, but exposes no means of entry creation or removal It's up to child classes to decide how they want to perform the population (some may do so entirely on their own without exposing a thing)

Variables

Name Description

Protected variable

EDynamicBoxType

 

EntryBoxType

The type of box panel into which created entries are added.

Protected variable

TEnumAsByte< EH...

 

EntryHorizontalAlignment

Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

Protected variable

FSlateChildSize

 

EntrySizeRule

Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.

Protected variable

FVector2D

 

EntrySpacing

The padding to apply between entries in the box.

Protected variable

TEnumAsByte< EV...

 

EntryVerticalAlignment

Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.

Protected variable

int32

 

MaxElementSize

The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.

Protected variable

TSharedPtr< SPa...

 

MyPanelWidget

Can be a horizontal, vertical, wrap box, or overlay.

Protected variable

FRadialBoxSetti...

 

RadialBoxSettings

Settings only relevant to RadialBox

Protected variable

TArray< FVector...

 

SpacingPattern

The looping sequence of entry paddings to apply as entries are created.

Constructors

Name Description

Public function

UDynamicEntryBoxBase

(
    const FObjectInitializer& Initiali...
)

Functions

Name Description

Protected function Virtual

void

 

AddEntryChild

(
    UUserWidget& ChildWidget
)

Protected function

FMargin

 

BuildEntryPadding

(
    const FVector2D& DesiredSpacing
)

Protected function

UUserWidget ...

 

CreateEntryInternal

(
    TSubclassOf< UUserWidget > InEntryC...
)

Public function Const

const TArray...

 

GetAllEntries()

Public function Const

EDynamicBoxT...

 

GetBoxType()

Public function Const

const FVecto...

 

GetEntrySpacing()

Public function Const

int32

 

GetNumEntries()

Public function Const

TArray< Entr...

 

GetTypedEntries()

Protected function Const

bool

 

IsEntryClassValid

(
    TSubclassOf< UUserWidget > InEntryC...
)

Protected function

void

 

RemoveEntryInternal

(
    UUserWidget* EntryWidget
)

Protected function

void

 

ResetInternal

(
    bool bDeleteWidgets
)

Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well.

Protected function

void

 

ResetInternal

(
    TFunctionRef< void> Rese...,
    bool bDeleteWidgets
)

Clear out the box entries, executing the provided reset function for each and optionally deleting the underlying Slate widgets entirely as well.

Public function

void

 

SetEntrySpacing

(
    const FVector2D& InEntrySpacing
)

Public function

void

 

SetRadialSettings

(
    const FRadialBoxSettings& InSettin...
)

Overridden from UWidget

Name Description

Protected function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Protected function Virtual

TSharedRef< ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Protected function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

See Also

UDynamicEntryBox for a ready-to-use version

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss