TypedElementAttributeBinding.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "DataStorage/Handles.h"
#include "Elements/Interfaces/TypedElementDataStorageInterface.h"
#include "Internationalization/Text.h"
#include "Misc/Attribute.h"
#include "TypedElementAttributeBindingText.h"
 
namespace UE::Editor::DataStorage
{
    class ICoreProvider;
 
    class FAttributeBinder
    {
    public:
 
        /* Create an attribute binder for a given row. */
        TYPEDELEMENTFRAMEWORK_API FAttributeBinder(RowHandle InTargetRow);
        
        /* Create an attribute binder for a given row. */
        TYPEDELEMENTFRAMEWORK_API FAttributeBinder(RowHandle InTargetRow, ICoreProvider* InDataStorage);
 
        template <typename AttributeType, TDataColumnType ColumnType>
        TAttribute<AttributeType> BindData(AttributeType ColumnType::* InVariable, const AttributeType& InDefaultValue = AttributeType());
 
        template <typename AttributeType, TDynamicColumnTemplate ColumnType>
        TAttribute<AttributeType> BindData(const FName& InIdentifier, AttributeType ColumnType::* InVariable, const AttributeType& InDefaultValue = AttributeType());
 
        template <typename AttributeType, typename DataType, TDataColumnType ColumnType>
        TAttribute<AttributeType> BindData(DataType ColumnType::* InVariable, TFunction<AttributeType(const DataType&)> InConverter, const DataType& InDefaultValue = DataType());
 
        template <typename AttributeType, typename DataType, TDynamicColumnTemplate ColumnType>
        TAttribute<AttributeType> BindData(const FName& InIdentifier, DataType ColumnType::* InVariable, TFunction<AttributeType(const DataType&)> InConverter, const DataType& InDefaultValue = DataType());
 
        template <typename DataType, TDataColumnType ColumnType, typename FunctionType>
            requires DataStorage::Private::AttributeBinderInvocable<FunctionType, DataType>
        auto BindData(DataType ColumnType::* InVariable, FunctionType&& InConverter, const DataType& InDefaultValue = DataType());
 
        template <typename DataType, TDynamicColumnTemplate ColumnType, typename FunctionType>
            requires DataStorage::Private::AttributeBinderInvocable<FunctionType, DataType>
        auto BindData(const FName& InIdentifier, DataType ColumnType::* InVariable, FunctionType&& InConverter, const DataType& InDefaultValue = DataType());
 
        template <typename AttributeType, TDataColumnType ColumnType>
        TAttribute<AttributeType> BindColumn(TFunction<AttributeType(const ColumnType&)> InConverter);
 
        template <TDataColumnType ColumnType, typename FunctionType>
            requires DataStorage::Private::AttributeBinderColumnInvocable<FunctionType, ColumnType>
        auto BindColumn(FunctionType&& InConverter);
        
        template <typename AttributeType>
        TAttribute<AttributeType> BindColumnData(const TWeakObjectPtr<const UScriptStruct>& InColumnType,
            const TFunction<AttributeType(const TWeakObjectPtr<const UScriptStruct>&, const void*)>& InConverter);
 
        template <typename FunctionType>
            requires DataStorage::Private::AttributeBinderColumnDataInvocable<FunctionType>
        auto BindColumnData(const TWeakObjectPtr<const UScriptStruct>& InColumnType, FunctionType&& InConverter);
 
        template <typename InRetValType, typename... ParamTypes, TDataColumnType ColumnType>
        TDelegate<InRetValType(ParamTypes...)> BindEvent(TDelegate<InRetValType(ParamTypes...)> ColumnType::* InVariable);
 
        template <typename InRetValType, typename... ParamTypes, TDynamicColumnTemplate ColumnType>
        TDelegate<InRetValType(ParamTypes...)> BindEvent(const FName& InIdentifier, TDelegate<InRetValType(ParamTypes...)> ColumnType::* InVariable);
 
        template <TDataColumnType ColumnType>
        TAttribute<FText> BindText(FString ColumnType::* InFStringVariable);
        
        template <TDynamicColumnTemplate ColumnType>
        TAttribute<FText> BindText(const FName& InIdentifier, FString ColumnType::* InFStringVariable);
 
        template <TDataColumnType ColumnType>
        TAttribute<FText> BindText(FName ColumnType::* InFNameVariable);
        
        template <TDynamicColumnTemplate ColumnType>
        TAttribute<FText> BindText(const FName& InIdentifier, FName ColumnType::* InFNameVariable);
 
        TYPEDELEMENTFRAMEWORK_API FTextAttributeFormatted BindTextFormat(FTextFormat Format) const;
        
    private:
 
        // The target row for this binder
        RowHandle TargetRow;
 
        // A ptr to the data storage for quick access
        ICoreProvider* DataStorage;
    };
} // namespace UE::Editor::DataStorage
 
#include "TypedElementAttributeBinding.inl"