FGenericFilter

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

Unreal Engine C++ API Reference > Developer > ToolWidgets > Filters

Inheritance Hierarchy

References

   
Module ToolWidgets
Header /Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Include #include "Filters/GenericFilter.h"

Syntax

template<typename FilterType>  
class FGenericFilter : public [FFilterBase< FilterType >](API\Developer\ToolWidgets\Filters\FFilterBase)  

Remarks

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

Variables

Type Name Description
FLinearColor Color  
FText DisplayName  
FOnItemFiltered FilterDelegate  
FName IconName  
FString Name Required members.
FText ToolTip Optional members.

Constructors

Type Name Description
  FGenericFilter ( TSharedPtr< FFilterCategory > InCat..., const FString& InName, const FText& DisplayName, FOnItemFiltered InFilterDelegate )  

Functions

Type Name Description
void SetColor ( const FLinearColor& InColor )  
void SetIconName ( const FName& InIconName )  
void SetToolTipText ( const FText& InToolTip )  

Overridden from FFilterBase

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

Overridden from IFilter

Type Name Description
FString GetName () Returns the system name for this filter
bool PassesFilter ( FilterType InItem ) Returns whether the specified Item passes the Filter's restrictions

Typedefs

Name Description
FOnItemFiltered  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library