Navigation
API > API/Developer > API/Developer/ToolWidgets
A generic CustomTextFilter that can be created by providing a TTextFilter. Provide a delegate to a filter bar widget's CreateTextFilter argument that creates an instance of this class to handle most generic text comparisons.
| Name | FCustomTextFilter |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h |
| Include Path | #include "Filters/CustomTextFilters.h" |
Syntax
template<typename FilterType>
class FCustomTextFilter :
public FFilterBase< FilterType > ,
public ICustomTextFilter< FilterType > ,
public TSharedFromThis< FCustomTextFilter< FilterType > >
Inheritance Hierarchy
- FFilterBase → FCustomTextFilter
- FSharedFromThisBase → TSharedFromThis → FCustomTextFilter
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCustomTextFilter
(
TSharedPtr< TTextFilter< FilterType > > InTextFilter |
Filters/CustomTextFilters.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetFilterString() |
Get the actual text this filter is using to test against | Filters/CustomTextFilters.h | |
virtual bool PassesFilter
(
FilterType InItem |
Filters/CustomTextFilters.h | ||
virtual void SetColor
(
const FLinearColor& InColor |
Set the color this filter button will be when displayed as a button | Filters/CustomTextFilters.h | |
virtual void SetDisplayName
(
const FText& InDisplayName |
Set the human readable name for this filter | Filters/CustomTextFilters.h | |
virtual void SetFilterString
(
const FText& InFilterString |
Set the actual text this filter is using to test against | Filters/CustomTextFilters.h |
Overridden from FFilterBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ActiveStateChanged
(
bool bActive |
Notification that the filter became active or inactive | Filters/CustomTextFilters.h | |
virtual FLinearColor GetColor() |
Returns the color this filter button will be when displayed as a button | Filters/CustomTextFilters.h | |
virtual FText GetDisplayName() |
Returns the human readable name for this filter | Filters/CustomTextFilters.h | |
virtual FName GetIconName() |
Returns the name of the icon to use in menu entries | Filters/CustomTextFilters.h | |
virtual FText GetToolTipText() |
Returns the tooltip for this filter, shown in the filters menu | Filters/CustomTextFilters.h | |
virtual bool IsInverseFilter() |
Returns true if the filter should be in the list when disabled and not in the list when enabled | Filters/CustomTextFilters.h | |
| Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any generic Filter Bar | Filters/CustomTextFilters.h | ||
virtual void ModifyContextMenu
(
FMenuBuilder& MenuBuilder |
Called when the right-click context menu is being built for this filter | Filters/CustomTextFilters.h | |
| Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any generic Filter Bar | Filters/CustomTextFilters.h |
Overridden from IFilter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetName() |
Returns the system name for this filter | Filters/CustomTextFilters.h |
Overridden from ICustomTextFilter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FCustomTextFilterData CreateCustomTextFilterData() |
Create an FCustomTextFilterData from the internals of this filter | Filters/CustomTextFilters.h | |
virtual TSharedPtr< FFilterBase< FilterType > > GetFilter() |
Get the actual filter | Filters/CustomTextFilters.h | |
virtual void SetFromCustomTextFilterData
(
const FCustomTextFilterData& InFilterData |
Set the internals of this filter from an FCustomTextFilterData | Filters/CustomTextFilters.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetFilterTypeName() |
All FCustomTextFilters have the same internal name, this is a helper function to get that name to test against | Filters/CustomTextFilters.h |