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 > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/DynamicEntryBoxBase.h
Include #include "Components/DynamicEntryBoxBase.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
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

  Type Name Description
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly getter EDynamicBoxType EntryBoxType The type of box panel into which created entries are added.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly getter TEnumAsByte< EHorizontalAlignment > EntryHorizontalAlignment Horizontal alignment of generated entries. Horizontal/Vertical/Wrap boxes only.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly getter FSlateChildSize EntrySizeRule Sizing rule to apply to generated entries. Horizontal/Vertical boxes only.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FVector2D EntrySpacing The padding to apply between entries in the box.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly getter TEnumAsByte< EVerticalAlignment > EntryVerticalAlignment Vertical alignment of generated entries. Horizontal/Vertical/Wrap boxes only.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly getter int32 MaxElementSize The maximum size of each entry in the dominant axis of the box. Vertical/Horizontal boxes only.
Protected variable TSharedPtr< SPanel > MyPanelWidget Can be a horizontal, vertical, wrap box, or overlay.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FRadialBoxSettings RadialBoxSettings Settings only relevant to RadialBox
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< FVector2D > SpacingPattern The looping sequence of entry paddings to apply as entries are created.

Constructors

  Type Name Description
Public function  

UDynamicEntryBoxBase ( const FObjectInitializer& Initializer
)

  

Functions

  Type Name Description
Protected function Virtual void

AddEntryChild ( UUserWidget& ChildWidget
)

  
Protected function FMargin

BuildEntryPadding ( const FVector2D& DesiredSpacing
)

  
Protected function UUserWidget *

CreateEntryInternal ( TSubclassOf< UUserWidget > InEntryClass
)

  
Public function Const UFunction BlueprintCallable, Category const TArray< UUserWidget * > &  
Public function Const EDynamicBoxType  
Public function Const EHorizontalAlignment  
Public function Const const FSlateChildSize &  
Public function Const const FVector2D &  
Public function Const EVerticalAlignment  
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const const FRadialBoxSettings &  
Public function Const TArray< EntryWidgetT * >  
Protected function void

InitEntryBoxType ( EDynamicBoxType InEntryBoxType
)

 Initialize EntryBoxType in the constructor before the SWidget is constructed.
Protected function void

InitEntryHorizontalAlignment ( EHorizontalAlignment InEntryHorizontalAlignment
)

 Initialize EntryHorizontalAlignment in the constructor before the SWidget is constructed.
Protected function void

InitEntrySizeRule ( FSlateChildSize InEntrySizeRule
)

 Initialize EntrySizeRule in the constructor before the SWidget is constructed.
Protected function void

InitEntryVerticalAlignment ( EVerticalAlignment InEntryVerticalAlignment
)

 Initialize EntryVerticalAlignment in the constructor before the SWidget is constructed.
Protected function void

InitMaxElementSize ( int32 InMaxElementSize
)

 Initialize MaxElementSize in the constructor before the SWidget is constructed.
Protected function Const bool

IsEntryClassValid ( TSubclassOf< UUserWidget > InEntryClass
)

  
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(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.
Public function UFunction BlueprintCallable, Category void

SetEntrySpacing ( const FVector2D& InEntrySpacing
)

  
Public function UFunction BlueprintCallable, Category void

SetRadialSettings ( const FRadialBoxSettings& InSettings
)

  

Overridden from UWidget

  Type Name Description
Protected function Virtual const FText Gets the palette category of the widget
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Protected function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

See Also

UDynamicEntryBox for a ready-to-use version

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page