DynamicEntryBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Components/DynamicEntryBoxBase.h"
 
#include "DynamicEntryBox.generated.h"
 
UCLASS(MinimalAPI)
class UDynamicEntryBox : public UDynamicEntryBoxBase
{
    GENERATED_BODY()
 
public:
    TSubclassOf<UUserWidget> GetEntryWidgetClass() const { return EntryWidgetClass; }
    
    template <typename WidgetT = UUserWidget>
    WidgetT* CreateEntry(const TSubclassOf<WidgetT>& ExplicitEntryClass = {})
    {
        TSubclassOf<UUserWidget> EntryClass = ExplicitEntryClass ? ExplicitEntryClass : EntryWidgetClass;
        if (EntryClass && EntryClass->IsChildOf(WidgetT::StaticClass()) && IsEntryClassValid(EntryClass))
        {
            return Cast<WidgetT>(CreateEntryInternal(EntryClass));
        }
        return nullptr;
    }
    
    template <typename WidgetT = UUserWidget>
    void Reset(TFunctionRef<void(WidgetT&)> ResetEntryFunc, bool bDeleteWidgets = false)
    {
        for (UUserWidget* EntryWidget : GetAllEntries())
        {
            if (WidgetT* TypedEntry = Cast<WidgetT>(EntryWidget))
            {
                ResetEntryFunc(*TypedEntry);
            }
        }
 
        Reset(bDeleteWidgets);
    }
 
    UFUNCTION(BlueprintCallable, Category = DynamicEntryBox)
    UMG_API void Reset(bool bDeleteWidgets = false);
 
    UFUNCTION(BlueprintCallable, Category = DynamicEntryBox)
    UMG_API void RemoveEntry(UUserWidget* EntryWidget);
 
    //~ Begin UWidget Interface
#if WITH_EDITOR 
    UMG_API virtual void ValidateCompiledDefaults(class IWidgetCompilerLog& CompileLog) const override;
#endif
    //~ End UWidget Interface
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category = DynamicEntryBox, meta = (ClampMin = 0, ClampMax = 20))
    int32 NumDesignerPreviewEntries = 3;
 
    TFunction<void(UUserWidget*)> OnPreviewEntryCreatedFunc;
#endif
 
    UMG_API virtual void SynchronizeProperties() override;
 
private:
    UFUNCTION(BlueprintCallable, Category = DynamicEntryBox, meta = (DisplayName = "Create Entry", AllowPrivateAccess = true))
    UMG_API UUserWidget* BP_CreateEntry();
 
    UFUNCTION(BlueprintCallable, Category = DynamicEntryBox, meta = (DisplayName = "Create Entry of Class", AllowPrivateAccess = true, DeterminesOutputType = "EntryClass"))
    UMG_API UUserWidget* BP_CreateEntryOfClass(TSubclassOf<UUserWidget> EntryClass);
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = EntryLayout, meta = (AllowPrivateAccess = true))
    TSubclassOf<UUserWidget> EntryWidgetClass;
    
    // Let the details customization manipulate us directly
    friend class FDynamicEntryBoxDetails;
};