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 UE::Editor::DataStorage::SHierarchyViewer
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SHierarchyViewer → STedsCompositeHierarchyViewer
- FSlateControlledConstruction → SWidget → SCompoundWidget → SHierarchyViewer → STedsCompositeHierarchyViewer
Implements Interfaces
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EmptyRowsMessage | TAttribute< FText > | The message to show in place of the table viewer when there are no rows provided by the current query stack. | 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 | |
| ItemHeight | TAttribute< float > | The actual height of each item. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| ItemPadding | TAttribute< FMargin > | The actual padding between each item. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| Model | TSharedPtr< FTedsTableViewerModel > | Our model class. | Widgets/Composite/STedsCompositeHierarchyViewer.h | |
| OnSelectionChanged | FOnSelectionChanged | Delegate fired when the selection changes. | 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 |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs, |
Widgets/Composite/STedsCompositeHierarchyViewer.h |
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 |