1. Epic GamesDeveloper
  3. FRichTextLayoutMarshaller

FRichTextLayoutMarshaller

Get/set the raw text to/from a text layout as rich text

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Text

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Text/RichTextLayoutMarshaller.h
Include #include "Framework/Text/RichTextLayoutMarshaller.h"

Syntax

class FRichTextLayoutMarshaller : public FBaseTextLayoutMarshaller

Remarks

Get/set the raw text to/from a text layout as rich text

Variables

  Type Name Description
Protected variable TArray< TSharedRef< ITextDecorator > > Decorators Any decorators that should be used while parsing the text.
Protected variable const ISlateStyle * DecoratorStyleSet The style set used for looking up styles used by decorators
Protected variable float FontSizeMultiplier Multiplier applied on font
Protected variable TArray< TSharedRef< ITextDecorator > > InlineDecorators Additional decorators can be appended inline.
Protected variable TSharedPtr< IRichTextMarkupParser > Parser The parser used to resolve any markup used in the provided string.
Protected variable TSharedPtr< IRichTextMarkupWriter > Writer The writer used to recreate any markup needed to preserve the styled runs.

Constructors

  Type Name Description
Protected function  

FRichTextLayoutMarshaller ( TArray< TSharedRef< ITextDecorator > > InDecorators,
const ISlateStyle*const InDecoratorStyleSet
)

  
Protected function  

FRichTextLayoutMarshaller ( TSharedPtr< IRichTextMarkupParser > InParser,
TSharedPtr< IRichTextMarkupWriter > InWriter,
TArray< TSharedRef< ITextDecorator > > InDecorators,
const ISlateStyle*const InDecoratorStyleSet
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FRichTextLayoutMarshaller &

AppendInlineDecorator ( const TSharedRef< ITextDecorator >& DecoratorToAdd
)

 Append an inline decorator to this marshaller
Protected function 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 >>& CachedUnderli...,
TMap< const FTextBlockStyle*, TSharedPtr< FSlateTextStrikeLineHighlighter >>& CachedStrikeLine...
)

  
Public function Static TSharedRef< FRichTextLayoutMarshaller >

Create ( TArray< TSharedRef< ITextDecorator > > InDecorators,
const ISlateStyle*const InDecoratorStyleSet
)

  
Public function Static TSharedRef< FRichTextLayoutMarshaller >

Create ( TSharedPtr< IRichTextMarkupParser > InParser,
TSharedPtr< IRichTextMarkupWriter > InWriter,
TArray< TSharedRef< ITextDecorator > > InDecorators,
const ISlateStyle*const InDecoratorStyleSet
)

  
Public function void Replace all decorators on this marshaller
Public function void

SetDecoratorStyleSet ( const ISlateStyle* InStyleSet
)

  
Public function void

SetFontSizeMultiplier ( const float NewFontSizeMultiplier
)

 Set the Multiplier applied on the font size of the text
Protected function Const TSharedPtr< ITextDecorator >

TryGetDecorator ( const FString& Line,
const FTextRunParseResults& TextRun
)

  

Overridden from ITextLayoutMarshaller

  Type Name Description
Public function Virtual void

GetText ( FString& TargetString,
const FTextLayout& SourceTextLayout
)

 Populate the string from the text layout
Public function Virtual void

SetText ( const FString& SourceString,
FTextLayout& TargetTextLayout
)

 ITextLayoutMarshaller.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page