Text

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public class

FBaseTextLayoutMarshaller

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FCachedShapedTextKey

Information representing a piece of shaped text

Public class

FDefaultLayoutBlock

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FDefaultRichTextMarkupParser

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FDefaultRichTextMarkupWriter

Public class

FGenericPlatformTextField

Public class

FHyperlinkDecorator

Public class

FImageDecorator

Public struct

FLayoutBlockTextContext

The context needed when creating a block from a run of a text

Public class

FPlainTextLayoutMarshaller

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

Public class

FRichTextLayoutMarshaller

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

Public class

FRichTextSyntaxHighlighterTextLayoutMarshaller

Get/set the raw text to/from a text layout, and also inject syntax highlighting for our rich-text markup

Public struct

FRunInfo

Public struct

FRunTextContext

The context needed when performing text operations on a run of text

Public class

FShapedTextCache

Cache of shaped text

Public struct

FShapedTextContext

The basic data needed when shaping a run of text

Public class

FSlateHyperlinkRun

Public class

FSlateImageRun

Public class

FSlatePasswordRun

Public class

FSlateTextHighlightRunRenderer

Public class

FSlateTextLayout

Public class

FSlateTextRun

Public class

FSlateTextStrikeLineHighlighter

Run highlighter used to draw strikes

Public class

FSlateTextUnderlineLineHighlighter

Run highlighter used to draw underlines

Public class

FSlateWidgetRun

Public class

FSyntaxHighlighterTextLayoutMarshaller

Get/set the raw text to/from a text layout, and also inject syntax highlighting

Public class

FSyntaxTokenizer

Copyright Epic Games, Inc. All Rights Reserved.

Public class

FTextLayout

Public struct

FTextLineHighlight

Public struct

FTextLineParseResults

Public struct

FTextLocation

Location within the text model.

Public struct

FTextRunInfo

Public struct

FTextRunParseResults

Public struct

FTextRunRenderer

Public class

FTextSelection

Public class

FWidgetDecorator

Public class

FWidgetLayoutBlock

Copyright Epic Games, Inc. All Rights Reserved.

Public class

ILayoutBlock

Copyright Epic Games, Inc. All Rights Reserved.

Public class

ILineHighlighter

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IRichTextMarkupParser

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IRichTextMarkupWriter

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IRun

Public class

IRunRenderer

Copyright Epic Games, Inc. All Rights Reserved.

Public class

ISlateLineHighlighter

Public class

ISlateRun

Public class

ISlateRunRenderer

Public class

ISlateTextLineHighlighter

Run highlighter used to draw lines

Public class

ITextDecorator

Public class

ITextLayoutMarshaller

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

Typedefs

Enums

Name

Description

Public enum

ERunAttributes

Attributes that a run can have

Public enum

ETextFlowDirection

The different directions that text can flow within a paragraph of text.

Public enum

ETextHitPoint

Copyright Epic Games, Inc. All Rights Reserved.

Public enum

ETextJustify::Type

Public enum

ETextTransformPolicy

The different methods that can be used if a word is too long to be broken by the default line-break iterator.

Public enum

ETextWrappingPolicy

The different methods that can be used if a word is too long to be broken by the default line-break iterator.

Functions

Name Description

Public function

ETextFlowDir ...

 

GetDefaultTextFlowDirection()

Get the default text flow direction (from the "Slate.DefaultTextFlowDirection" CVar)

Public function

constexpr bo ...

 

operator!

(
    ERunAttributes E
)

Public function

constexpr ER ...

 

operator&

(
    ERunAttributes Lhs,
    ERunAttributes Rhs
)

Public function

ERunAttribut ...

 

operator&=

(
    ERunAttributes & Lhs,
    ERunAttributes Rhs
)

Public function

constexpr ER ...

 

operator^

(
    ERunAttributes Lhs,
    ERunAttributes Rhs
)

Public function

ERunAttribut ...

 

operator^=

(
    ERunAttributes & Lhs,
    ERunAttributes Rhs
)

Public function

constexpr ER ...

 

operator|

(
    ERunAttributes Lhs,
    ERunAttributes Rhs
)

Public function

ERunAttribut ...

 

operator|=

(
    ERunAttributes & Lhs,
    ERunAttributes Rhs
)

Public function

constexpr ER ...

 

operator~

(
    ERunAttributes E
)

Public function

FTextRange

 

RunUtils::CalculateOffsetMeasureRange

(
    const int32 InOffset,
    const FTextRange & InTextRange,
    const TextBiDi::ETextDirection InTe...
)

Calculate the range that will measure to the given index, based on the given range and text direction

Public function

ETextHitPoin ...

 

RunUtils::CalculateTextHitPoint

(
    const int32 InIndex,
    const FTextRange & InTextRange,
    const TextBiDi::ETextDirection InTe...
)

Calculate the correct hit-point for the given index, based on the given range and text direction

Public function

int32

 

ShapedTextCacheUtil::FindCharacterIndexAtOffset

(
    const FShapedTextCacheRef & InShape...,
    const FCachedShapedTextKey & InRunK...,
    const FTextRange & InTextRange,
    const TCHAR * InText,
    const int32 InHorizontalOffset
)

Find the character index at the specified position in pixels along the string horizontally

Public function

int8

 

ShapedTextCacheUtil::GetShapedGlyphKerning

(
    const FShapedTextCacheRef & InShape...,
    const FCachedShapedTextKey & InRunK...,
    const int32 InGlyphIndex,
    const TCHAR * InText
)

Get the kerning between two shaped glyphs

Public function

FShapedGlyph ...

 

ShapedTextCacheUtil::GetShapedTextSubSequence

(
    const FShapedTextCacheRef & InShape...,
    const FCachedShapedTextKey & InRunK...,
    const FTextRange & InTextRange,
    const TCHAR * InText,
    const TextBiDi::ETextDirection InTe...
)

Extract a sub-section of a run of text into its own shaped glyph sequence

Public function

FVector2D

 

ShapedTextCacheUtil::MeasureShapedText

(
    const FShapedTextCacheRef & InShape...,
    const FCachedShapedTextKey & InRunK...,
    const FTextRange & InMeasureRange,
    const TCHAR * InText
)

Measure a sub-section of a run of text

Public function

void

 

TextRangeHeaderDeprecatedWarning()

Including TextRange.h has been deprecated. Please include UnrealString.h in the Core module instead.

Public function

void

 

TriggerTextRangeHeaderDeprecatedWarning()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback