Navigation
| Name | ToolWidgets |
| Type | Developer |
| Location | /Engine/Source/Developer/ToolWidgets/ |
| Module Build Rules | ToolWidgets.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FCustomTextFilter | A generic CustomTextFilter that can be created by providing a TTextFilter. |
| FDialogCommands | Class containing commands for dialog actions common to most dialogs |
| FDialogUtils | |
| FFilterBase | The base class for all Filters that can be used with FilterBar Widgets |
| FFilterCategory | |
| 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 |
| FToolWidgetsStyle | |
| SActionButton | A Button that is used to call out/highlight an option. It can also be used to open a menu. |
| SAvatar | Widget for displaying a user avatar icon. |
| SBasicFilterBar | A Basic Filter Bar widget, which can be used to filter items of type [FilterType] given a list of custom filters |
| SCheckBoxList | A widget that can be used inside a CustomDialog to display a list of checkboxes |
| SCustomDialog | This is a custom dialog class, which allows any Slate widget to be used as the contents, with any number of auto-generated buttons that have any text. |
| SCustomTextFilterDialog | |
| SDraggableBoxOverlay | Class that can be used to place a draggable box into a viewport or some other large widget as an overlay. |
| SFilterSearchBox | A SearchBox widget that contains support for displaying search history When used with a FilterBar widget ( |
| SMessageDialog | Special case of SCustomDialog dedicated to only displaying text messages. |
| SNegativeActionButton | A Button that is used to call out/highlight a negative option (Warnings or Errors like Force Delete). |
| SPositiveActionButton | A Button that is used to call out/highlight a positive option (Add, Save etc). |
| SPrimaryButton | |
| SRichTextWarningOrErrorBox | |
| SSearchableComboBox | A searchable text combo box |
| SSearchToggleButton | |
| SSegmentedTimelineView | A timeline view which renders a block for in the timeline where the object exists |
| SSidebar | Static sidebar tab widget that cannot be dragged or moved to a different location. |
| SSidebarContainer | A container for a sidebar widget that manages the slider drawer overlay widgets and a default docking location for all drawers. |
| SSimpleButton | |
| SSimpleComboButton | |
| SSimpleTimeSlider | |
| SVerticalResizeBox | |
| SWarningOrErrorBox | |
| SWidgetDrawer | |
| UFilterBarContext | ToolMenuContext that is used to create the Add Filter Menu |
| UToolSlateWidgetTypesFunctionLibrary |
Structs
| Name | Remarks |
|---|---|
| FActionButtonStyle | Represents the appearance of an SActionButton |
| FCustomTextFilterData | Struct containing the data that SCustomTextFilterDialog is currently editing |
| FDialogButtonTexts | |
| FExternalWidgetSelectionColumn | Column added to a widget row when an external widget manages selection for the widget referenced by the row, such as an owning SListView or STreeView |
| FFrontendFilterExternalActivationHelper | Forward declaration for a helper struct used to activate external filters |
| FHeaderWidgetSizeColumn | Column added to a header widget row to control the sizing when the default behavior is incorrect. |
| FOpenDrawerData | |
| FSidebarDrawerConfig | Configuration information used to register a sidebar drawer. |
| FSidebarDrawerState | Represents the state of a sidebar drawer to be saved/restored to/from config. |
| FSidebarState | Represents the state of a sidebar to be saved/restored to/from config. |
| FToolWidget_DragBoxPosition | Used to restore position of widget in SDraggableBoxOverlay. |
| FWidgetContextMenuColumn | Column added to a widget row to allow systems to provide a context menu for the widget |
| FWidgetDoubleClickedColumn | Column added to a widget row to allow systems to specify behavior when the widget is double clicked |
| FWidgetDrawerConfig | |
| FWidgetEnterEditModeColumn | Column that triggers a signal when the label is edited. |
| FWidgetRowScrolledIntoView | Column added to a widget row for table views to allow systems to specify behavior when a row is scrolled into view |
Interfaces
| Name | Remarks |
|---|---|
| IActionButton | |
| 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 |
| ISidebarDrawerContent |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetFocusWidget | TBaseDelegate_NoParams< TSharedPtr< SWidget > > | Delegate for functions to get the appropriate widget to focus on activation | Dialog/SCustomDialog.h |
| FOnCheckListItemStateChanged | TBaseDelegate_OneParam< void, int > | SCheckBoxList.h | |
| FOnExtendAddFilterMenu | TBaseDelegate_OneParam< void, UToolMenu * > | Delegate to extend a menu after it has been generated dynamically. | Filters/SBasicFilterBar.h |
| FOnPopulateAddFilterMenu | TBaseDelegate_OneParam< void, UToolMenu * > | Delegate used by SBasicFilterBar to populate the add filter menu | Filters/SBasicFilterBar.h |
| FOnSearchBoxShown | TBaseDelegate_NoParams< void > | SSearchToggleButton.h | |
| FOnSidebarStateChanged | TBaseDelegate_OneParam< void, const FSidebarState & > | Sidebar/SSidebar.h | |
| FOnStatusBarDrawerDismissed | TBaseDelegate_OneParam< void, const TSharedPtr< SWidget > & > | WidgetDrawerConfig.h | |
| FOnStatusBarDrawerOpened | TBaseDelegate_OneParam< void, FName StatusBarName > | WidgetDrawerConfig.h | |
| FOnStatusBarDrawerTargetHeightChanged | TBaseDelegate_OneParam< void, float > | SWidgetDrawer.h |
Enums
Public
| Name | Remarks |
|---|---|
| EActionButtonStyle | |
| EActionButtonType | |
| EFilterBarLayout | Describes if the filters are laid out horizontally (ScrollBox) or vertically (WrapBox) |
| EFilterPillStyle | Describes how each individual filter pill looks like |
| EMessageStyle | |
| ESidebarTabLocation | The direction that a tab drawer opens relative to the location of the sidebar. |