Navigation
Unreal Engine C++ API Reference > Developer > ToolWidgets > Filters
Inheritance Hierarchy
References
Module | ToolWidgets |
Header | /Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h |
Include | #include "Filters/FilterBase.h" |
Syntax
template<typename FilterType>
class FFilterBase : public [IFilter< FilterType >](API\Runtime\Core\Misc\IFilter)
Remarks
The base class for all Filters that can be used with FilterBar Widgets
Variables
Type | Name | Description |
---|---|---|
FChangedEvent | ChangedEvent | |
TSharedPtr< FFi... | FilterCategory | |
FSetActiveEvent | SetActiveEvent |
Constructors
Type | Name | Description |
---|---|---|
FFilterBase ( TSharedPtr< FFilterCategory > InCat... ) |
Functions
Type | Name | Description |
---|---|---|
void | ActiveStateChanged ( bool bActive ) | Notification that the filter became active or inactive |
void | BroadcastChangedEvent () | |
TSharedPtr< ... | GetCategory () | |
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 () | If true, the filter will be active in the FilterBar when it is inactive in the UI (i.e the filter pill is grayed out) : FFrontendFilter_ShowOtherDevelopers in Content Browser |
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 gneeric 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 gneeric Filter Bar |
void | SetActive ( bool bInActive ) | Set this filter as active/inactive |
Overridden from IFilter
Type | Name | Description |
---|---|---|
FString | GetName () | Returns the system name for this filter |
FChangedEven... | OnChanged () | IFilter implementation. |
Classes
Type | Name | Description |
---|---|---|
Protected class | FSetActiveEvent | This event is broadcast to when this filter is set Active |
See Also
FGenericFilterfor a subclass that allows easy creation of filters