Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FTextBuilder Class Reference

#include <Text.h>

+ Collaboration diagram for FTextBuilder:

Public Member Functions

void Indent ()
 
void Unindent ()
 
void AppendLine ()
 
void AppendLine (const FText &Text)
 
void AppendLine (const FString &String)
 
void AppendLine (const FName &Name)
 
void AppendLineFormat (const FTextFormat &Pattern, const FFormatNamedArguments &Arguments)
 
void AppendLineFormat (const FTextFormat &Pattern, const FFormatOrderedArguments &Arguments)
 
template<typename... ArgTypes>
FORCEINLINE void AppendLineFormat (FTextFormat Pattern, ArgTypes... Args)
 
void Clear ()
 
bool IsEmpty ()
 
FText ToText () const
 

Private Member Functions

void BuildAndAppendLine (FString &&Data)
 
void BuildAndAppendLine (FText &&Data)
 

Private Attributes

TArray< FTextLines
 
int32 IndentCount = 0
 

Detailed Description

Definition at line 1203 of file Text.h.

Member Function Documentation

◆ AppendLine() [1/4]

void FTextBuilder::AppendLine ( )

Append an empty line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [2/4]

void FTextBuilder::AppendLine ( const FName & Name)

Append the given name line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [3/4]

void FTextBuilder::AppendLine ( const FString & String)

Append the given string line to the builder, indented by the running indentation of the builder.

◆ AppendLine() [4/4]

void FTextBuilder::AppendLine ( const FText & Text)

Append the given text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [1/3]

void FTextBuilder::AppendLineFormat ( const FTextFormat & Pattern,
const FFormatNamedArguments & Arguments )

Append the given formatted text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [2/3]

void FTextBuilder::AppendLineFormat ( const FTextFormat & Pattern,
const FFormatOrderedArguments & Arguments )

Append the given formatted text line to the builder, indented by the running indentation of the builder.

◆ AppendLineFormat() [3/3]

template<typename... ArgTypes>
FORCEINLINE void FTextBuilder::AppendLineFormat ( FTextFormat Pattern,
ArgTypes... Args )
inline

Append the given formatted text line to the builder, indented by the running indentation of the builder.

Definition at line 1250 of file Text.h.

◆ BuildAndAppendLine() [1/2]

void FTextBuilder::BuildAndAppendLine ( FString && Data)
private

◆ BuildAndAppendLine() [2/2]

void FTextBuilder::BuildAndAppendLine ( FText && Data)
private

◆ Clear()

void FTextBuilder::Clear ( )

Clear the builder and reset it to its default state.

◆ Indent()

void FTextBuilder::Indent ( )

Increase the running indentation of the builder.

◆ IsEmpty()

bool FTextBuilder::IsEmpty ( )

Check to see if the builder has any data.

◆ ToText()

FText FTextBuilder::ToText ( ) const

Build the current set of input into a FText.

◆ Unindent()

void FTextBuilder::Unindent ( )

Decrease the running indentation of the builder.

Member Data Documentation

◆ IndentCount

int32 FTextBuilder::IndentCount = 0
private

Definition at line 1278 of file Text.h.

◆ Lines

TArray<FText> FTextBuilder::Lines
private

Definition at line 1277 of file Text.h.


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