TextBlock.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 "Fonts/SlateFontInfo.h"
#include "Styling/SlateColor.h"
#include "Widgets/SWidget.h"
#include "Components/TextWidgetTypes.h"
#include "TextBlock.generated.h"
 
class STextBlock;
class UMaterialInterface;
 
UCLASS(meta=(DisplayName="Text"), MinimalAPI)
class UTextBlock : public UTextLayoutWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    UE_DEPRECATED(5.1, "Direct access to Text is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintGetter="GetText", BlueprintSetter="SetText", Category="Content", meta = (MultiLine = "true"))
    FText Text;
    
    UPROPERTY()
    FGetText TextDelegate;
 
    UE_DEPRECATED(5.1, "Direct access to ColorAndOpacity is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetColorAndOpacity", Category="Appearance")
    FSlateColor ColorAndOpacity;
 
    UPROPERTY()
    FGetSlateColor ColorAndOpacityDelegate;
    
    UE_DEPRECATED(5.1, "Direct access to MinDesiredWidth is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetMinDesiredWidth", Category="Appearance")
    float MinDesiredWidth;
        
    UE_DEPRECATED(5.1, "Direct access to Font is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetFont", Category="Appearance")
    FSlateFontInfo Font;
 
    UE_DEPRECATED(5.1, "Direct access to StrikeBrush is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetStrikeBrush", Category="Appearance")
    FSlateBrush StrikeBrush;
 
    UE_DEPRECATED(5.1, "Direct access to ShadowOffset is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetShadowOffset", Category="Appearance")
    FVector2D ShadowOffset;
 
    UE_DEPRECATED(5.1, "Direct access to ShadowColorAndOpacity is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetShadowColorAndOpacity", Category="Appearance", meta=( DisplayName="Shadow Color" ))
    FLinearColor ShadowColorAndOpacity;
 
    UPROPERTY()
    FGetLinearColor ShadowColorAndOpacityDelegate;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Performance", AdvancedDisplay)
    bool bWrapWithInvalidationPanel;
 
    UE_DEPRECATED(5.1, "Direct access to TextTransformPolicy is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetTextTransformPolicy", Category="Appearance", meta=(DisplayName="Transform Policy"))
    ETextTransformPolicy TextTransformPolicy;
 
    UE_DEPRECATED(5.1, "Direct access to TextOverflowPolicy is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetTextOverflowPolicy", Category="Clipping", AdvancedDisplay, meta = (DisplayName="Overflow Policy"))
    ETextOverflowPolicy TextOverflowPolicy;
 
public:
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="GetText (Text)"))
    UMG_API FText GetText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetText (Text)"))
    UMG_API virtual void SetText(FText InText);
 
    UMG_API FSlateColor GetColorAndOpacity() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetColorAndOpacity(FSlateColor InColorAndOpacity);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetOpacity(float InOpacity);
 
    UMG_API FLinearColor GetShadowColorAndOpacity() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetShadowColorAndOpacity(FLinearColor InShadowColorAndOpacity);
 
    UMG_API FVector2D GetShadowOffset() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetShadowOffset(FVector2D InShadowOffset);
 
    UMG_API const FSlateFontInfo& GetFont() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetFont(FSlateFontInfo InFontInfo);
 
    UMG_API const FSlateBrush& GetStrikeBrush() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetStrikeBrush(FSlateBrush InStrikeBrush);
 
    UMG_API float GetMinDesiredWidth() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetMinDesiredWidth(float InMinDesiredWidth);
    
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetAutoWrapText(bool InAutoTextWrap);
 
    UMG_API ETextTransformPolicy GetTextTransformPolicy() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetTextTransformPolicy(ETextTransformPolicy InTransformPolicy);
 
    UMG_API ETextOverflowPolicy GetTextOverflowPolicy() const;
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetTextOverflowPolicy(ETextOverflowPolicy InOverflowPolicy);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetFontMaterial(UMaterialInterface* InMaterial);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API void SetFontOutlineMaterial(UMaterialInterface* InMaterial);
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API UMaterialInstanceDynamic* GetDynamicFontMaterial();
 
    UFUNCTION(BlueprintCallable, Category="Appearance")
    UMG_API UMaterialInstanceDynamic* GetDynamicOutlineMaterial();
 
protected:
    virtual void OnTextChanged()
    {
    }
 
    virtual void OnFontChanged()
    {
    }
 
public:
    //~ Begin UWidget Interface
    UMG_API virtual void SynchronizeProperties() override;
    //~ End UWidget Interface
 
    //~ Begin UVisual Interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //~ End UVisual Interface
 
#if WITH_EDITOR
    //~ Begin UWidget Interface
    UMG_API virtual const FText GetPaletteCategory() override;
    UMG_API virtual void OnCreationFromPalette() override;
    UMG_API virtual bool CanEditChange(const FProperty* InProperty) const override;
    //~ End UWidget Interface
 
    UMG_API virtual FString GetLabelMetadata() const override;
 
    UMG_API void HandleTextCommitted(const FText& InText, ETextCommit::Type CommitteType);
#endif
 
protected:
    //~ Begin UTextLayoutWidget Interface
    UMG_API virtual void OnShapedTextOptionsChanged(FShapedTextOptions InShapedTextOptions) override;
    UMG_API virtual void OnJustificationChanged(ETextJustify::Type InJustification) override;
    UMG_API virtual void OnWrappingPolicyChanged(ETextWrappingPolicy InWrappingPolicy) override;
    UMG_API virtual void OnAutoWrapTextChanged(bool InAutoWrapText) override;
    UMG_API virtual void OnWrapTextAtChanged(float InWrapTextAt) override;
    UMG_API virtual void OnLineHeightPercentageChanged(float InLineHeightPercentage) override;
    UMG_API virtual void OnApplyLineHeightToBottomLineChanged(bool InApplyLineHeightToBottomLine) override;
    UMG_API virtual void OnMarginChanged(const FMargin& InMargin) override;
    //~ End UTextLayoutWidget Interface
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Performance, AdvancedDisplay, meta=(AllowPrivateAccess = "true", DesignerRebuild))
    bool bSimpleTextMode;
 
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    UMG_API virtual void OnBindingChanged(const FName& Property) override;
    //~ End UWidget Interface
 
    UMG_API virtual TAttribute<FText> GetDisplayText();
 
    UMG_API EVisibility GetTextWarningImageVisibility() const;
 
#if WITH_ACCESSIBILITY
    UMG_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
 
protected:
 
    TSharedPtr<STextBlock> MyTextBlock;
    
    PROPERTY_BINDING_IMPLEMENTATION(FText, Text);
    PROPERTY_BINDING_IMPLEMENTATION(FSlateColor, ColorAndOpacity);
    PROPERTY_BINDING_IMPLEMENTATION(FLinearColor, ShadowColorAndOpacity);
};