WidgetBlueprintGeneratedClass.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Binding/DynamicPropertyPath.h"
#include "Engine/BlueprintGeneratedClass.h"
#include "FieldNotificationId.h"
 
#include "WidgetBlueprintGeneratedClass.generated.h"
 
class FAssetRegistryTagsContext;
class UWidget;
class UUserWidget;
class UWidgetAnimation;
class UWidgetBlueprintGeneratedClass;
class UWidgetBlueprintGeneratedClassExtension;
class UWidgetTree;
 
UENUM()
enum class EBindingKind : uint8
{
    Function,
    Property
};
 
USTRUCT()
struct FDelegateRuntimeBinding
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY()
    FString ObjectName;
 
    UPROPERTY()
    FName PropertyName;
 
    UPROPERTY()
    FName FunctionName;
 
    UPROPERTY()
    FDynamicPropertyPath SourcePath;
 
    UPROPERTY()
    EBindingKind Kind = EBindingKind::Property;
};
 
 
#if WITH_EDITOR
class FWidgetBlueprintGeneratedClassDelegates
{
public:
    // delegate for generating widget asset registry tags.
    DECLARE_MULTICAST_DELEGATE_TwoParams(FGetAssetTagsWithContext, const UWidgetBlueprintGeneratedClass*, FAssetRegistryTagsContext);
    DECLARE_MULTICAST_DELEGATE_TwoParams(FGetAssetTags, const UWidgetBlueprintGeneratedClass*, TArray<UObject::FAssetRegistryTag>&);
    DECLARE_MULTICAST_DELEGATE_TwoParams(FCollectSaveOverrides, const UWidgetBlueprintGeneratedClass*, FObjectCollectSaveOverridesContext);
 
    // called by UWidgetBlueprintGeneratedClass::GetAssetRegistryTags()
    static UMG_API FGetAssetTagsWithContext GetAssetTagsWithContext;
    // called by UWidgetBlueprintGeneratedClass::CollectSaveOverrides()
    static UMG_API FCollectSaveOverrides CollectSaveOverrides;
    UE_DEPRECATED(5.4, "Subscribe to GetAssetTagsWithContext instead.")
    static UMG_API FGetAssetTags GetAssetTags;
};
#endif
 
UCLASS(MinimalAPI)
class UWidgetBlueprintGeneratedClass : public UBlueprintGeneratedClass
{
    GENERATED_BODY()
    friend class FWidgetBlueprintCompilerContext;
 
public:
    UMG_API UWidgetBlueprintGeneratedClass();
 
private:
 
    UPROPERTY(DuplicateTransient)
    TObjectPtr<UWidgetTree> WidgetTree;
    
    UPROPERTY()
    TArray<TObjectPtr<UWidgetBlueprintGeneratedClassExtension>> Extensions;
 
    UPROPERTY()
    uint32 bClassRequiresNativeTick :1;
 
#if WITH_EDITORONLY_DATA
public:
    UPROPERTY(Transient)
    uint32 bCanCallPreConstruct : 1;
#endif
 
public:
    UPROPERTY()
    uint32 bCanCallInitializedWithoutPlayerContext : 1;
 
    UPROPERTY()
    TArray< FDelegateRuntimeBinding > Bindings;
 
    UPROPERTY()
    TArray< TObjectPtr<UWidgetAnimation> > Animations;
 
    UPROPERTY()
    TArray<FName> NamedSlots;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TMap<FName, FGuid> NamedSlotsWithID;
 
    UPROPERTY(Transient)
    TSet<FName> NamedSlotsWithContentInSameTree;
 
    UPROPERTY(Transient)
    TSet<FName> NameClashingInHierarchy;
#endif
 
    UPROPERTY(AssetRegistrySearchable)
    TArray<FName> AvailableNamedSlots;
 
    UPROPERTY()
    TArray<FName> InstanceNamedSlots;
    
public:
    UWidgetTree* GetWidgetTreeArchetype() const { return WidgetTree; }
    UMG_API void SetWidgetTreeArchetype(UWidgetTree* InWidgetTree);
 
    UMG_API void GetNamedSlotArchetypeContent(TFunctionRef<void(FName /*SlotName*/, UWidget* /*Content*/)> Predicate) const;
 
    // Walks up the hierarchy looking for a valid widget tree.
    UMG_API UWidgetBlueprintGeneratedClass* FindWidgetTreeOwningClass() const;
 
    //~ Begin UObject interface
    UMG_API virtual void Serialize(FArchive& Ar) override;
    UMG_API virtual void PostLoad() override;
    UMG_API virtual bool NeedsLoadForServer() const override;
#if WITH_EDITOR
    UMG_API virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    UMG_API virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
    UMG_API virtual void CollectSaveOverrides(FObjectCollectSaveOverridesContext SaveContext) override;
#endif
    //~ End UObject interface
 
    UMG_API virtual void PurgeClass(bool bRecompilingOnLoad) override;
 
    UMG_API void InitializeWidget(UUserWidget* UserWidget) const;
 
    static UMG_API void InitializeWidgetStatic(UUserWidget* UserWidget
        , const UClass* InClass
        , UWidgetTree* InWidgetTree
        , const UClass* InWidgetTreeWidgetClass
        , const TArrayView<UWidgetAnimation*> InAnimations
        , const TArrayView<const FDelegateRuntimeBinding> InBindings);
 
    bool ClassRequiresNativeTick() const { return bClassRequiresNativeTick; }
 
#if WITH_EDITOR
    UMG_API void SetClassRequiresNativeTick(bool InClassRequiresNativeTick);
#endif
 
    template<typename ExtensionType>
    ExtensionType* GetExtension(bool bIncludeSuper = true)
    {
        return Cast<ExtensionType>(GetExtension(ExtensionType::StaticClass(), bIncludeSuper));
    }
 
    UMG_API UWidgetBlueprintGeneratedClassExtension* GetExtension(TSubclassOf<UWidgetBlueprintGeneratedClassExtension> InExtensionType, bool bIncludeSuper = true);
 
    UMG_API TArray<UWidgetBlueprintGeneratedClassExtension*> GetExtensions(TSubclassOf<UWidgetBlueprintGeneratedClassExtension> InExtensionType, bool bIncludeSuper = true);
 
    template<typename Predicate>
    void ForEachExtension(Predicate Pred, bool bIncludeSuper = true) const
    {
        for (UWidgetBlueprintGeneratedClassExtension* Extension : Extensions)
        {
            check(Extension);
            Pred(Extension);
        }
        if (bIncludeSuper)
        {
            if (UWidgetBlueprintGeneratedClass* ParentClass = Cast<UWidgetBlueprintGeneratedClass>(GetSuperClass()))
            {
                ParentClass->ForEachExtension(MoveTemp(Pred));
            }
        }
    }
 
private:
    static UMG_API void InitializeBindingsStatic(UUserWidget* UserWidget, const TArrayView<const FDelegateRuntimeBinding> InBindings, const TMap<FName, FObjectPropertyBase*>& InPropertyMap);
    static UMG_API void BindAnimationsStatic(UUserWidget* Instance, const TArrayView<UWidgetAnimation*> InAnimations, const TMap<FName, FObjectPropertyBase*>& InPropertyMap);
 
    UMG_API void GetExtensions(TArray<UWidgetBlueprintGeneratedClassExtension*>& OutExtensions, TSubclassOf<UWidgetBlueprintGeneratedClassExtension> InExtensionType, bool bIncludeSuper);
};