FTextFilterString

String used by the text filter.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/TextFilterUtils.h

Include

#include "Misc/TextFilterUtils.h"

Syntax

class FTextFilterString

Remarks

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.

Constructors

Name Description

Public function

FTextFilterString()

Default constructor

Public function

FTextFilterString

(
    const FTextFilterString& Other
)

Move and copy constructors

Public function

FTextFilterString

(
    FTextFilterString&& Other
)

Public function

FTextFilterString

(
    const FString& InString
)

Construct from a string

Public function

FTextFilterString

(
    FString&& InString
)

Public function

FTextFilterString

(
    const TCHAR* InString
)

Public function

FTextFilterString

(
    const FName& InName
)

Construct from a name

Functions

Name Description

Public function Const

FName

 

AsName()

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

Public function Const

const FStrin...

 

AsString()

Get the internal uppercase string of this filter string

Public function Const

bool

 

CanCompareNumeric

(
    const FTextFilterString& InOther
)

Are the two given strings able to be compared numberically?

Public function Const

bool

 

CompareFString

(
    const FString& InOther,
    const ETextFilterTextComparisonMode...
)

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

Public function Const

bool

 

CompareName

(
    const FName& InOther,
    const ETextFilterTextComparisonMode...
)

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

Public function Const

bool

 

CompareNumeric

(
    const FTextFilterString& InOther,
    const ETextFilterComparisonOperatio...
)

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

Public function Const

bool

 

CompareText

(
    const FTextFilterString& InOther,
    const ETextFilterTextComparisonMode...
)

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

Public function Const

bool

 

IsEmpty()

Is the internal string empty?

Operators

Name Description

Public function

FTextFilterS...

 

operator=

(
    const FTextFilterString& Other
)

Move and copy assignment

Public function

FTextFilterS...

 

operator=

(
    FTextFilterString&& Other
)

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