TTextFilter< ItemType > Class Template Reference

#include <TextFilter.h>

Inheritance diagram for TTextFilter< ItemType >:

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 FChangedEvent &	OnChanged () 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 ()
virtual FString	GetName () const
	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
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< TTextFilter< ItemType >, Mode >	AsWeak ()
TWeakPtr< TTextFilter< ItemType > const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Public Types inherited from IFilter< ItemType >
typedef ItemType	ItemType
Protected Member Functions inherited from TSharedFromThis< TTextFilter< ItemType > >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< TTextFilter< ItemType > >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

template<typename ItemType>
class TTextFilter< ItemType >

A generic filter specialized for text restrictions

Constructor & Destructor Documentation

TTextFilter() [1/2]

template<typename ItemType >

TTextFilter< ItemType >::TTextFilter ( FItemToStringArray  InTransformDelegate )

inline

TTextFilter Constructor

Parameters

InTransform

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

TTextFilter() [2/2]

template<typename ItemType >

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

inline

Member Function Documentation

DECLARE_DELEGATE_RetVal_FiveParams()

template<typename ItemType >

TTextFilter< ItemType >::DECLARE_DELEGATE_RetVal_FiveParams	(	bool	,
		FItemTestComplexExpression	,
		ItemType	,
		const FName &	,
		const FTextFilterString &	,
		ETextFilterComparisonOperation	,
		ETextFilterTextComparisonMode
	)

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

template<typename ItemType >

TTextFilter< ItemType >::DECLARE_DERIVED_EVENT	(	TTextFilter< ItemType >	,
		IFilter< ItemType >::FChangedEvent	,
		FChangedEvent
	)

GetFilterErrorText()

template<typename ItemType >

FText TTextFilter< ItemType >::GetFilterErrorText ( ) const

inline

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

GetRawFilterText()

template<typename ItemType >

FText TTextFilter< ItemType >::GetRawFilterText ( ) const

inline

Returns the unsanitized and unsplit filter terms

OnChanged()

template<typename ItemType >

virtual FChangedEvent & TTextFilter< ItemType >::OnChanged ( )

inlineoverridevirtual

Implements IFilter< ItemType >.

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

InItem

The Item to check

Returns

Whether the specified Item passed the filter

Implements IFilter< ItemType >.

SetRawFilterText()

template<typename ItemType >

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

inline

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

---

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

• Engine/Source/Runtime/AdvancedWidgets/Private/Widgets/PropertyViewer/SPropertyViewerImpl.h
• Engine/Source/Runtime/Core/Public/Misc/TextFilter.h