ITypedTableView< ItemType > Class Template Reference

#include <ITypedTableView.h>

Inheritance diagram for ITypedTableView< ItemType >:

Public Member Functions
virtual bool	Private_UsesSelectorFocus () const =0
virtual bool	Private_HasSelectorFocus (const ItemType &TheItem) const =0
virtual bool	Private_IsItemSelected (const ItemType &TheItem) const =0
virtual bool	Private_IsItemSelectableOrNavigable (const ItemType &TheItem) const =0
virtual bool	Private_IsItemHighlighted (const ItemType &TheItem) const =0
virtual void	Private_SetItemSelection (ItemType TheItem, bool bShouldBeSelected, bool bWasUserDirected=false)=0
virtual void	Private_ClearSelection ()=0
virtual void	Private_SelectRangeFromCurrentTo (ItemType SelectorItem)=0
virtual void	Private_SignalSelectionChanged (ESelectInfo::Type SelectInfo)=0
virtual const TObjectPtrWrapTypeOf< ItemType > *	Private_ItemFromWidget (const ITableRow *TheWidget) const =0
virtual void	Private_SetItemExpansion (ItemType TheItem, bool bShouldBeExpanded)=0
virtual void	Private_OnExpanderArrowShiftClicked (ItemType TheItem, bool bShouldBeExpanded)=0
virtual bool	Private_IsItemExpanded (const ItemType &TheItem) const =0
virtual bool	Private_DoesItemHaveChildren (int32 ItemIndexInList) const =0
virtual int32	Private_GetNumSelectedItems () const =0
virtual void	Private_SetItemHighlighted (ItemType TheItem, bool bShouldBeHighlighted)=0
virtual void	Private_ClearHighlightedItems ()=0
virtual int32	Private_GetNestingDepth (int32 ItemIndexInList) const =0
virtual const TBitArray &	Private_GetWiresNeededByDepth (int32 ItemIndexInList) const =0
virtual bool	Private_IsLastChild (int32 ItemIndexInList) const =0
virtual void	Private_OnItemRightClicked (ItemType TheItem, const FPointerEvent &MouseEvent)=0
virtual bool	Private_OnItemClicked (ItemType TheItem)=0
virtual bool	Private_OnItemDoubleClicked (ItemType TheItem)=0
virtual ESelectionMode::Type	Private_GetSelectionMode () const =0
virtual EOrientation	Private_GetOrientation () const =0
virtual bool	Private_IsPendingRefresh () const =0
virtual TArray< ItemType >	GetSelectedItems () const =0
virtual TSharedPtr< ITableRow >	WidgetFromItem (const ItemType &InItem) const =0
virtual ETableViewMode::Type	GetTableViewMode () const =0
virtual TSharedRef< SWidget >	AsWidget ()=0

Detailed Description

template<typename ItemType>
class ITypedTableView< ItemType >

Interface for container widgets to talk to the owner list, tree, or grid.

Member Function Documentation

AsWidget()

template<typename ItemType >

virtual TSharedRef< SWidget > ITypedTableView< ItemType >::AsWidget ( )

pure virtual

Returns

a shared reference to the widgets; required for forwarding focus.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

GetSelectedItems()

template<typename ItemType >

virtual TArray< ItemType > ITypedTableView< ItemType >::GetSelectedItems ( ) const

pure virtual

Returns

All currently selected items in the table view

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

GetTableViewMode()

template<typename ItemType >

virtual ETableViewMode::Type ITypedTableView< ItemType >::GetTableViewMode ( ) const

pure virtual

Returns

Is the tableview a tree or a list?

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_ClearHighlightedItems()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_ClearHighlightedItems ( )

pure virtual

Empty the set of highlighted items.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_ClearSelection()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_ClearSelection ( )

pure virtual

Empty the selection set.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_DoesItemHaveChildren()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_DoesItemHaveChildren ( int32  ItemIndexInList ) const

