FGenericFilter | Unreal Engine 5.7 Documentation

API > API/Developer > API/Developer/ToolWidgets

A generic filter that can be used with the various FilterBar Widgets Takes in a Category, Name, Display Name and Delegate which specifies how to filter an item You can optionally specify a Tooltip, Icon Name or Color


Name	FGenericFilter
Type	class
Header File	/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Include Path	#include "Filters/GenericFilter.h"

Syntax

template<typename FilterType>  
class FGenericFilter : public FFilterBase< FilterType >

Inheritance Hierarchy

FFilterBase → FGenericFilter

Implements Interfaces

IFilter

Derived Classes

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FGenericFilter ( TSharedPtr< FFilterCategory > InCategory, const FString& InName, const FText& DisplayName, FOnItemFiltered InFilterDelegate )		Filters/GenericFilter.h

Typedefs

Name	Type	Remarks	Include Path
FOnItemFiltered	TBaseDelegate_OneParam< bool, FilterType >		Filters/GenericFilter.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual bool PassesFilter ( FilterType InItem ) const		Filters/GenericFilter.h
void SetColor ( const FLinearColor& InColor )		Filters/GenericFilter.h
void SetIconName ( const FName& InIconName )		Filters/GenericFilter.h
void SetToolTipText ( const FText& InToolTip )		Filters/GenericFilter.h

Overridden from FFilterBase

Name	Remarks	Include Path
virtual void ActiveStateChanged ( bool bActive )	Notification that the filter became active or inactive	Filters/GenericFilter.h
virtual FLinearColor GetColor()	Returns the color this filter button will be when displayed as a button	Filters/GenericFilter.h
virtual FText GetDisplayName()	Returns the human readable name for this filter	Filters/GenericFilter.h
virtual FName GetIconName()	Returns the name of the icon to use in menu entries	Filters/GenericFilter.h
virtual FText GetToolTipText()	Returns the tooltip for this filter, shown in the filters menu	Filters/GenericFilter.h
virtual bool IsInverseFilter()	Returns true if the filter should be in the list when disabled and not in the list when enabled	Filters/GenericFilter.h
virtual void LoadSettings ( const FString& IniFilename, const FString& IniSection, const FString& SettingsString )	Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any generic Filter Bar	Filters/GenericFilter.h
virtual void ModifyContextMenu ( FMenuBuilder& MenuBuilder )	Called when the right-click context menu is being built for this filter	Filters/GenericFilter.h
virtual void SaveSettings ( const FString& IniFilename, const FString& IniSection, const FString& SettingsString ) const	Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any generic Filter Bar	Filters/GenericFilter.h

Overridden from IFilter

Name	Remarks	Include Path	Unreal Specifiers
virtual FString GetName()	Returns the system name for this filter	Filters/GenericFilter.h

Navigation