Navigation
API > API/Developer > API/Developer/ToolWidgets > API/Developer/ToolWidgets/SBasicFilterBar
A single filter in the filter list. Can be removed by clicking the remove button on it.
| Name | SFilter |
| Type | class |
| Header File | /Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h |
| Include Path | #include "Filters/SBasicFilterBar.h" |
Syntax
class SFilter : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBasicFilterBar::SFilter
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBasicFilterBar::SFilter
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnRequestDisableAll | TBaseDelegate_NoParams< void > | Filters/SBasicFilterBar.h | |
| FOnRequestEnableAll | TBaseDelegate_NoParams< void > | Filters/SBasicFilterBar.h | |
| FOnRequestEnableOnly | TBaseDelegate_OneParam< void, const TSharedRef< SFilter > & > | Filters/SBasicFilterBar.h | |
| FOnRequestRemove | TBaseDelegate_OneParam< void, const TSharedRef< SFilter > & > | Filters/SBasicFilterBar.h | |
| FOnRequestRemoveAll | TBaseDelegate_NoParams< void > | Filters/SBasicFilterBar.h | |
| FOnRequestRemoveAllButThis | TBaseDelegate_OneParam< void, const TSharedRef< SFilter > & > | Filters/SBasicFilterBar.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs this widget with InArgs | Filters/SBasicFilterBar.h | |
virtual FText GetFilterDisplayName() |
Returns the display name for this filter | Filters/SBasicFilterBar.h | |
virtual FString GetFilterName() |
Filters/SBasicFilterBar.h | ||
const TSharedPtr< FFilterBase< FilterType > > & GetFrontendFilter() |
If this is an front end filter, this is the filter object | Filters/SBasicFilterBar.h | |
bool IsEnabled() |
Returns true if this filter contributes to the combined filter | Filters/SBasicFilterBar.h | |
void SetEnabled
(
bool InEnabled, |
Sets whether or not this filter is applied to the combined filter | Filters/SBasicFilterBar.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct_Internal
(
EFilterPillStyle InFilterPillStyle |
Function that constructs the actual widget for subclasses to call | Filters/SBasicFilterBar.h | |
void DisableAllFilters() |
Disables all active filters in the list | Filters/SBasicFilterBar.h | |
void EnableAllFilters() |
Enables all filters in the list | Filters/SBasicFilterBar.h | |
void EnableOnly() |
Enables only this filter from the filter list | Filters/SBasicFilterBar.h | |
FReply FilterAltClicked() |
Handler for when the filter checkbox is clicked and an alt key is pressed | Filters/SBasicFilterBar.h | |
FReply FilterCtrlClicked() |
Handler for when the filter checkbox is clicked and a control key is pressed | Filters/SBasicFilterBar.h | |
FReply FilterDoubleClicked() |
Handler for when the filter checkbox is double clicked | Filters/SBasicFilterBar.h | |
FReply FilterMiddleButtonClicked() |
Handler for when the filter checkbox is middle button clicked | Filters/SBasicFilterBar.h | |
void FilterToggled
(
ECheckBoxState NewState |
Handler for when the filter checkbox is clicked | Filters/SBasicFilterBar.h | |
FSlateColor GetFilterImageColorAndOpacity() |
Handler to determine the color of the checkbox when it is checked | Filters/SBasicFilterBar.h | |
FMargin GetFilterNamePadding() |
Handler to determine the padding of the checkbox text when it is pressed | Filters/SBasicFilterBar.h | |
EVisibility GetFilterOverlayVisibility() |
Filters/SBasicFilterBar.h | ||
TSharedRef< SWidget > GetRightClickMenuContent() |
Handler to create a right click menu | Filters/SBasicFilterBar.h | |
ECheckBoxState IsChecked() |
Handler to determine the "checked" state of the filter checkbox | Filters/SBasicFilterBar.h | |
void RemoveAllButThis() |
Remove all but this filter from the filter list. | Filters/SBasicFilterBar.h | |
void RemoveAllFilters() |
Removes all filters in the list | Filters/SBasicFilterBar.h | |
void RemoveFilter() |
Removes this filter from the filter list | Filters/SBasicFilterBar.h |