Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
TTextFilter< ItemType > Class Template Reference

#include <TextFilter.h>

+ Inheritance diagram for TTextFilter< ItemType >:
+ Collaboration diagram for TTextFilter< ItemType >:

Classes

class  FTextFilterExpressionContext
 

Public Member Functions

 DECLARE_DELEGATE_TwoParams (FItemToStringArray, ItemType, OUT TArray< FString > &)
 
 DECLARE_DELEGATE_RetVal_FiveParams (bool, FItemTestComplexExpression, ItemType, const FName &, const FTextFilterString &, ETextFilterComparisonOperation, ETextFilterTextComparisonMode)
 
 TTextFilter (FItemToStringArray InTransformDelegate)
 
 TTextFilter (FItemToStringArray InTransformDelegate, FItemTestComplexExpression InTestComplexExpressionDelegate)
 
 DECLARE_DERIVED_EVENT (TTextFilter, IFilter< ItemType >::FChangedEvent, FChangedEvent)
 
virtual FChangedEventOnChanged () override
 
virtual bool PassesFilter (ItemType InItem) const override
 
FText GetRawFilterText () const
 
void SetRawFilterText (const FText &InFilterText)
 
FText GetFilterErrorText () const
 
- Public Member Functions inherited from IFilter< ItemType >
virtual ~IFilter ()
 
 DECLARE_EVENT (IFilter< ItemType >, FChangedEvent)
 
- Public Member Functions inherited from TSharedFromThis< TTextFilter< ItemType > >
TSharedRef< TTextFilter< ItemType >, Mode > AsShared ()
 
TSharedRef< TTextFilter< ItemType > const, Mode > AsShared () const
 
TWeakPtr< TTextFilter< ItemType >, Mode > AsWeak ()
 
TWeakPtr< TTextFilter< ItemType > const, Mode > AsWeak () const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, Mode > const *InSharedPtr, OtherType *InObject) const
 
FORCEINLINE void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, Mode > const *InSharedRef, OtherType *InObject) const
 
FORCEINLINE bool DoesSharedInstanceExist () const
 

Private Attributes

FTextFilterExpressionContext TextFilterExpressionContext
 
FTextFilterExpressionEvaluator TextFilterExpressionEvaluator
 
FChangedEvent ChangedEvent
 

Additional Inherited Members

- Public Types inherited from IFilter< ItemType >
typedef ItemType ItemType
 
- Protected Member Functions inherited from TSharedFromThis< TTextFilter< ItemType > >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
FORCEINLINE TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< TTextFilter< ItemType > >
static FORCEINLINE TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static FORCEINLINE TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

template<typename ItemType>
class TTextFilter< ItemType >

A generic filter specialized for text restrictions

Definition at line 20 of file TextFilter.h.

Constructor & Destructor Documentation

◆ TTextFilter() [1/2]

template<typename ItemType >
TTextFilter< ItemType >::TTextFilter ( FItemToStringArray InTransformDelegate)
inline

TTextFilter Constructor

Parameters
InTransformA required delegate used to populate an array of strings based on an Item

Definition at line 35 of file TextFilter.h.

◆ TTextFilter() [2/2]

template<typename ItemType >
TTextFilter< ItemType >::TTextFilter ( FItemToStringArray InTransformDelegate,
FItemTestComplexExpression InTestComplexExpressionDelegate )
inline

Definition at line 42 of file TextFilter.h.

Member Function Documentation

◆ DECLARE_DELEGATE_RetVal_FiveParams()

Defines a function signature used to test a complex expression for an Item

◆ DECLARE_DELEGATE_TwoParams()

template<typename ItemType >
TTextFilter< ItemType >::DECLARE_DELEGATE_TwoParams ( FItemToStringArray ,
ItemType ,
OUT TArray< FString > &  )

Defines a function signature for functions used to transform an Item into an array of FStrings

◆ DECLARE_DERIVED_EVENT()

◆ GetFilterErrorText()

template<typename ItemType >
FText TTextFilter< ItemType >::GetFilterErrorText ( ) const
inline

Get the last error returned from lexing or compiling the current filter text

Definition at line 88 of file TextFilter.h.

◆ GetRawFilterText()

template<typename ItemType >
FText TTextFilter< ItemType >::GetRawFilterText ( ) const
inline

Returns the unsanitized and unsplit filter terms

Definition at line 73 of file TextFilter.h.

◆ OnChanged()

template<typename ItemType >
virtual FChangedEvent & TTextFilter< ItemType >::OnChanged ( )
inlineoverridevirtual

Implements IFilter< ItemType >.

Definition at line 51 of file TextFilter.h.

◆ PassesFilter()

template<typename ItemType >
virtual bool TTextFilter< ItemType >::PassesFilter ( ItemType InItem) const
inlineoverridevirtual

Returns whether the specified Item passes the Filter's text restrictions

Parameters
InItemThe Item to check
Returns
Whether the specified Item passed the filter

Implements IFilter< ItemType >.

Definition at line 59 of file TextFilter.h.

◆ SetRawFilterText()

template<typename ItemType >
void TTextFilter< ItemType >::SetRawFilterText ( const FText & InFilterText)
inline

Set the Text to be used as the Filter's restrictions

Definition at line 79 of file TextFilter.h.

Member Data Documentation

◆ ChangedEvent

template<typename ItemType >
FChangedEvent TTextFilter< ItemType >::ChangedEvent
private

The event that fires whenever new search terms are provided

Definition at line 161 of file TextFilter.h.

◆ TextFilterExpressionContext

template<typename ItemType >
FTextFilterExpressionContext TTextFilter< ItemType >::TextFilterExpressionContext
mutableprivate

Transient context data, used when calling PassesFilter. Kept around to minimize re-allocations between multiple calls to PassesFilter

Definition at line 155 of file TextFilter.h.

◆ TextFilterExpressionEvaluator

template<typename ItemType >
FTextFilterExpressionEvaluator TTextFilter< ItemType >::TextFilterExpressionEvaluator
private

Expression evaluator that can be used to perform complex text filter queries

Definition at line 158 of file TextFilter.h.


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