pure virtual

Parameters

ItemIndexInList

The index of the data item in the linearized array.

Returns

true if the item has children

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_GetNestingDepth()

template<typename ItemType >

virtual int32 ITypedTableView< ItemType >::Private_GetNestingDepth ( int32  ItemIndexInList ) const

pure virtual

Parameters

ItemIndexInList

The index of the data item in the linearized array.

Returns

Nesting level within the tree: 0 is root-level, 1 is children of root, etc.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_GetNumSelectedItems()

template<typename ItemType >

virtual int32 ITypedTableView< ItemType >::Private_GetNumSelectedItems ( ) const

pure virtual

Returns

the number of items that are selected

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_GetOrientation()

template<typename ItemType >

virtual EOrientation ITypedTableView< ItemType >::Private_GetOrientation ( ) const

pure virtual

Returns

the orientation of this TableView

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_GetSelectionMode()

template<typename ItemType >

virtual ESelectionMode::Type ITypedTableView< ItemType >::Private_GetSelectionMode ( ) const

pure virtual

Returns

the selection mode of this TableView

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_GetWiresNeededByDepth()

template<typename ItemType >

virtual const TBitArray & ITypedTableView< ItemType >::Private_GetWiresNeededByDepth ( int32  ItemIndexInList ) const

pure virtual

Returns

a TBitArray in which each true bit indicates that a vertical wire is needed at this depth of the tree view.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_HasSelectorFocus()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_HasSelectorFocus ( const ItemType &  TheItem ) const

pure virtual

Test if the item passed in has selector focus.

Parameters

InItem

The item to test.

Returns

true if the item has selector focus in this list; false otherwise.

Implemented in SListView< ItemType >.

Private_IsItemExpanded()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsItemExpanded ( const ItemType &  TheItem ) const

pure virtual

Parameters

InItem

The data item whose expansion state to query

Returns

true if the item is expanded; false otherwise.

Implemented in SListView< ItemType >.

Private_IsItemHighlighted()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsItemHighlighted ( const ItemType &  TheItem ) const

pure virtual

Test if the current item should be highlighted. This is separate from hover highlights.

Parameters

TheItem

The item to test.

Returns

true if the item is marked as highlighted in this list; false otherwise.

Implemented in SListView< ItemType >.

Private_IsItemSelectableOrNavigable()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsItemSelectableOrNavigable ( const ItemType &  TheItem ) const

pure virtual

Test if the current item can be selected or navigated to.

Parameters

InItem

The item to test.

Returns

true if the item is selectable or navigable; false otherwise.

Implemented in SListView< ItemType >.

Private_IsItemSelected()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsItemSelected ( const ItemType &  TheItem ) const

pure virtual

Test if the current item is selected.

Parameters

InItem

The item to test.

Returns

true if the item is selected in this list; false otherwise.

Implemented in SListView< ItemType >.

Private_IsLastChild()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsLastChild ( int32  ItemIndexInList ) const

pure virtual

Returns

true if this item is the last direct descendant of its parent.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_IsPendingRefresh()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_IsPendingRefresh ( ) const

pure virtual

Is the list pending a refresh?

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_ItemFromWidget()

template<typename ItemType >

virtual const TObjectPtrWrapTypeOf< ItemType > * ITypedTableView< ItemType >::Private_ItemFromWidget ( const ITableRow *  TheWidget ) const

pure virtual

Given a Widget, find the corresponding data item.

Parameters

TheWidget

A widget generated by the list view for some data item.

Returns

The data item from which TheWidget was generated

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

Private_OnExpanderArrowShiftClicked()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_OnExpanderArrowShiftClicked ( ItemType  TheItem, bool  bShouldBeExpanded  )

pure virtual

Called when the expander arrow for the given item is shift+clicked.

Parameters

InItem	The item whose expansion state to control
InExpandItem	If true the item should be expanded; otherwise collapsed

