RichTextLayoutMarshaller.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "SlateGlobals.h"
#include "Framework/Text/TextLineHighlight.h"
#include "Framework/Text/IRun.h"
#include "Framework/Text/ITextDecorator.h"
#if WITH_FANCY_TEXT
    #include "Framework/Text/BaseTextLayoutMarshaller.h"
#endif
 
class FSlateTextUnderlineLineHighlighter;
class FSlateTextStrikeLineHighlighter;
class IRichTextMarkupParser;
class IRichTextMarkupWriter;
class ISlateStyle;
struct FTextBlockStyle;
 
#if WITH_FANCY_TEXT
 
class FRichTextLayoutMarshaller : public FBaseTextLayoutMarshaller
{
public:
 
    static SLATE_API TSharedRef< FRichTextLayoutMarshaller > Create(TArray< TSharedRef< ITextDecorator > > InDecorators, const ISlateStyle* const InDecoratorStyleSet);
    static SLATE_API TSharedRef< FRichTextLayoutMarshaller > Create(TSharedPtr< IRichTextMarkupParser > InParser, TSharedPtr< IRichTextMarkupWriter > InWriter, TArray< TSharedRef< ITextDecorator > > InDecorators, const ISlateStyle* const InDecoratorStyleSet);
 
    SLATE_API virtual ~FRichTextLayoutMarshaller();
 
    // ITextLayoutMarshaller
    SLATE_API virtual void SetText(const FString& SourceString, FTextLayout& TargetTextLayout) override;
    SLATE_API virtual void GetText(FString& TargetString, const FTextLayout& SourceTextLayout) override;
 
    SLATE_API void SetFontSizeMultiplier(const float NewFontSizeMultiplier);
 
    inline void SetDecorators(TArrayView<TSharedRef<ITextDecorator>> InDecorators)
    {
        Decorators = InDecorators;
    }
 
    inline FRichTextLayoutMarshaller& AppendInlineDecorator(const TSharedRef< ITextDecorator >& DecoratorToAdd)
    {
        InlineDecorators.Add(DecoratorToAdd);
        return *this;
    }
 
    inline void SetDecoratorStyleSet(const ISlateStyle* InStyleSet)
    {
        DecoratorStyleSet = InStyleSet;
    }
 
protected:
 
    SLATE_API FRichTextLayoutMarshaller(TArray< TSharedRef< ITextDecorator > > InDecorators, const ISlateStyle* const InDecoratorStyleSet);
    SLATE_API FRichTextLayoutMarshaller(TSharedPtr< IRichTextMarkupParser > InParser, TSharedPtr< IRichTextMarkupWriter > InWriter, TArray< TSharedRef< ITextDecorator > > InDecorators, const ISlateStyle* const InDecoratorStyleSet);
 
    SLATE_API TSharedPtr< ITextDecorator > TryGetDecorator(const FString& Line, const FTextRunParseResults& TextRun) const;
 
    SLATE_API virtual void AppendRunsForText(
        const int32 LineIndex,
        const FTextRunParseResults& TextRun, 
        const FString& ProcessedString, 
        const FTextBlockStyle& DefaultTextStyle,
        const TSharedRef<FString>& InOutModelText, 
        FTextLayout& TargetTextLayout,
        TArray<TSharedRef<IRun>>& Runs,
        TArray<FTextLineHighlight>& LineHighlights,
        TMap<const FTextBlockStyle*, TSharedPtr<FSlateTextUnderlineLineHighlighter>>& CachedUnderlineHighlighters,
        TMap<const FTextBlockStyle*, TSharedPtr<FSlateTextStrikeLineHighlighter>>& CachedStrikeLineHighlighters
        );
 
    TSharedPtr< IRichTextMarkupParser > Parser;
 
    TSharedPtr< IRichTextMarkupWriter > Writer;
 
    TArray< TSharedRef< ITextDecorator > > Decorators;
 
    TArray< TSharedRef< ITextDecorator > > InlineDecorators;
 
    const ISlateStyle* DecoratorStyleSet;
 
    float FontSizeMultiplier = 1.0f;
 
};
 
#endif //WITH_FANCY_TEXT