SFilter

A single filter in the filter list. Can be removed by clicking the remove button on it.

Unreal Engine C++ API Reference > Developer > ToolWidgets > Filters > SBasicFilterBar

Inheritance Hierarchy

References

   
Module ToolWidgets
Header /Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Include #include "Filters/SBasicFilterBar.h"

Syntax

class SFilter : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)  

Remarks

A single filter in the filter list. Can be removed by clicking the remove button on it.

Variables

Type Name Description
bool bEnabled True when this filter should be applied to the search
FLinearColor FilterColor The color of the checkbox for this filter
TAttribute< FTe... FilterToolTip The tooltip for this filter
TSharedPtr< FFi... FrontendFilter If this is an front end filter, this is the filter object
FOnFilterChange... OnFilterChanged Invoked when the filter toggled
FOnRequestDisab... OnRequestDisableAll Invoked when a request to disable all filters originated from within this filter
FOnRequestEnabl... OnRequestEnableAll Invoked when a request to enable all filters originated from within this filter
FOnRequestEnabl... OnRequestEnableOnly Invoked when a request to enable only this filter originated from within this filter
FOnRequestRemov... OnRequestRemove Invoked when a request to remove this filter originated from within this filter
FOnRequestDisab... OnRequestRemoveAll Invoked when a request to remove all filters originated from within this filter
FOnRequestRemov... OnRequestRemoveAllButThis Invoked when a request to remove all filters except this one originated from within this filter
TSharedPtr< SFi... ToggleButtonPtr The button to toggle the filter on or off

Functions

Type Name Description
void Construct ( const FArguments& InArgs ) Constructs this widget with InArgs
void Construct_Internal ( EFilterPillStyle InFilterPillStyle ) Function that constructs the actual widget for subclasses to call
void DisableAllFilters () Disables all active filters in the list
void EnableAllFilters () Enables all filters in the list
void EnableOnly () Enables only this filter from the filter list
FReply FilterAltClicked () Handler for when the filter checkbox is clicked and an alt key is pressed
FReply FilterCtrlClicked () Handler for when the filter checkbox is clicked and a control key is pressed
FReply FilterDoubleClicked () Handler for when the filter checkbox is double clicked
FReply FilterMiddleButtonClicked () Handler for when the filter checkbox is middle button clicked
void FilterToggled ( ECheckBoxState NewState ) Handler for when the filter checkbox is clicked
FText GetFilterDisplayName () Returns the display name for this filter
FSlateColor GetFilterImageColorAndOpacity () Handler to determine the color of the checkbox when it is checked
FString GetFilterName ()  
FMargin GetFilterNamePadding () Handler to determine the padding of the checkbox text when it is pressed
EVisibility GetFilterOverlayVisibility ()  
const TShare... GetFrontendFilter () If this is an front end filter, this is the filter object
TSharedRef< ... GetRightClickMenuContent () Handler to create a right click menu
ECheckBoxSta... IsChecked () Handler to determine the "checked" state of the filter checkbox
bool IsEnabled () Returns true if this filter contributes to the combined filter
void RemoveAllButThis () Remove all but this filter from the filter list.
void RemoveAllFilters () Removes all filters in the list
void RemoveFilter () Removes this filter from the filter list
void SetEnabled ( bool InEnabled, bool InExecuteOnFilterChanged ) Sets whether or not this filter is applied to the combined filter

Classes

Type Name Description
Public struct FArguments  

Typedefs


Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library