TextWidgetTypes.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 "Misc/Attribute.h"
#include "Layout/Margin.h"
#include "Components/Widget.h"
#include "Framework/Text/TextLayout.h"
#include "TextWidgetTypes.generated.h"
 
enum class ETextShapingMethod : uint8;
 
USTRUCT(BlueprintType)
struct FShapedTextOptions
{
    GENERATED_USTRUCT_BODY()
 
    UMG_API FShapedTextOptions();
 
    template <typename TWidgetType>
    void SynchronizeShapedTextProperties(TWidgetType& InWidget) const
    {
        InWidget.SetTextShapingMethod(bOverride_TextShapingMethod ? TOptional<ETextShapingMethod>(TextShapingMethod) : TOptional<ETextShapingMethod>());
        InWidget.SetTextFlowDirection(bOverride_TextFlowDirection ? TOptional<ETextFlowDirection>(TextFlowDirection) : TOptional<ETextFlowDirection>());
    }
 
    inline bool operator==(const FShapedTextOptions& Other) const
    {
        return bOverride_TextShapingMethod == Other.bOverride_TextShapingMethod
            && bOverride_TextFlowDirection == Other.bOverride_TextFlowDirection
            && (!bOverride_TextShapingMethod || TextShapingMethod == Other.TextShapingMethod)
            && (!bOverride_TextFlowDirection || TextFlowDirection == Other.TextFlowDirection);
    }
 
    inline bool operator!=(const FShapedTextOptions& Other) const
    {
        return !operator==(Other);
    }
 
    UPROPERTY(EditAnywhere, Category=Localization, meta=(InlineEditConditionToggle))
    uint8 bOverride_TextShapingMethod : 1;
 
    UPROPERTY(EditAnywhere, Category=Localization, meta=(InlineEditConditionToggle))
    uint8 bOverride_TextFlowDirection : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Localization, AdvancedDisplay, meta=(EditCondition="bOverride_TextShapingMethod"))
    ETextShapingMethod TextShapingMethod;
        
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Localization, AdvancedDisplay, meta=(EditCondition="bOverride_TextFlowDirection"))
    ETextFlowDirection TextFlowDirection;
};
 
 
UCLASS(Abstract, BlueprintType, MinimalAPI)
class UTextLayoutWidget : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    bool GetAutoWrapText() const { return AutoWrapText; }
    float GetWrapTextAt() const { return WrapTextAt; }
 
    UFUNCTION(BlueprintSetter)
    UMG_API virtual void SetJustification(ETextJustify::Type InJustification);
 
    UMG_API void SetShapedTextOptions(FShapedTextOptions InShapedTextOptions);
    UMG_API void SetWrappingPolicy(ETextWrappingPolicy InWrappingPolicy);
    UMG_API void SetAutoWrapText(bool InAutoWrapText);
    UMG_API void SetWrapTextAt(float InWrapTextAt);
    UMG_API void SetLineHeightPercentage(float InLineHeightPercentage);
    UMG_API void SetApplyLineHeightToBottomLine(bool InApplyLineHeightToBottomLine);
    UMG_API void SetMargin(const FMargin& InMargin);
 
protected:
    virtual void OnShapedTextOptionsChanged(FShapedTextOptions InShapedTextOptions) {};
    virtual void OnJustificationChanged(ETextJustify::Type InJustification) {};
    virtual void OnWrappingPolicyChanged(ETextWrappingPolicy InWrappingPolicy) {};
    virtual void OnAutoWrapTextChanged(bool InAutoWrapText) {};
    virtual void OnWrapTextAtChanged(float InWrapTextAt) {};
    virtual void OnLineHeightPercentageChanged(float InLineHeightPercentage) {};
    virtual void OnApplyLineHeightToBottomLineChanged(bool InApplyLineHeightToBottomLine) {};
    virtual void OnMarginChanged(const FMargin& InMargin) {};
 
    template <typename TWidgetType>
    void SynchronizeTextLayoutProperties(TWidgetType& InWidget)
    {
        ShapedTextOptions.SynchronizeShapedTextProperties(InWidget);
 
        InWidget.SetJustification(Justification);
        InWidget.SetAutoWrapText(!!AutoWrapText);
        InWidget.SetWrapTextAt(WrapTextAt != 0 ? WrapTextAt : TAttribute<float>());
        InWidget.SetWrappingPolicy(WrappingPolicy);
        InWidget.SetMargin(Margin);
        InWidget.SetLineHeightPercentage(LineHeightPercentage);
        InWidget.SetApplyLineHeightToBottomLine(ApplyLineHeightToBottomLine);
    }
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Localization, AdvancedDisplay, meta=(ShowOnlyInnerProperties))
    FShapedTextOptions ShapedTextOptions;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, BlueprintSetter=SetJustification, Setter, Category=Appearance)
    TEnumAsByte<ETextJustify::Type> Justification;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Wrapping, AdvancedDisplay)
    ETextWrappingPolicy WrappingPolicy;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Wrapping)
    uint8 AutoWrapText:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Appearance, AdvancedDisplay)
    bool ApplyLineHeightToBottomLine;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Wrapping)
    float WrapTextAt;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Appearance, AdvancedDisplay)
    FMargin Margin;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Appearance, AdvancedDisplay)
    float LineHeightPercentage;
 
};