Navigation
Unreal Engine C++ API Reference > Developer > ToolWidgets > Filters
Inheritance Hierarchy
References
Module | ToolWidgets |
Header | /Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h |
Include | #include "Filters/CustomTextFilters.h" |
Syntax
template<typename FilterType>
class FCustomTextFilter :
public [FFilterBase< FilterType >](API\Developer\ToolWidgets\Filters\FFilterBase),
public [ICustomTextFilter< FilterType >](API\Developer\ToolWidgets\Filters\ICustomTextFilter),
public [TSharedFromThis< FCustomTextFilter< FilterType > >](API\Runtime\Core\Templates\TSharedFromThis)
Remarks
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.
Variables
Type | Name | Description |
---|---|---|
FLinearColor | Color | The Color of this filter pill |
FText | DisplayName | The Display Name of this custom filter that the user sees |
TSharedPtr< TTe... | TextFilter | The actual Text Filter containing information about the text being tested against |
Constructors
Type | Name | Description |
---|---|---|
FCustomTextFilter ( TSharedPtr< TTextFilter< FilterType... ) |
Functions
Type | Name | Description |
---|---|---|
FText | GetFilterString () | Get the actual text this filter is using to test against |
FName | GetFilterTypeName () | All FCustomTextFilters have the same internal name, this is a helper function to get that name to test against |
void | SetColor ( const FLinearColor& InColor ) | Set the color this filter button will be when displayed as a button |
void | SetDisplayName ( const FText& InDisplayName ) | Set the human readable name for this filter |
void | SetFilterString ( const FText& InFilterString ) | Set the actual text this filter is using to test against |
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 |
Overridden from ICustomTextFilter
Type | Name | Description |
---|---|---|
FCustomTextF... | CreateCustomTextFilterData () | Create an FCustomTextFilterData from the internals of this filter |
TSharedPtr< ... | GetFilter () | Get the actual filter |
void | SetFromCustomTextFilterData ( const FCustomTextFilterData& InFil... ) | Set the internals of this filter from an FCustomTextFilterData |