Navigation
API > API/Runtime > API/Runtime/Slate
Base class implementing some common functionality for all text marshallers
| Name | FBaseTextLayoutMarshaller |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Text/BaseTextLayoutMarshaller.h |
| Include Path | #include "Framework/Text/BaseTextLayoutMarshaller.h" |
Syntax
class FBaseTextLayoutMarshaller : public ITextLayoutMarshaller
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBaseTextLayoutMarshaller() |
Framework/Text/BaseTextLayoutMarshaller.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FBaseTextLayoutMarshaller() |
Framework/Text/BaseTextLayoutMarshaller.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsDirty | bool | Framework/Text/BaseTextLayoutMarshaller.h |
Functions
Public
Overridden from ITextLayoutMarshaller
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ClearDirty() |
Mark this text layout as clean once it's been updated | Framework/Text/BaseTextLayoutMarshaller.h | |
virtual bool IsDirty() |
Is this text layout dirty? (eg, because some settings have changed) If so, you should call SetText on it to update the text layout | Framework/Text/BaseTextLayoutMarshaller.h | |
virtual void MakeDirty() |
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 | Framework/Text/BaseTextLayoutMarshaller.h | |
virtual bool RequiresLiveUpdate() |
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 | Framework/Text/BaseTextLayoutMarshaller.h |