ITextLayoutMarshaller Class Reference

#include <ITextLayoutMarshaller.h>

Inheritance diagram for ITextLayoutMarshaller:

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

Detailed Description

Interface used to get/set the raw text to/from a text layout

Constructor & Destructor Documentation

~ITextLayoutMarshaller()

virtual ITextLayoutMarshaller::~ITextLayoutMarshaller ( )

inlinevirtual

Member Function Documentation

ClearDirty()

virtual void ITextLayoutMarshaller::ClearDirty ( )

pure virtual

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

Implemented in FBaseTextLayoutMarshaller.

GetText()

virtual void ITextLayoutMarshaller::GetText ( FString &  TargetString, const FTextLayout &  SourceTextLayout  )

pure virtual

Populate the string from the text layout

Implemented in FPlainTextLayoutMarshaller.

IsDirty()

virtual bool ITextLayoutMarshaller::IsDirty ( ) const

pure virtual

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

Implemented in FBaseTextLayoutMarshaller.

MakeDirty()

virtual void ITextLayoutMarshaller::MakeDirty ( )

pure virtual

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

Implemented in FBaseTextLayoutMarshaller.

RequiresLiveUpdate()

virtual bool ITextLayoutMarshaller::RequiresLiveUpdate ( ) const

pure virtual

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

Implemented in FBaseTextLayoutMarshaller.

SetText()

virtual void ITextLayoutMarshaller::SetText ( const FString &  SourceString, FTextLayout &  TargetTextLayout  )

pure virtual

Populate the text layout from the string

Implemented in FPlainTextLayoutMarshaller.

---

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

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