Navigation
API > API/Plugins > API/Plugins/TedsTableViewer
A hierarchy viewer widget can be used to show a visual representation of data in TEDS. This composite widget adds features in a 'default' layout such as searching and filtering. The rows to display can be specified using a RowQueryStack, and the columns to display are directly input into the widget Example usage:
SNew(STedsCompositeHierarchyViewer, HierarchyData) // Filtering and Searching enabled by default .HierarchyViewerArgs(SHierarchyViewer::FArguments() .AllNodeProvider(FilterNode) .Columns({ FTypedElementLabelColumn::StaticStruct(), FTypedElementClassTypeInfoColumn::StaticStruct() }) .CellWidgetPurpose(PurposeId) .Filters(MyCustomFilterArray);
| Name | STedsCompositeHierarchyViewer |
| Type | class |
| Header File | /Engine/Plugins/Experimental/EditorDataStorageFeatures/Source/TedsTableViewer/Public/Widgets/Composite/STedsCompositeHierarchyViewer.h |
| Include Path | #include "Widgets/Composite/STedsCompositeHierarchyViewer.h" |
Syntax
class STedsCompositeHierarchyViewer :
public SCompoundWidget ,
public UE::Editor::DataStorage::ITableViewer
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → STedsCompositeHierarchyViewer
- FSlateControlledConstruction → SWidget → SCompoundWidget → STedsCompositeHierarchyViewer
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bShowFilteredOutParentHierarchy | bool | Whether to add back the filtered out parent hierarchy (removed from searching or filtering) | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| CompositeQueryNode | TSharedPtr< QueryStack::IRowNode > | Final Composite Row Node given to the Hierarchy Viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| FilterBar | TSharedPtr< STedsFilterBar > | The filter bar widget (uses MakeAddFilterButton to create the menu dropdown) | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| FilterNode | TSharedPtr< QueryStack::IRowNode > | Row Node passed to the FilterBar that receives the filtered result. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| HierarchyViewer | TSharedPtr< SHierarchyViewer > | The actual HierarchyViewer widget that displays the rows. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| Options | TArray< TSharedPtr< FTedsCompositeHierarchyViewerOption > > | Option objects used to construct the settings menu. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| QueryNode | TSharedPtr< QueryStack::IRowNode > | Original Row Node given as the AllNodeProvider of the HierarchyViewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| SearchBox | TSharedPtr< STedsSearchBox > | The search box widget. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| SearchNode | TSharedPtr< QueryStack::IRowNode > | Row Node passed to the SearchBox that receives the searched result. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| SettingsComboButton | TSharedPtr< SComboButton > | Button used to bring up the settings menu. | Widgets/Composite/STedsCompositeHierarchyViewer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddFilter
(
const TSharedPtr< FTedsFilter > InFilter |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void AddFilters
(
const TArray< TSharedPtr< FTedsFilter > >& InFilters |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void CollapseAll() |
Recursively Collapse all rows currently present in the viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
void Construct
(
const FArguments& InArgs, |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void DeleteAllFilters() |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void DeleteFilter
(
const FName& InFilterName |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void ExpandAll() |
Recursively Expand all rows currently present in the viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
void ExpandWithParents
(
RowHandle Row |
Expand this row, and all its parents. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
void OnToggleExpandNewRows() |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
void OnToggleShowFilteredParentHierarchy() |
Menu actions. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
void ReplaceFilters
(
const TArray< TSharedPtr< FTedsFilter > >& InFilters, |
Widgets/Composite/STedsCompositeHierarchyViewer.h | ||
| Widgets/Composite/STedsCompositeHierarchyViewer.h | |||
void SetDropHandler
(
TUniquePtr< FWidgetDropHandler > InDropHandler |
Set a handler that this viewer will forward its drop operations to. | Widgets/Composite/STedsCompositeHierarchyViewer.h |
Public Virtual
Overridden from ITableViewer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddCustomRowWidget
(
const TSharedRef< FTedsTableViewerColumn >& InColumn |
Add a custom per-row widget to the table viewer (that doesn't necessarily map to a TEDS column) This means a new column for the table viewer | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual TSharedRef< SWidget > AsWidget() |
Get the table viewer as an SWidget. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void ClearSelection() |
Deselect all items in the table viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void ForEachSelectedRow
(
TFunctionRef< void(RowHandle)> InCallback |
Execute the given callback for each row that is selected in the table viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual RowHandle GetWidgetRowHandle() |
Get the row handle for the widget row the table viewer's contents are stored in. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual bool IsSelected
(
RowHandle InRow |
Get if a specific row is selected. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual bool IsSelectedExclusively
(
RowHandle InRow |
Get if a specific row is selected exclusively. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void ScrollIntoView
(
RowHandle Row |
Scroll the given row into view in the table viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void SetColumns
(
const TArray< TWeakObjectPtr< const UScriptStruct > >& InColumns |
Clear the current list of columns being displayed and set it to the given list. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void SetSelection
(
RowHandle Row, |
Select the given row in the table viewer. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
virtual void SetTableViewerIdentifier
(
const FName& NewIdentifier |
Sets the TableViewer/Hierarchy Identifier (Can be used in case data is dynamic and created post widget init) | Widgets/Composite/STedsCompositeHierarchyViewer.h |
Protected Virtual
Overridden from ITableViewer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void SetQueryStack
(
TSharedPtr< QueryStack::IRowNode > InRowQueryStack |
Clear the current QueryStack being displayed, set it to the given node, and recreate the sorting nodes. | Widgets/Composite/STedsCompositeHierarchyViewer.h |