FTextFilterString Class Reference

#include <TextFilterUtils.h>

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

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.

Constructor & Destructor Documentation

FTextFilterString() [1/8]

FTextFilterString::FTextFilterString ( )

default

Default constructor

FTextFilterString() [2/8]

FTextFilterString::FTextFilterString ( const FTextFilterString &  Other )

default

Move and copy constructors

FTextFilterString() [3/8]

FTextFilterString::FTextFilterString ( FTextFilterString &&  Other )

default

FTextFilterString() [4/8]

FTextFilterString::FTextFilterString

(

const FString &

InString

)

Construct from a string

FTextFilterString() [5/8]

FTextFilterString::FTextFilterString

(

FString &&

InString

)

FTextFilterString() [6/8]

FTextFilterString::FTextFilterString

(

FStringView

InString

)

FTextFilterString() [7/8]

FTextFilterString::FTextFilterString

(

const TCHAR *

InString

)

FTextFilterString() [8/8]

FTextFilterString::FTextFilterString

(

FName

InName

)

Construct from a name

Member Function Documentation

AsName()

UE_FORCEINLINE_HINT FName FTextFilterString::AsName ( ) const

inline

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

AsString()

UE_FORCEINLINE_HINT const FString & FTextFilterString::AsString ( ) const

inline

Get the internal uppercase string of this filter string

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

CompareFStringView()

bool FTextFilterString::CompareFStringView	(	FStringView	InOther,
		const ETextFilterTextComparisonMode	InTextComparisonMode
	)		const

Compare this string against a string view which has previously been converted to uppercase

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()

UE_FORCEINLINE_HINT bool FTextFilterString::IsEmpty ( ) const

inline

Is the internal string empty?

operator=() [1/6]

FTextFilterString & FTextFilterString::operator=

(

const FString &

InString

)

operator=() [2/6]

FTextFilterString & FTextFilterString::operator= ( const FTextFilterString &  Other )

default

Move and copy assignment

operator=() [3/6]

FTextFilterString & FTextFilterString::operator=

(

const TCHAR *

InString

)

operator=() [4/6]

FTextFilterString & FTextFilterString::operator=

(

FName

InName

)

operator=() [5/6]

FTextFilterString & FTextFilterString::operator=

(

FStringView

InString

)

operator=() [6/6]

FTextFilterString & FTextFilterString::operator= ( FTextFilterString &&  Other )

default

---

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

• Engine/Source/Runtime/Core/Public/Misc/TextFilterUtils.h
• Engine/Source/Runtime/Core/Private/Misc/TextFilterUtils.cpp