UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FTextChar Class Reference

#include <TextChar.h>

Static Public Member Functions

static CORE_API UTF32CHAR GetCodepoint (const TCHAR *Buffer, int32 *OutNumTCHARInCodepoint=nullptr)
 
static CORE_API bool ConvertCodepointToString (const UTF32CHAR Codepoint, FString &OutString)
 
static CORE_API bool AppendCodepointToString (const UTF32CHAR Codepoint, FString &OutString)
 
static CORE_API bool IsAlpha (const UTF32CHAR Codepoint)
 
static CORE_API bool IsGraph (const UTF32CHAR Codepoint)
 
static CORE_API bool IsPrint (const UTF32CHAR Codepoint)
 
static CORE_API bool IsPunct (const UTF32CHAR Codepoint)
 
static CORE_API bool IsAlnum (const UTF32CHAR Codepoint)
 
static CORE_API bool IsDigit (const UTF32CHAR Codepoint)
 
static CORE_API bool IsHexDigit (const UTF32CHAR Codepoint)
 
static CORE_API bool IsControl (const UTF32CHAR Codepoint)
 
static CORE_API bool IsWhitespace (const UTF32CHAR Codepoint)
 
static CORE_API bool IsUpper (const UTF32CHAR Codepoint)
 
static CORE_API bool IsLower (const UTF32CHAR Codepoint)
 
static CORE_API UTF32CHAR ToLower (const UTF32CHAR Codepoint)
 
static CORE_API UTF32CHAR ToUpper (const UTF32CHAR Codepoint)
 

Detailed Description

Utility for performing Unicode aware (in builds with ICU enabled) character checks. In builds without ICU enabled (such as server builds), this API uses the non-Unicode aware FChar API internally. The implementation can be found in LegacyText.cpp and ICUText.cpp.

Member Function Documentation

◆ AppendCodepointToString()

bool FTextChar::AppendCodepointToString ( const UTF32CHAR  Codepoint,
FString &  OutString 
)
static

Attempt to convert the given codepoint to a string, appending after any existing content in the string.

◆ ConvertCodepointToString()

bool FTextChar::ConvertCodepointToString ( const UTF32CHAR  Codepoint,
FString &  OutString 
)
static

Attempt to convert the given codepoint to a string, replacing any existing content in the string.

◆ GetCodepoint()

UTF32CHAR FTextChar::GetCodepoint ( const TCHAR Buffer,
int32 OutNumTCHARInCodepoint = nullptr 
)
static

Return the next codepoint from the given null terminated buffer.

◆ IsAlnum()

bool FTextChar::IsAlnum ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is an alphanumeric character (letter or digit).

◆ IsAlpha()

bool FTextChar::IsAlpha ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a letter character.

◆ IsControl()

bool FTextChar::IsControl ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a control character.

◆ IsDigit()

bool FTextChar::IsDigit ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a digit character.

◆ IsGraph()

bool FTextChar::IsGraph ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a "graphic" character (printable, excluding spaces).

◆ IsHexDigit()

bool FTextChar::IsHexDigit ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a hexadecimal digit character.

◆ IsLower()

bool FTextChar::IsLower ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is an lowercase letter character.

◆ IsPrint()

bool FTextChar::IsPrint ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a printable character.

◆ IsPunct()

bool FTextChar::IsPunct ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a punctuation character.

◆ IsUpper()

bool FTextChar::IsUpper ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is an uppercase letter character.

◆ IsWhitespace()

bool FTextChar::IsWhitespace ( const UTF32CHAR  Codepoint)
static

Determine whether the given codepoint is a whitespace character.

Note
It is safe to pass a UTF-16 TCHAR to this function, since whitespace is never a pair of UTF-16 characters.

◆ ToLower()

UTF32CHAR FTextChar::ToLower ( const UTF32CHAR  Codepoint)
static

Convert the given codepoint to its lowercase version.

◆ ToUpper()

UTF32CHAR FTextChar::ToUpper ( const UTF32CHAR  Codepoint)
static

Convert the given codepoint to its uppercase version.


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