FBaseTextLayoutMarshaller Class Reference

#include <BaseTextLayoutMarshaller.h>

Inheritance diagram for FBaseTextLayoutMarshaller:

Public Member Functions
virtual bool	RequiresLiveUpdate () const override
virtual void	MakeDirty () override
virtual void	ClearDirty () override
virtual bool	IsDirty () const override
Public Member Functions inherited from ITextLayoutMarshaller
virtual	~ITextLayoutMarshaller ()
virtual void	SetText (const FString &SourceString, FTextLayout &TargetTextLayout)=0
virtual void	GetText (FString &TargetString, const FTextLayout &SourceTextLayout)=0

Protected Member Functions
	FBaseTextLayoutMarshaller ()
virtual	~FBaseTextLayoutMarshaller ()

Detailed Description

Base class implementing some common functionality for all text marshallers

Constructor & Destructor Documentation

FBaseTextLayoutMarshaller()

FBaseTextLayoutMarshaller::FBaseTextLayoutMarshaller ( )

inlineprotected

~FBaseTextLayoutMarshaller()

virtual FBaseTextLayoutMarshaller::~FBaseTextLayoutMarshaller ( )

inlineprotectedvirtual

Member Function Documentation

ClearDirty()

virtual void FBaseTextLayoutMarshaller::ClearDirty ( )

inlineoverridevirtual

Mark this text layout as clean once it's been updated

Implements ITextLayoutMarshaller.

IsDirty()

virtual bool FBaseTextLayoutMarshaller::IsDirty ( ) const

inlineoverridevirtual

Is this text layout dirty? (eg, because some settings have changed) If so, you should call SetText on it to update the text layout

Implements ITextLayoutMarshaller.

MakeDirty()

virtual void FBaseTextLayoutMarshaller::MakeDirty ( )

inlineoverridevirtual

Mark this text layout as dirty (eg, because some settings have changed), so that it will cause SetText to be called on the next Tick

Implements ITextLayoutMarshaller.

RequiresLiveUpdate()

virtual bool FBaseTextLayoutMarshaller::RequiresLiveUpdate ( ) const

inlineoverridevirtual

Return true if the marshaller requires the text be updated "live" (eg, because it inserts formatting directly into the source text) Returning true will cause SetText to be called every time the source text is changed, which is costly, but required for things like syntax highlighting

Implements ITextLayoutMarshaller.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Slate/Public/Framework/Text/BaseTextLayoutMarshaller.h