FTextFilterString Class Reference

#include <TextFilterUtils.h>

Collaboration diagram for FTextFilterString:

Public Member Functions
	FTextFilterString ()
	FTextFilterString (const FTextFilterString &Other)
	FTextFilterString (FTextFilterString &&Other)
	FTextFilterString (const FString &InString)
	FTextFilterString (FString &&InString)
	FTextFilterString (const TCHAR *InString)
	FTextFilterString (const FName &InName)
FTextFilterString &	operator= (const FTextFilterString &Other)
FTextFilterString &	operator= (FTextFilterString &&Other)
bool	CompareText (const FTextFilterString &InOther, const ETextFilterTextComparisonMode InTextComparisonMode) const
bool	CompareFString (const FString &InOther, const ETextFilterTextComparisonMode InTextComparisonMode) const
bool	CompareName (const FName &InOther, const ETextFilterTextComparisonMode InTextComparisonMode) const
bool	CanCompareNumeric (const FTextFilterString &InOther) const
bool	CompareNumeric (const FTextFilterString &InOther, const ETextFilterComparisonOperation InComparisonOperation) const
FORCEINLINE const FString &	AsString () const
FORCEINLINE FName	AsName () const
FORCEINLINE bool	IsEmpty () const

Private Member Functions
void	UppercaseInternalString ()

Private Attributes
FString	InternalString
TArray< ANSICHAR >	InternalStringAnsi

Detailed Description

String used by the text filter. The given string will be stored as uppercase since filter text always performs case-insensitive string comparisons, so this will minimize ToUpper calls.

Definition at line 37 of file TextFilterUtils.h.

Constructor & Destructor Documentation

FTextFilterString() [1/7]

FTextFilterString::FTextFilterString

(

)

Default constructor

FTextFilterString() [2/7]

FTextFilterString::FTextFilterString

(

const FTextFilterString &

Other

)

Move and copy constructors

FTextFilterString() [3/7]

FTextFilterString::FTextFilterString

(

FTextFilterString &&

Other

)

FTextFilterString() [4/7]

FTextFilterString::FTextFilterString

(

const FString &

InString

)

Construct from a string

FTextFilterString() [5/7]

FTextFilterString::FTextFilterString

(

FString &&

InString

)

FTextFilterString() [6/7]

FTextFilterString::FTextFilterString

(

const TCHAR *

InString

)

FTextFilterString() [7/7]

FTextFilterString::FTextFilterString

(

const FName &

InName

)

Construct from a name

Member Function Documentation

AsName()

FORCEINLINE FName FTextFilterString::AsName ( ) const

inline

Get the internal uppercase string of this filter string as an FName

Definition at line 81 of file TextFilterUtils.h.

AsString()

FORCEINLINE const FString & FTextFilterString::AsString ( ) const

inline

Get the internal uppercase string of this filter string

Definition at line 75 of file TextFilterUtils.h.

CanCompareNumeric()

bool FTextFilterString::CanCompareNumeric

(

const FTextFilterString &

InOther

)

const

Are the two given strings able to be compared numberically?

CompareFString()

bool FTextFilterString::CompareFString	(	const FString &	InOther,
		const ETextFilterTextComparisonMode	InTextComparisonMode ) const

Compare this string against the other FString, using the text comparison mode provided

CompareName()

bool FTextFilterString::CompareName	(	const FName &	InOther,
		const ETextFilterTextComparisonMode	InTextComparisonMode ) const

Compare this string against the other FName, using the text comparison mode provided

CompareNumeric()

bool FTextFilterString::CompareNumeric	(	const FTextFilterString &	InOther,
		const ETextFilterComparisonOperation	InComparisonOperation ) const

Compare this string against the other, converting them to numbers and using the comparison operator provided - you should have tested CanCompareNumeric first!

CompareText()

bool FTextFilterString::CompareText	(	const FTextFilterString &	InOther,
		const ETextFilterTextComparisonMode	InTextComparisonMode ) const

Compare this string against the other, using the text comparison mode provided

IsEmpty()

FORCEINLINE bool FTextFilterString::IsEmpty ( ) const

inline

Is the internal string empty?

Definition at line 87 of file TextFilterUtils.h.

operator=() [1/2]

FTextFilterString & FTextFilterString::operator=

(

const FTextFilterString &

Other

)

Move and copy assignment

operator=() [2/2]

FTextFilterString & FTextFilterString::operator=

(

FTextFilterString &&

Other

)

UppercaseInternalString()

void FTextFilterString::UppercaseInternalString ( )

private

Inline convert our internal string to uppercase

Member Data Documentation

InternalString

FString FTextFilterString::InternalString

private

The uppercase string to use for comparisons

Definition at line 97 of file TextFilterUtils.h.

InternalStringAnsi

TArray<ANSICHAR> FTextFilterString::InternalStringAnsi

private

The uppercase ANSI version of string to use for comparisons

Definition at line 100 of file TextFilterUtils.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/TextFilterUtils.h