1. Epic GamesDeveloper
  3. UDynamicEntryBoxBase

UDynamicEntryBoxBase

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

API > API/Runtime > API/Runtime/UMG

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)

   
Name UDynamicEntryBoxBase
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/DynamicEntryBoxBase.h
Include Path #include "Components/DynamicEntryBoxBase.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UDynamicEntryBoxBase : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UDynamicEntryBoxBase ( const FObjectInitializer& Initializer
)

   Components/DynamicEntryBoxBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
EntryWidgetPool FUserWidgetPool   Components/DynamicEntryBoxBase.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< UUserWidget * > & GetAllEntries()

   Components/DynamicEntryBoxBase.h
  • BlueprintCallable
  • Category=DynamicEntryBox

EDynamicBoxType GetBoxType()

   Components/DynamicEntryBoxBase.h  

EHorizontalAlignment GetEntryHorizontalAlignment()

   Components/DynamicEntryBoxBase.h  

const FSlateChildSize & GetEntrySizeRule()

   Components/DynamicEntryBoxBase.h  

const FVector2D & GetEntrySpacing()

   Components/DynamicEntryBoxBase.h  

EVerticalAlignment GetEntryVerticalAlignment()

   Components/DynamicEntryBoxBase.h  

int32 GetMaxElementSize()

   Components/DynamicEntryBoxBase.h  

int32 GetNumEntries()

   Components/DynamicEntryBoxBase.h
  • BlueprintCallable
  • Category=DynamicEntryBox

const FRadialBoxSettings & GetRadialBoxSettings()

   Components/DynamicEntryBoxBase.h  

TArray< EntryWidgetT * > GetTypedEntries()

   Components/DynamicEntryBoxBase.h  

void SetEntrySpacing ( const FVector2D& InEntrySpacing
)

   Components/DynamicEntryBoxBase.h
  • BlueprintCallable
  • Category=DynamicEntryBox

void SetRadialSettings ( const FRadialBoxSettings& InSettings
)

   Components/DynamicEntryBoxBase.h
  • BlueprintCallable
  • Category=DynamicEntryBox

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/DynamicEntryBoxBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddEntryChild ( UUserWidget& ChildWidget
)

   Components/DynamicEntryBoxBase.h  

FMargin BuildEntryPadding ( const FVector2D& DesiredSpacing
)

   Components/DynamicEntryBoxBase.h  

UUserWidget * CreateEntryInternal ( TSubclassOf< UUserWidget > InEntryClass
)

   Components/DynamicEntryBoxBase.h  

void InitEntryBoxType ( EDynamicBoxType InEntryBoxType
)

 Initialize EntryBoxType in the constructor before the SWidget is constructed. Components/DynamicEntryBoxBase.h  

void InitEntryHorizontalAlignment ( EHorizontalAlignment InEntryHorizontalAlignment
)

 Initialize EntryHorizontalAlignment in the constructor before the SWidget is constructed. Components/DynamicEntryBoxBase.h  

void InitEntrySizeRule ( FSlateChildSize InEntrySizeRule
)

 Initialize EntrySizeRule in the constructor before the SWidget is constructed. Components/DynamicEntryBoxBase.h  

void InitEntryVerticalAlignment ( EVerticalAlignment InEntryVerticalAlignment
)

 Initialize EntryVerticalAlignment in the constructor before the SWidget is constructed. Components/DynamicEntryBoxBase.h  

void InitMaxElementSize ( int32 InMaxElementSize
)

 Initialize MaxElementSize in the constructor before the SWidget is constructed. Components/DynamicEntryBoxBase.h  

bool IsEntryClassValid ( TSubclassOf< UUserWidget > InEntryClass
) const

   Components/DynamicEntryBoxBase.h  

void RemoveEntryInternal ( UUserWidget* EntryWidget,
bool bReleaseSlate
)

   Components/DynamicEntryBoxBase.h  

void ResetInternal ( bool bDeleteWidgets
)

 Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well. Components/DynamicEntryBoxBase.h  

void ResetInternal ( TFunctionRef< void(WidgetT&)> ResetEntryFunc,
bool bDeleteWidgets
)

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

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/DynamicEntryBoxBase.h  

virtual TSharedRef< SWidget > RebuildWidget()

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

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/DynamicEntryBoxBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/DynamicEntryBoxBase.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page