Filters

API > API/Developer > API/Developer/ToolWidgets

Classes

  Type Name Description
Public class FCustomTextFilter A generic CustomTextFilter that can be created by providing a TTextFilter.  
Public struct UStruct FCustomTextFilterData Struct containing the data that SCustomTextFilterDialog is currently editing  
Public class FFilterBase The base class for all Filters that can be used with FilterBar Widgets  
Public class FFilterCategory    
Public struct FFrontendFilterExternalActivationHelper Forward declaration for a helper struct used to activate external filters  
Public class FGenericFilter A generic filter that can be used with the various FilterBar Widgets Takes in a Category, Name, Display Name and Delegate which specifies how to filter an item You can optionally specify a Tooltip, Icon Name or Color  
Public class ICustomTextFilter Interface class to define how a custom text filter converts to/from FCustomTextFilterDataFCustomTextFilter contains a generic implementation that can be used for most cases, look at FFrontendFilter_CustomText in the Content Browser for an example of a specific implementation  
Public class SBasicFilterBar A Basic Filter Bar widget, which can be used to filter items of type [FilterType] given a list of custom filters  
Public class UClass UFilterBarContext ToolMenuContext that is used to create the Add Filter Menu  

Typedefs

Name Description
FOnExtendAddFilterMenu Delegate to extend a menu after it has been generated dynamically.
FOnPopulateAddFilterMenu Delegate used by SBasicFilterBar to populate the add filter menu

Enums

  Type Name Description
Public enum UEnum EFilterBarLayout Describes if the filters are laid out horizontally (ScrollBox) or vertically (WrapBox)  
Public enum UEnum EFilterPillStyle Describes how each individual filter pill looks like  

Functions

  Type Name Description
Protected function TSharedRef< SFilter >

AddFilterToBar ( const TSharedRef< FFilterBase< FilterType > >& Filter
)

 'Activate' A filter by adding it to the filter bar, does not turn it on
Protected function void

AddFilterToBar ( const TSharedRef< SFilter >& FilterToAdd
)

 'Activate' A filter by adding it to the filter bar, does not turn it on
Protected function void

AddWidgetToLayout ( const TSharedRef< SWidget > WidgetToAdd
)

 Add a widget to the current filter layout
Protected function void Creates a dialog box to Add a custom text filter
Protected function void

CreateCustomTextFilterFromSearch ( const FText& InSearchText
)

 Creates a dialog to add a custom text filter from the given search text
Protected function void

CreateCustomTextFilterWindow ( const FCustomTextFilterData& CustomTextFilterData,
TSharedPtr< ICustomTextFilter< FilterType > > InFilter
)

 Creates a dialog box with the SCustomTextFilterDialog Widget
Protected function void Creates a dialog box to Edit an existing custom text filter
Protected function Const void Handler for when the add filter menu is populated by a non-category
Protected function Const void Handler for when the add filter menu is populated by a non-category
Protected function void Populate the Custom Filters submenu in the Add Filter dropdown
Protected function void

CustomTextFilterClicked ( ECheckBoxState CheckBoxState,
TSharedRef< ICustomTextFilter< FilterType > > Filter
)

 Handler for when a checkbox next to a custom text filter is clicked
Public function void Disable all the filters that are currently visible on the filter bar
Public function void Enable all the filters that are currently visible on the filter bar
Protected function void

EnableOnlyThisFilter ( const TSharedRef< SFilter >& FilterToEnable
)

 Handler for when the enable only this button was clicked on a single filter
Protected function void Handler for when a filter category is clicked
Protected function void

FrontendFilterChanged ( TSharedRef< FFilterBase< FilterType > > FrontendFilter
)

 Handler for when a frontend filter state has changed
Protected function void

FrontendFilterClicked ( TSharedRef< FFilterBase< FilterType > > FrontendFilter
)

 Handler for a frontend filter is clicked
Public function Virtual TSharedPtr< TFilterCollection< FilterType > > Use this function to get all currently active filters (to filter your items) Not const on purpose: Subclasses might need to update the filter collection before getting it
Protected function void

GetAllCustomTextFilterLabels ( TArray< FText >& OutFilterLabels
)

  
Public function Const TSharedPtr< FFilterBase< FilterType > >

GetFilter ( const FString& InName
)

 Retrieve a specific filter
Protected function Const const FSlateBrush * Overlay for filter icon, badge if there are any active filters
Public function Const ECheckBoxState

GetFilterCheckState ( const TSharedPtr< FFilterBase< FilterType > >& InFilter
)

 Returns the check box state of the specified filter (in the filter drop down).
Public function Const bool Returns true if any filters are applied
Public function Const bool

IsFilterActive ( const TSharedPtr< FFilterBase< FilterType > >& InFilter
)

 Returns true if the specified filter is both checked (pinned on the filter bar) and active (contributing to filter the result).
Protected function Const ECheckBoxState Handler to determine the "checked" state of a frontend filter category in the filter dropdown
Protected function Const bool Handler to check if a filter category is in use
Protected function Const bool

IsFrontendFilterInUse ( TSharedRef< FFilterBase< FilterType > > FrontendFilter
)

 Handler to check if a frontend filter is in use
Private function Virtual TSharedRef< SWidget > Handler for when the add filter button was clicked
Protected function Virtual void Handler to close the custom text filter dialog
Protected function Virtual void

OnCreateCustomTextFilter ( const FCustomTextFilterData& InFilterData,
bool bApplyFilter
)

 Handler for when a custom text filter is created
Protected function Virtual void

OnDeleteCustomTextFilter ( const TSharedPtr< ICustomTextFilter< FilterType > > InFilter
)

 Handler for when a custom text filter is deleted
Protected function bool

OnIsFilterActive ( TWeakPtr< FFilterBase< FilterType > > InWeakFilter
)

 Called externally to determine if a filter has been checked/pinned and activated
Protected function Virtual void

OnModifyCustomTextFilter ( const FCustomTextFilterData& InFilterData,
TSharedPtr< ICustomTextFilter< FilterType > > InFilter
)

 Handler for when a custom text filter is modified
Protected function void Called when reset filters option is pressed
Protected function void

OnSetFilterActive ( bool bActive,
TWeakPtr< FFilterBase< FilterType > > InWeakFilter
)

 Called externally to check/pin a filter, and activates/deactivates it
Private function void Function to populate the add filter menu
Protected function void Helper function to add common sections to the Add Filter Menu
Protected function void Helper function to add all custom filters to the Add Filter Menu
Protected function Virtual void

RemoveAllButThis ( const TSharedRef< SFilter >& FilterToKeep
)

 Remove all filters except the specified one
Public function Virtual void Remove all filters from the filter bar, while disabling any active ones
Protected function Virtual void

RemoveFilter ( const TSharedRef< SFilter >& FilterToRemove
)

 Remove a filter from the filter bar
Protected function void

RemoveFilter ( const TSharedRef< FFilterBase< FilterType > >& InFilterToRemove,
bool ExecuteOnFilterChanged
)

 Remove a filter from the filter bar
Protected function void

RemoveFilterAndUpdate ( const TSharedRef< SFilter >& FilterToRemove
)

 Remove a filter from the filter bar
Protected function void

RemoveWidgetFromLayout ( const TSharedRef< SWidget > WidgetToRemove
)

 Remove a widget from the current filter layout
Public function void

SetFilterCheckState ( const TSharedPtr< FFilterBase< FilterType > >& InFilter,
ECheckBoxState InCheckState
)

 Set the check box state of the specified filter (in the filter drop down) and pin/unpin a filter widget on/from the filter bar.
Protected function void

SetFrontendFilterActive ( const TSharedRef< FFilterBase< FilterType > >& Filter,
bool bActive
)

 Sets the active state of a frontend filter.

Variables

  Type Name Description
Protected variable TSharedPtr< TFilterCollection< FilterType > > ActiveFilters Currently active filter objects
Protected variable TArray< TSharedPtr< FFilterCategory > > AllFilterCategories All filter categories (for menu construction)
Protected variable TArray< TSharedRef< FFilterBase< FilterType > > > AllFrontendFilters All possible filter objects
Protected variable bool bCanChangeOrientation Whether the orientation can be changed after initailization
Protected variable bool bPinAllFrontendFilters Whether to pin all front end filters by default.
Protected variable bool bUseSectionsForCategories Whether to use submenus or sections for categories in the filter menu
Protected variable FCreateTextFilter CreateTextFilter A delegate used to create a TTextFilter for FilterType
Protected variable TArray< TSharedRef< ICustomTextFilter< FilterType > > > CustomTextFilters Custom text filters that a user can create
Protected variable TWeakPtr< SWindow > CustomTextFilterWindow The window containing the custom text filter dialog
Protected variable EFilterBarLayout FilterBarLayout The current Filter Layout being used
Protected variable TSharedPtr< SWidgetSwitcher > FilterBox The widget switcher containing the horizontal and vertical filter widgets
Protected variable EFilterPillStyle FilterPillStyle Determines how each individual pill looks like
Protected variable TArray< TSharedRef< SFilter > > Filters All SFilters in the list
Protected variable TSharedPtr< SWrapBox > HorizontalFilterBox The horizontal wrap box which contains all the filters (used in the horizontal layout)
Protected variable FOnExtendAddFilterMenu OnExtendAddFilterMenu Delegate to extend the AddFilter Menu
Protected variable FOnFilterChanged OnFilterChanged Delegate for when filters have changed
Protected variable TSharedPtr< SScrollBox > VerticalFilterBox The vertical scroll box which contains all the filters (used in the vertical layout)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page