1. Epic GamesDeveloper
  3. FTedsTableViewerModel

FTedsTableViewerModel

Model class for the TEDS Table Viewer that can be plugged into any widget that is a UI representation of data in TEDS

API > API/Plugins > API/Plugins/TedsTableViewer

Model class for the TEDS Table Viewer that can be plugged into any widget that is a UI representation of data in TEDS

   
Name FTedsTableViewerModel
Type class
Header File /Engine/Plugins/Experimental/EditorDataStorageFeatures/Source/TedsTableViewer/Public/TedsTableViewerModel.h
Include Path #include "TedsTableViewerModel.h"

Syntax

class FTedsTableViewerModel

Constructors

Name Remarks Include Path Unreal Specifiers

FTedsTableViewerModel ( const TSharedPtr< QueryStack::IRowNode >& RowQueryStack,
const TArray< TWeakObjectPtr< const UScriptStruct > >& RequestedColumns,
const IUiProvider::FPurposeID& CellWidgetPurpose,
const IUiProvider::FPurposeID& HeaderWidgetPurpose,
const FIsItemVisible& InIsItemVisibleDelegate
)

   TedsTableViewerModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FTedsTableViewerModel()

   TedsTableViewerModel.h  

Typedefs

Name Type Remarks Include Path
FIsItemVisible TBaseDelegate_OneParam< bool, TableViewerItemPtr >   TedsTableViewerModel.h
FOnModelChanged TMulticastDelegate_NoParams< void >   TedsTableViewerModel.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedRowQueryStackRevision uint32 Cached revision ID for the query stack used to check when the table viewer needs a refresh. TedsTableViewerModel.h  
CellWidgetPurpose IUiProvider::FPurposeID The widget purposes used to create widgets in this table viewer. TedsTableViewerModel.h  
ColumnsView TArray< TSharedRef< FTedsTableViewerColumn > > List of columns the table viewer is currently displaying. TedsTableViewerModel.h  
HeaderWidgetPurpose IUiProvider::FPurposeID   TedsTableViewerModel.h  
IsItemVisible FIsItemVisible Delegate supplied by the widget to check if an item is visible in the UI currently. TedsTableViewerModel.h  
Items TArray< TableViewerItemPtr > The cached list of rows we are currently displaying. TedsTableViewerModel.h  
OnModelChanged FOnModelChanged Delegate executed when the row list changes. TedsTableViewerModel.h  
PrimarySortColumnName FName The name of the active primary sort column or none if not set. TedsTableViewerModel.h  
RequestedTedsColumns TArray< TWeakObjectPtr< const UScriptStruct > > The initial TEDS columns the widget was requested to display. TedsTableViewerModel.h  
RowPrimaryInversionNode TSharedPtr< QueryStack::FRowOrderInversionNode > Inverts the rows from the query stack when needed by the primary sort. TedsTableViewerModel.h  
RowPrimarySortingNode TSharedPtr< QueryStack::FRowSortNode > Row node used to sort the rows in the query stack. TedsTableViewerModel.h  
RowQueryStack TSharedPtr< QueryStack::IRowNode > The row query stack used to supply the rows to display. TedsTableViewerModel.h  
RowSecondaryInversionNode TSharedPtr< QueryStack::FRowOrderInversionNode > Inverts the rows from the query stack when needed by the primary sort. TedsTableViewerModel.h  
RowSecondarySortingNode TSharedPtr< QueryStack::FRowSortNode > Row node used as a backup to sort the rows in the query stack. TedsTableViewerModel.h  
SecondarySortColumnName FName The name of the active secondary sort column or none if not set. TedsTableViewerModel.h  
Storage ICoreProvider * Teds Constructs. TedsTableViewerModel.h  
StorageUi IUiProvider *   TedsTableViewerModel.h  
TickerHandle FTSTicker::FDelegateHandle   TedsTableViewerModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCustomRowWidget ( const TSharedRef< FTedsTableViewerColumn >& InColumn
)

 Add a custom row widget to display in the table viewer, that doesn't necessarily map to a Teds column. TedsTableViewerModel.h  

void ForEachColumn ( const TFunctionRef< void(const TSharedRef< FTedsTableViewerColumn >&)>& Delegate
) const

 Execute a delegate for each column in the model. TedsTableViewerModel.h  

TSharedPtr< FTedsTableViewerColumn > GetColumn ( const FName& ColumnName
) const

 Get a specific column that the table viewer is displaying by name. TedsTableViewerModel.h  

uint64 GetColumnCount()

 Get the number of columns being displayed. TedsTableViewerModel.h  

int32 GetColumnIndex ( const FName& ColumnName
) const

 Get the index of a column by name (INDEX_NONE if column doesn't exist) TedsTableViewerModel.h  

ICoreProvider * GetDataStorageInterface()

   TedsTableViewerModel.h  

IUiProvider * GetDataStorageUiProvider()

   TedsTableViewerModel.h  

const TArray< TableViewerItemPtr > & GetItems()

 Get the items this table viewer is viewing. TedsTableViewerModel.h  

FOnModelChanged & GetOnModelChanged()

 Delegate when the item list changes. TedsTableViewerModel.h  

uint64 GetRowCount()

 Get the number of rows currently being observed. TedsTableViewerModel.h  
Get the bottom-most row node used in the query stack for this model. TedsTableViewerModel.h  

bool IsRowDisplayable ( RowHandle InRowHandle
) const

 Check whether a row is allowed to be displayed in the table viewer. TedsTableViewerModel.h  

void SetColumns ( const TArray< TWeakObjectPtr< const UScriptStruct > >& InColumns
)

 Clear the current list of columns being displayed and set it to the given list. TedsTableViewerModel.h  

void SetQueryStack ( const TSharedPtr< QueryStack::IRowNode >& InRowQueryStack
)

 Clear the current QueryStack being displayed, set it to the given node, and recreate the sorting nodes. TedsTableViewerModel.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GenerateColumns()

 Generate the actual columns to display in the UI using TEDS UI. TedsTableViewerModel.h  

bool IsRowVisible ( RowHandle InRowHandle
) const

 Check if the given row is currently visible in the UI. TedsTableViewerModel.h  

bool IsSorting()

   TedsTableViewerModel.h  

void OnSort ( FName ColumnName,
TSharedPtr< const FColumnSorterInterface > ColumnSorter,
EColumnSortMode::Type Direction,
EColumnSortPriority::Type Priority
)

   TedsTableViewerModel.h  

void Refresh()

   TedsTableViewerModel.h  

bool Tick ( float DeltaTime
)

   TedsTableViewerModel.h  

void ValidateRequestedColumns()

   TedsTableViewerModel.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page