FTextFormatPatternDefinition

Definition of the pattern used during a text format.

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FTextFormatPatternDefinition

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/TextFormatter.h

Include

#include "Internationalization/TextFormatter.h"

Syntax

class FTextFormatPatternDefinition : public TSharedFromThis< FTextFormatPatternDefinition, ESPMode::ThreadSafe >

Remarks

Definition of the pattern used during a text format.

Variables

Name Description

Public variable

TCHAR

 

ArgEndChar

Character representing the end of a format argument token

Public variable

TCHAR

 

ArgModChar

Character representing the start of a format argument modifier token

Public variable

TCHAR

 

ArgStartChar

Character representing the start of a format argument token

Public variable

TCHAR

 

EscapeChar

Character representing the start of an escape token

Constructors

Name Description

Public function

FTextFormatPatternDefinition()

Constructor

Functions

Name Description

Public function Static

FTextFormatP...

 

GetDefault()

Singleton access to the default instance

Public function Const

const FToken...

 

GetTextFormatDefinitions()

Get the text format definitions used when formatting text

Public function Const

bool

 

IsLiteralBreakChar

(
    const TCHAR InChar
)

Is the given character one that should cause a literal string token to break parsing?

Public function Const

bool

 

IsValidEscapeChar

(
    const TCHAR InChar
)

Is the given character one that an escape token may escape?

Public function

FTextFormatP...

 

SetArgEndChar

(
    const TCHAR InChar
)

Public function

FTextFormatP...

 

SetArgModChar

(
    const TCHAR InChar
)

Public function

FTextFormatP...

 

SetArgStartChar

(
    const TCHAR InChar
)

Public function

FTextFormatP...

 

SetEscapeChar

(
    const TCHAR InChar
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss