className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
SMessageDialog::FArguments::Message
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Message content
ToolWidgets
WidgetArgsType & Message &40; FText InArg &41;
[]
SMessageDialog::FArguments::OnClosed
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Event triggered when the dialog is closed, either because one of the buttons is pressed, or the windows is closed.
ToolWidgets
WidgetArgsType & OnClosed &40; const FSimpleDelegate & InDelegate &41;
[]
SMessageDialog::FArguments::ScrollBoxMaxHeight
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Max height for the scroll box (default: 300)
ToolWidgets
WidgetArgsType & ScrollBoxMaxHeight &40; int32 InArg &41;
[]
SMessageDialog::FArguments::Title
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Title to display for the dialog.
ToolWidgets
WidgetArgsType & Title &40; FText InArg &41;
[]
SMessageDialog::FArguments::UseScrollBox
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Should this dialog use a scroll box for over-sized content? (default: true)
ToolWidgets
WidgetArgsType & UseScrollBox &40; bool InArg &41;
[]
WidgetArgsType
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
ToolWidgets
typedef FArguments WidgetArgsType
[]
SMessageDialog::FArguments::WindowArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Provides default values forSWindow::FArgumentsnot overriden bySCustomDialog.
ToolWidgets
WidgetArgsType & WindowArguments &40; SWindow::FArguments InArg &41;
[]
SMessageDialog::FArguments::WrapMessageAt
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
When to wrap the message text (default: 512)
ToolWidgets
WidgetArgsType & WrapMessageAt &40; const TAttribute< float > & InAttribute &41;
[]
SMessageDialog::FArguments::FArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
ToolWidgets
FArguments&40;&41;
[]
FArguments
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
ToolWidgets
struct FArguments : public [TSlateBaseNamedArgs< SMessageDialog >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
FButton
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Convenience for code using this class.
ToolWidgets
typedef [SCustomDialog::FButton](API\Developer\ToolWidgets\Dialog\SCustomDialog\FButton) FButton
[]
SMessageDialog::OnCopyMessage
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
ToolWidgets
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnCopyMessage()
[]
SMessageDialog::OnKeyDown
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Called after a key is pressed when this widget has focus (this event bubbles if not handled) Returns whether the event was handled, along with other possible actions
ToolWidgets
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )
[]
SMessageDialog
/Engine/Source/Developer/ToolWidgets/Public/Dialog/SMessageDialog.h
Special case ofSCustomDialogdedicated to only displaying text messages. This class enforces uniform style and also adds a button for copying the message.
ToolWidgets
class SMessageDialog : public [SCustomDialog](API\Developer\ToolWidgets\Dialog\SCustomDialog)
[]
EActionButtonStyle
/Engine/Source/Developer/ToolWidgets/Public/SNegativeActionButton.h
ToolWidgets
enum EActionButtonStyle { Warning, Error, }
[]
EMessageStyle
/Engine/Source/Developer/ToolWidgets/Public/SWarningOrErrorBox.h
ToolWidgets
enum EMessageStyle { Warning, Error, }
[]
EFilterBarLayout
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Describes if the filters are laid out horizontally (ScrollBox) or vertically (WrapBox)
ToolWidgets
enum EFilterBarLayout { Horizontal, Vertical, }
[]
EFilterPillStyle
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Describes how each individual filter pill looks like
ToolWidgets
enum EFilterPillStyle { Default, Basic, }
[]
FCustomTextFilter::ActiveStateChanged
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Notification that the filter became active or inactive
ToolWidgets
virtual void ActiveStateChanged ( bool bActive )
[]
FCustomTextFilter::GetColor
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns the color this filter button will be when displayed as a button
ToolWidgets
virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColor() const
[]
FCustomTextFilter::CreateCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Create anFCustomTextFilterDatafrom the internals of this filter
ToolWidgets
virtual [FCustomTextFilterData](API\Developer\ToolWidgets\Filters\FCustomTextFilterData) CreateCustomTextFilterData() const
[]
FCustomTextFilter::GetDisplayName
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns the human readable name for this filter
ToolWidgets
virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
FCustomTextFilter::GetFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Get the actual filter
ToolWidgets
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterBase](API\Developer\ToolWidgets\Filters\FFilterBase)< FilterType > > GetFilter()
[]
FCustomTextFilter::GetFilterString
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Get the actual text this filter is using to test against
ToolWidgets
virtual [FText](API\Runtime\Core\Internationalization\FText) GetFilterString() const
[]
FCustomTextFilter::GetFilterTypeName
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
All FCustomTextFilters have the same internal name, this is a helper function to get that name to test against
ToolWidgets
static [FName](API\Runtime\Core\UObject\FName) GetFilterTypeName()
[]
FCustomTextFilter::GetIconName
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns the name of the icon to use in menu entries
ToolWidgets
virtual [FName](API\Runtime\Core\UObject\FName) GetIconName() const
[]
FCustomTextFilter::GetName
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns the system name for this filter
ToolWidgets
virtual [FString](API\Runtime\Core\Containers\FString) GetName() const
[]
FCustomTextFilter::GetToolTipText
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns the tooltip for this filter, shown in the filters menu
ToolWidgets
virtual [FText](API\Runtime\Core\Internationalization\FText) GetToolTipText() const
[]
FCustomTextFilter::LoadSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any generic Filter Bar
ToolWidgets
virtual void LoadSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString )
[]
FCustomTextFilter::IsInverseFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns true if the filter should be in the list when disabled and not in the list when enabled
ToolWidgets
virtual bool IsInverseFilter() const
[]
FCustomTextFilter::PassesFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Returns whether the specified Item passes the Filter's restrictions
ToolWidgets
virtual bool PassesFilter ( FilterType InItem ) const
[]
FCustomTextFilter::ModifyContextMenu
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Called when the right-click context menu is being built for this filter
ToolWidgets
virtual void ModifyContextMenu ( [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) & MenuBuilder )
[]
FCustomTextFilter::SaveSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any generic Filter Bar
ToolWidgets
virtual void SaveSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString ) const
[]
FCustomTextFilter::SetColor
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Set the color this filter button will be when displayed as a button
ToolWidgets
virtual void SetColor ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor )
[]
FCustomTextFilter::SetDisplayName
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Set the human readable name for this filter
ToolWidgets
virtual void SetDisplayName ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName )
[]
FCustomTextFilter::SetFilterString
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Set the actual text this filter is using to test against
ToolWidgets
virtual void SetFilterString ( const [FText](API\Runtime\Core\Internationalization\FText) & InFilterString )
[]
FCustomTextFilter::SetFromCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Set the internals of this filter from anFCustomTextFilterData
ToolWidgets
virtual void SetFromCustomTextFilterData ( const [FCustomTextFilterData](API\Developer\ToolWidgets\Filters\FCustomTextFilterData) & InFilterData )
[]
FCustomTextFilter::FCustomTextFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
ToolWidgets
FCustomTextFilter ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TTextFilter](API\Runtime\Core\Misc\TTextFilter)< FilterType >> InTextFilter )
[]
FCustomTextFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
A generic CustomTextFilter that can be created by providing aTTextFilter. Provide a delegate to a filter bar widget's CreateTextFilter argument that creates an instance of this class to handle most generic text comparisons.
ToolWidgets
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)
[ { "type": "FLinearColor", "name": "Color", "description": "The Color of this filter pill" }, { "type": "FText", "name": "DisplayName", "description": "The Display Name of this custom filter that the user sees" }, { "type": "TSharedPtr<TTe...", "name": "TextFilter", "description": "The actual Text Filter containing information about the text being tested against" } ]
FCustomTextFilterData::FCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
ToolWidgets
FCustomTextFilterData()
[]
FCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Struct containing the data thatSCustomTextFilterDialogis currently editing
ToolWidgets
struct FCustomTextFilterData
[ { "type": "FLinearColor", "name": "FilterColor", "description": "" }, { "type": "FText", "name": "FilterLabel", "description": "" }, { "type": "FText", "name": "FilterString", "description": "" } ]
FFilterBase::ActiveStateChanged
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Notification that the filter became active or inactive
ToolWidgets
void ActiveStateChanged ( bool bActive )
[]
FFilterBase::BroadcastChangedEvent
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
ToolWidgets
void BroadcastChangedEvent() const
[]
FSetActiveEvent
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
This event is broadcast to when this filter is set Active
ToolWidgets
class FSetActiveEvent : public TBaseMulticastDelegate_OneParam< void, bool >
[]
FFilterBase::GetCategory
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
ToolWidgets
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > GetCategory()
[]
FFilterBase::GetColor
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Returns the color this filter button will be when displayed as a button
ToolWidgets
[FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColor() const
[]
FFilterBase::GetDisplayName
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Returns the human readable name for this filter
ToolWidgets
[FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
FFilterBase::GetIconName
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Returns the name of the icon to use in menu entries
ToolWidgets
[FName](API\Runtime\Core\UObject\FName) GetIconName() const
[]
FFilterBase::GetName
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Returns the system name for this filter
ToolWidgets
[FString](API\Runtime\Core\Containers\FString) GetName() const
[]
FFilterBase::GetToolTipText
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Returns the tooltip for this filter, shown in the filters menu
ToolWidgets
[FText](API\Runtime\Core\Internationalization\FText) GetToolTipText() const
[]
FFilterBase::IsInverseFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
If true, the filter will be active in the FilterBar when it is inactive in the UI (i.e the filter pill is grayed out) :FFrontendFilter_ShowOtherDevelopersin Content Browser
ToolWidgets
bool IsInverseFilter() const
[]
FFilterBase::LoadSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any gneeric Filter Bar
ToolWidgets
void LoadSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString )
[]
FFilterBase::ModifyContextMenu
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Called when the right-click context menu is being built for this filter
ToolWidgets
void ModifyContextMenu ( [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) & MenuBuilder )
[]
FFilterBase::OnChanged
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
IFilterimplementation.
ToolWidgets
virtual FChangedEvent & OnChanged()
[]
FFilterBase::SaveSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any gneeric Filter Bar
ToolWidgets
void SaveSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString ) const
[]
FFilterBase::SetActive
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Set this filter as active/inactive
ToolWidgets
void SetActive ( bool bInActive )
[]
FFilterBase::FFilterBase
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
ToolWidgets
FFilterBase ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > InCategory )
[]
FFilterBase
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
FGenericFilterfor a subclass that allows easy creation of filters
ToolWidgets
template<typename FilterType> class FFilterBase : public [IFilter< FilterType >](API\Runtime\Core\Misc\IFilter)
[ { "type": "FChangedEvent", "name": "ChangedEvent", "description": "" }, { "type": "TSharedPtr<FFi...", "name": "FilterCategory", "description": "" }, { "type": "FSetActiveEvent", "name": "SetActiveEvent", "description": "" } ]
FFilterCategory::FFilterCategory
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
ToolWidgets
FFilterCategory ( const [FText](API\Runtime\Core\Internationalization\FText) & InTitle, const [FText](API\Runtime\Core\Internationalization\FText) & InTooltip )
[]
FFilterCategory
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
ToolWidgets
class FFilterCategory
[ { "type": "constFText", "name": "Title", "description": "The title of this category, used for the menu heading" }, { "type": "constFText", "name": "Tooltip", "description": "The menu tooltip for this category" } ]
FFrontendFilterExternalActivationHelper::BindToFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
ToolWidgets
static void BindToFilter ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SBasicFilterBar](API\Developer\ToolWidgets\Filters\SBasicFilterBar)< FilterType >> InFilterList, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FFilterBase](API\Developer\ToolWidgets\Filters\FFilterBase)< FilterType >> InFrontendFilter )
[]
FFrontendFilterExternalActivationHelper
/Engine/Source/Developer/ToolWidgets/Public/Filters/FilterBase.h
Helper struct to avoid friending the whole of SBasicFilterBarSBasicFilterBar
ToolWidgets
template<typename FilterType> struct FFrontendFilterExternalActivationHelper
[]
FOnItemFiltered
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
ToolWidgets
typedef TBaseDelegate_OneParam< bool, FilterType > FOnItemFiltered
[]
FGenericFilter::ActiveStateChanged
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Notification that the filter became active or inactive
ToolWidgets
virtual void ActiveStateChanged ( bool bActive )
[]
FGenericFilter::GetColor
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns the color this filter button will be when displayed as a button
ToolWidgets
virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetColor() const
[]
FGenericFilter::GetDisplayName
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns the human readable name for this filter
ToolWidgets
virtual [FText](API\Runtime\Core\Internationalization\FText) GetDisplayName() const
[]
FGenericFilter::GetName
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns the system name for this filter
ToolWidgets
virtual [FString](API\Runtime\Core\Containers\FString) GetName() const
[]
FGenericFilter::GetIconName
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns the name of the icon to use in menu entries
ToolWidgets
virtual [FName](API\Runtime\Core\UObject\FName) GetIconName() const
[]
FGenericFilter::GetToolTipText
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns the tooltip for this filter, shown in the filters menu
ToolWidgets
virtual [FText](API\Runtime\Core\Internationalization\FText) GetToolTipText() const
[]
FGenericFilter::IsInverseFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns true if the filter should be in the list when disabled and not in the list when enabled
ToolWidgets
virtual bool IsInverseFilter() const
[]
FGenericFilter::LoadSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Can be overriden for custom FilterBar subclasses to load settings, currently not implemented in any generic Filter Bar
ToolWidgets
virtual void LoadSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString )
[]
FGenericFilter::ModifyContextMenu
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Called when the right-click context menu is being built for this filter
ToolWidgets
virtual void ModifyContextMenu ( [FMenuBuilder](API\Runtime\Slate\Framework\MultiBox\FMenuBuilder) & MenuBuilder )
[]
FGenericFilter::PassesFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Returns whether the specified Item passes the Filter's restrictions
ToolWidgets
virtual bool PassesFilter ( FilterType InItem ) const
[]
FGenericFilter::SaveSettings
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
Can be overriden for custom FilterBar subclasses to save settings, currently not implemented in any generic Filter Bar
ToolWidgets
virtual void SaveSettings ( const [FString](API\Runtime\Core\Containers\FString) & IniFilename, const [FString](API\Runtime\Core\Containers\FString) & IniSection, const [FString](API\Runtime\Core\Containers\FString) & SettingsString ) const
[]
FGenericFilter::SetToolTipText
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
ToolWidgets
void SetToolTipText ( const [FText](API\Runtime\Core\Internationalization\FText) & InToolTip )
[]
FGenericFilter::FGenericFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
ToolWidgets
FGenericFilter ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > InCategory, const [FString](API\Runtime\Core\Containers\FString) & InName, const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, [FOnItemFiltered](API\Developer\ToolWidgets\Filters\FGenericFilter\FOnItemFiltered) InFilterDelegate )
[]
FGenericFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
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
ToolWidgets
template<typename FilterType> class FGenericFilter : public [FFilterBase< FilterType >](API\Developer\ToolWidgets\Filters\FFilterBase)
[ { "type": "FLinearColor", "name": "Color", "description": "" }, { "type": "FText", "name": "DisplayName", "description": "" }, { "type": "FOnItemFiltered", "name": "FilterDelegate", "description": "" }, { "type": "FName", "name": "IconName", "description": "" }, { "type": "FString", "name": "Name", "description": "Required members." }, { "type": "FText", "name": "ToolTip", "description": "Optional members." } ]
FOnPopulateAddFilterMenu
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Delegate used bySBasicFilterBarto populate the add filter menu
ToolWidgets
typedef TBaseDelegate_OneParam< void, [UToolMenu](API\Developer\ToolMenus\UToolMenu) * > FOnPopulateAddFilterMenu
[]
ICustomTextFilter::CreateCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Create anFCustomTextFilterDatafrom the internals of this filter
ToolWidgets
[FCustomTextFilterData](API\Developer\ToolWidgets\Filters\FCustomTextFilterData) CreateCustomTextFilterData() const
[]
ICustomTextFilter::GetFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Get the actual filter
ToolWidgets
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterBase](API\Developer\ToolWidgets\Filters\FFilterBase)< FilterType > > GetFilter()
[]
ICustomTextFilter::SetFromCustomTextFilterData
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Set the internals of this filter from anFCustomTextFilterData
ToolWidgets
void SetFromCustomTextFilterData ( const [FCustomTextFilterData](API\Developer\ToolWidgets\Filters\FCustomTextFilterData) & InFilterData )
[]
ICustomTextFilter::~ICustomTextFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
ToolWidgets
virtual ~ICustomTextFilter()
[]
ICustomTextFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/CustomTextFilters.h
Interface class to define how a custom text filter converts to/fromFCustomTextFilterDataFCustomTextFiltercontains 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
ToolWidgets
template<typename FilterType> class ICustomTextFilter
[]
SBasicFilterBar::AddFilter
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Add a custom filter to the FilterBar. NOTE: This only adds it to the Add Filter Menu, and does not automatically add it to the filter bar or activate it
ToolWidgets
void AddFilter ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FFilterBase](API\Developer\ToolWidgets\Filters\FFilterBase)< FilterType >> InFilter )
[]
FGenericFilter::SetIconName
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
ToolWidgets
void SetIconName ( const [FName](API\Runtime\Core\UObject\FName) & InIconName )
[]
SBasicFilterBar::AddFilterToBar
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
'Activate' A filter by adding it to the filter bar, does not turn it on
ToolWidgets
void AddFilterToBar ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SFilter](API\Developer\ToolWidgets\Filters\SBasicFilterBar\SFilter) > & FilterToAdd )
[]
FGenericFilter::SetColor
/Engine/Source/Developer/ToolWidgets/Public/Filters/GenericFilter.h
ToolWidgets
void SetColor ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InColor )
[]
SBasicFilterBar::AddFilterToBar
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
'Activate' A filter by adding it to the filter bar, does not turn it on
ToolWidgets
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SFilter](API\Developer\ToolWidgets\Filters\SBasicFilterBar\SFilter) > AddFilterToBar ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FFilterBase](API\Developer\ToolWidgets\Filters\FFilterBase)< FilterType >> & Filter )
[]
SBasicFilterBar::AddWidgetToLayout
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Add a widget to the current filter layout
ToolWidgets
void AddWidgetToLayout ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > WidgetToAdd )
[]
SBasicFilterBar::AttachFilterSearchBox
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Attach anSFilterSearchBoxto this filter bar, overriding theSFilterSearchBox:: OnSaveSearchClicked event to save a search as a filter
ToolWidgets
void AttachFilterSearchBox ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SFilterSearchBox](API\Developer\ToolWidgets\Filters\SFilterSearchBox) > InFilterSearchBox )
[]
SBasicFilterBar::Construct
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
ToolWidgets
void Construct ( const [FArguments](API\Developer\ToolWidgets\Filters\SBasicFilterBar\FArguments) & InArgs )
[]
SBasicFilterBar::CreateAddCustomTextFilterWindow
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Creates a dialog box to Add a custom text filter
ToolWidgets
void CreateAddCustomTextFilterWindow()
[]
SBasicFilterBar::CreateCustomTextFilterFromSearch
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Creates a dialog to add a custom text filter from the given search text
ToolWidgets
void CreateCustomTextFilterFromSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText )
[]
SBasicFilterBar::CreateCustomTextFilterWindow
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Creates a dialog box with theSCustomTextFilterDialogWidget
ToolWidgets
void CreateCustomTextFilterWindow ( const [FCustomTextFilterData](API\Developer\ToolWidgets\Filters\FCustomTextFilterData) & CustomTextFilterData, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ICustomTextFilter](API\Developer\ToolWidgets\Filters\ICustomTextFilter)< FilterType >> InFilter )
[]
SBasicFilterBar::CreateEditCustomTextFilterWindow
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Creates a dialog box to Edit an existing custom text filter
ToolWidgets
void CreateEditCustomTextFilterWindow ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ICustomTextFilter](API\Developer\ToolWidgets\Filters\ICustomTextFilter)< FilterType >> InFilter )
[]
SBasicFilterBar::CreateOtherFiltersMenuCategory
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Handler for when the add filter menu is populated by a non-category
ToolWidgets
void CreateOtherFiltersMenuCategory ( [FToolMenuSection](API\Developer\ToolMenus\FToolMenuSection) & Section, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > MenuCategory ) const
[]
SBasicFilterBar::CreateOtherFiltersMenuCategory
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Handler for when the add filter menu is populated by a non-category
ToolWidgets
void CreateOtherFiltersMenuCategory ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InMenu, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FFilterCategory](API\Developer\ToolWidgets\Filters\FFilterCategory) > MenuCategory ) const
[]
SBasicFilterBar::CreateTextFiltersMenu
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Populate the Custom Filters submenu in the Add Filter dropdown
ToolWidgets
void CreateTextFiltersMenu ( [UToolMenu](API\Developer\ToolMenus\UToolMenu) * InMenu )
[]
SBasicFilterBar::CustomTextFilterClicked
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Handler for when a checkbox next to a custom text filter is clicked
ToolWidgets
void CustomTextFilterClicked ( ECheckBoxState CheckBoxState, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ICustomTextFilter](API\Developer\ToolWidgets\Filters\ICustomTextFilter)< FilterType >> Filter )
[]
SBasicFilterBar::DisableAllFilters
/Engine/Source/Developer/ToolWidgets/Public/Filters/SBasicFilterBar.h
Disable all the filters that are currently visible on the filter bar
ToolWidgets
void DisableAllFilters()
[]