Navigation
API > API/Developer > API/Developer/ToolWidgets
The base class for all Filters that can be used with FilterBar Widgets
| Name | FFilterBase |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h |
| Include Path | #include "Filters/FilterBase.h" |
Syntax
template<typename FilterType>
class FFilterBase : public IFilter< FilterType >
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFilterBase
(
TSharedPtr< FFilterCategory > InCategory |
Filters/FilterBase.h |
Classes
| Name | Remarks |
|---|---|
| FSetActiveEvent | This event is broadcast to when this filter is set Active |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FIsActiveEvent | TBaseDelegate_NoParams< bool > | Filters/FilterBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActiveStateChanged
(
bool bActive |
Notification that the filter became active or inactive | Filters/FilterBase.h | |
TSharedPtr< FFilterCategory > GetCategory() |
Filters/FilterBase.h | ||
FLinearColor GetColor() |
Returns the color this filter button will be when displayed as a button | Filters/FilterBase.h | |
FText GetDisplayName() |
Returns the human readable name for this filter | Filters/FilterBase.h | |
FName GetIconName() |
Returns the name of the icon to use in menu entries | Filters/FilterBase.h | |
FText GetToolTipText() |
Returns the tooltip for this filter, shown in the filters menu | Filters/FilterBase.h | |
bool IsActive() |
Checks whether the filter is checked/pinned and active/enabled | Filters/FilterBase.h | |
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) @See: FFrontendFilter_ShowOtherDevelopers in Content Browser | Filters/FilterBase.h | |
| Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any gneeric Filter Bar | Filters/FilterBase.h | ||
void ModifyContextMenu
(
FMenuBuilder& MenuBuilder |
Called when the right-click context menu is being built for this filter | Filters/FilterBase.h | |
| Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any gneeric Filter Bar | Filters/FilterBase.h | ||
void SetActive
(
bool bActive |
Set this filter as checked, and activates or deactivates it. | Filters/FilterBase.h |
Overridden from IFilter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetName() |
Returns the system name for this filter | Filters/FilterBase.h | |
virtual FChangedEvent & OnChanged() |
IFilter implementation. | Filters/FilterBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BroadcastChangedEvent() |
Filters/FilterBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void SetActiveInCollection
(
TSharedRef< FFilterBase< FilterType > > This, |
Manage the state of a filter in a collection taking into account whether it is an inverse filter or not. | Filters/FilterBase.h |
See Also
- FGenericFilter for a subclass that allows easy creation of filters