Implemented in SListView< ItemType >.

Private_OnItemClicked()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_OnItemClicked ( ItemType  TheItem )

pure virtual

Called when the item is clicked, and returns whether or not the event was handled

Implemented in SListView< ItemType >.

Private_OnItemDoubleClicked()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_OnItemDoubleClicked ( ItemType  TheItem )

pure virtual

Called when the item is double-clicked, and returns whether or not the event was handled

Implemented in SListView< ItemType >.

Private_OnItemRightClicked()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_OnItemRightClicked ( ItemType  TheItem, const FPointerEvent &  MouseEvent  )

pure virtual

Called when the item is right-clicked when not right mouse scrolling

Implemented in SListView< ItemType >.

Private_SelectRangeFromCurrentTo()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_SelectRangeFromCurrentTo ( ItemType  SelectorItem )

pure virtual

Select a range of items from the current RangeSelectionStart to the SelectorItem Does not cause an OnSelectionChanged()!

Parameters

SelectorItem

The endpoint item at which the selection should stop.

Implemented in SListView< ItemType >.

Private_SetItemExpansion()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_SetItemExpansion ( ItemType  TheItem, bool  bShouldBeExpanded  )

pure virtual

Set whether some data item is expanded or not.

Parameters

InItem	The item whose expansion state to control
InExpandItem	If true the item should be expanded; otherwise collapsed

Implemented in SListView< ItemType >.

Private_SetItemHighlighted()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_SetItemHighlighted ( ItemType  TheItem, bool  bShouldBeHighlighted  )

pure virtual

Enable a soft highlight on the element. This is useful for explaining parent/child relationships without actually modifying selection. Unrelated to any hover highlights.

Parameters

TheItem	The item whose highlighted state to change.
bShouldBeHighlighted	Enables a highlight on this item if true, otherwise disables the highlight.

Implemented in SListView< ItemType >.

Private_SetItemSelection()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_SetItemSelection ( ItemType  TheItem, bool  bShouldBeSelected, bool  bWasUserDirected = false  )

pure virtual

Set the selection state of an item. Does not cause an OnSelectionChanged()!

Parameters

InItem	The Item whose selection state to modify
bSelected	true to select the item; false to unselect
bWasUserDirected	true if the user specifically, directly selected this item; false otherwise

Implemented in SListView< ItemType >.

Private_SignalSelectionChanged()

template<typename ItemType >

virtual void ITypedTableView< ItemType >::Private_SignalSelectionChanged ( ESelectInfo::Type  SelectInfo )

pure virtual

Notify the ItemsWidget that we changed its selection. Triggers as OnSelectionChanged().

Parameters

SelectInfo

Provides context on how the selection changed

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, SListView< UObject * >, STreeView< ItemType >, STreeView< TSharedPtr< FTestData > >, STreeView< TSharedPtr< int32 > >, STreeView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and STreeView< UObject * >.

Private_UsesSelectorFocus()

template<typename ItemType >

virtual bool ITypedTableView< ItemType >::Private_UsesSelectorFocus ( ) const

pure virtual

Returns whether the table view uses selector focus.

Returns

true if the table view uses selector focus; false otherwise.

Implemented in SListView< ItemType >, SListView< OptionType >, SListView< TSharedPtr< FString > >, SListView< TSharedPtr< FTestData > >, SListView< TSharedPtr< int32 > >, SListView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and SListView< UObject * >.

WidgetFromItem()

template<typename ItemType >

virtual TSharedPtr< ITableRow > ITypedTableView< ItemType >::WidgetFromItem ( const ItemType &  InItem ) const

pure virtual

Find a widget for this item if it has already been constructed.

Parameters

InItem

The item for which to find the widget.

Returns

A pointer to the corresponding widget if it exists; otherwise nullptr.

Implemented in SListView< ItemType >.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Slate/Public/Framework/Views/ITypedTableView.h