Navigation
Unreal Engine C++ API Reference > Runtime > UMG > Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UVisual
- UWidget
- UDynamicEntryBoxBase
- UCommonBoundActionBar
- UDynamicEntryBox
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
Type | Name | Description | |
---|---|---|---|
![]() |
TSharedPtr< SPanel > | MyPanelWidget | Can be a horizontal, vertical, wrap box, or overlay. |
![]() |
TArray< FVector2D > | SpacingPattern | The looping sequence of entry paddings to apply as entries are created. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UDynamicEntryBoxBase
(
const FObjectInitializer& Initializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | AddEntryChild
(
UUserWidget& ChildWidget |
|
![]() |
FMargin | BuildEntryPadding
(
const FVector2D& DesiredSpacing |
|
![]() |
UUserWidget * | CreateEntryInternal
(
TSubclassOf< UUserWidget > InEntryClass |
|
![]() ![]() |
const TArray< UUserWidget * > & | ||
![]() ![]() |
EDynamicBoxType | GetBoxType () |
|
![]() ![]() |
EHorizontalAlignment | ||
![]() ![]() |
const FSlateChildSize & | ||
![]() ![]() |
const FVector2D & | ||
![]() ![]() |
EVerticalAlignment | ||
![]() ![]() |
int32 | ||
![]() ![]() |
int32 | ||
![]() ![]() |
const FRadialBoxSettings & | ||
![]() ![]() |
TArray< EntryWidgetT * > | ||
![]() |
void | InitEntryBoxType
(
EDynamicBoxType InEntryBoxType |
Initialize EntryBoxType in the constructor before the SWidget is constructed. |
![]() |
void | InitEntryHorizontalAlignment
(
EHorizontalAlignment InEntryHorizontalAlignment |
Initialize EntryHorizontalAlignment in the constructor before the SWidget is constructed. |
![]() |
void | InitEntrySizeRule
(
FSlateChildSize InEntrySizeRule |
Initialize EntrySizeRule in the constructor before the SWidget is constructed. |
![]() |
void | InitEntryVerticalAlignment
(
EVerticalAlignment InEntryVerticalAlignment |
Initialize EntryVerticalAlignment in the constructor before the SWidget is constructed. |
![]() |
void | InitMaxElementSize
(
int32 InMaxElementSize |
Initialize MaxElementSize in the constructor before the SWidget is constructed. |
![]() ![]() |
bool | IsEntryClassValid
(
TSubclassOf< UUserWidget > InEntryClass |
|
![]() |
void | RemoveEntryInternal
(
UUserWidget* EntryWidget |
|
![]() |
void | ResetInternal
(
bool bDeleteWidgets |
Clear out the box entries, optionally deleting the underlying Slate widgets entirely as well. |
![]() |
void | ResetInternal
(
TFunctionRef< void(WidgetT&)> ResetEntryFunc, |
Clear out the box entries, executing the provided reset function for each and optionally deleting the underlying Slate widgets entirely as well. |
![]() |
void | SetEntrySpacing
(
const FVector2D& InEntrySpacing |
|
![]() |
void | SetRadialSettings
(
const FRadialBoxSettings& InSettings |
Overridden from UWidget
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
const FText | Gets the palette category of the widget | |
![]() ![]() |
TSharedRef< SWidget > | Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. | |
![]() ![]() |
void | Applies all properties to the native widget if possible. |
Overridden from UVisual
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | ReleaseSlateResources
(
bool bReleaseChildren |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() |
EDynamicBoxType | EntryBoxType | Direct access to EntryBoxType is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
![]() |
TEnumAsByte< EHorizontalAlignment > | EntryHorizontalAlignment | Direct access to EntryHorizontalAlignment is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
![]() |
FSlateChildSize | EntrySizeRule | Direct access to EntrySizeRule is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
![]() |
FVector2D | EntrySpacing | Direct access to EntrySpacing is deprecated. Please use the getter or setter. |
![]() |
TEnumAsByte< EVerticalAlignment > | EntryVerticalAlignment | Direct access to EntryVerticalAlignment is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
![]() |
int32 | MaxElementSize | Direct access to MaxElementSize is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
![]() |
FRadialBoxSettings | RadialBoxSettings | Direct access to EntrySpacing is deprecated. Please use the getter or setter. |
See Also
UDynamicEntryBoxfor a ready-to-use version