1. Epic GamesDeveloper
  3. SListView

SListView

A ListView widget observes an array of data items and creates visual representations of these items.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Views

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Views/SListView.h
Include #include "Widgets/Views/SListView.h"

Syntax

template<typename ItemType>  
class SListView :  
    public STableViewBase ,  
    private TListTypeTraits< T, Enable >::SerializerType,  
    public ITypedTableView< ItemType >

Remarks

A ListView widget observes an array of data items and creates visual representations of these items. ListView relies on the property that holding a reference to a value ensures its existence. In other words, neither SListView nor SListView are valid, while SListView< TSharedPtr > and SListView< UObject* > are valid.

A trivial use case appear below:

Given: TArray< TSharedPtr > Items;

SNew( SListView< TSharedPtr > ) .ItemHeight(24) .ListItemsSource( &Items ) .OnGenerateRow(this, &MyClass::GenerateItemRow)

In the example we make all our widgets be 24 screen units tall. The ListView will create widgets based on data items in the Items TArray. When the ListView needs to generate an item, it will do so using the specified OnGenerateRow method.

A sample implementation of MyClass::GenerateItemRow has to return a STableRow with optional content:

TSharedRef MyClass::GenerateItemRow(TSharedPtr Item, const TSharedRef& OwnerTable) { return SNew(STableRow>, OwnerTable) [ SNew(STextBlock) .Text(*Item) ]; }

Constructors

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS  

Functions

  Type Name Description
Public function void

Construct ( const typename SListView< ItemType >::FArguments& InArgs
)

 Construct this widget
Protected function FReply

OnKeyDown_Internal ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function void

Private_OnEntryInitialized ( ItemType TheItem,
const TSharedRef< ITableRow >& TableRow
)

 A low-level interface for use various widgets generated by ItemsWidgets(Lists, Trees, etc). These handle selection, expansion, and other such properties common to ItemsWidgets.

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual FNavigationReply

OnNavigation ( const FGeometry& MyGeometry,
const FNavigationEvent& InNavigationEvent
)

 Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Overridden from ITypedTableView

  Type Name Description
Public function Virtual TSharedRef< SWidget >  
Public function Virtual Const ETableViewMode::Type  
Public function Virtual void Empty the set of highlighted items.
Public function Virtual void Empty the selection set.
Public function Virtual Const bool

Private_DoesItemHaveChildren ( int32 ItemIndexInList
)

  
Public function Virtual Const int32

Private_GetNestingDepth ( int32 ItemIndexInList
)

  
Public function Virtual Const int32  
Public function Virtual Const EOrientation  
Public function Virtual Const ESelectionMode::Type  
Public function Virtual Const const TBitArray &

Private_GetWiresNeededByDepth ( int32 ItemIndexInList
)

  
Public function Virtual Const bool

Private_HasSelectorFocus ( const ItemType& TheItem
)

 Test if the item passed in has selector focus.
Public function Virtual Const bool

Private_IsItemExpanded ( const ItemType& TheItem
)

  
Public function Virtual Const bool

Private_IsItemHighlighted ( const ItemType& TheItem
)

 Test if the current item should be highlighted. This is separate from hover highlights.
Public function Virtual Const bool

Private_IsItemSelectableOrNavigable ( const ItemType& TheItem
)

 Test if the current item can be selected or navigated to.
Public function Virtual Const bool

Private_IsItemSelected ( const ItemType& TheItem
)

 Test if the current item is selected.
Public function Virtual Const bool

Private_IsLastChild ( int32 ItemIndexInList
)

  
Public function Virtual Const bool Is the list pending a refresh?
Public function Virtual Const const TObjectPtrWrapTypeOf< ItemType > *

Private_ItemFromWidget ( const ITableRow* TheWidget
)

 Given a Widget, find the corresponding data item.
Public function Virtual void

Private_OnExpanderArrowShiftClicked ( ItemType TheItem,
bool bShouldBeExpanded
)

 Called when the expander arrow for the given item is shift+clicked.
Public function Virtual bool

Private_OnItemClicked ( ItemType TheItem
)

 Called when the item is clicked, and returns whether or not the event was handled
Public function Virtual bool

Private_OnItemDoubleClicked ( ItemType TheItem
)

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

Private_OnItemRightClicked ( ItemType TheItem,
const FPointerEvent& MouseEvent
)

 Called when the item is right-clicked when not right mouse scrolling
Public function Virtual void

Private_SelectRangeFromCurrentTo ( ItemType SelectorItem
)

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

Private_SetItemExpansion ( ItemType TheItem,
bool bShouldBeExpanded
)

 Set whether some data item is expanded or not.
Public function Virtual void

Private_SetItemHighlighted ( ItemType TheItem,
bool bShouldBeHighlighted
)

 Enable a soft highlight on the element.
Public function Virtual void

Private_SetItemSelection ( ItemType TheItem,
bool bShouldBeSelected,
bool bWasUserDirected
)

 Set the selection state of an item.
Public function Virtual void Notify the ItemsWidget that we changed its selection.
Public function Virtual Const bool Returns whether the table view uses selector focus.

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
FIsSelectableOrNavigable  
FOnEntryInitialized  
FOnGenerateRow  
FOnItemScrolledIntoView  
FOnItemToString_Debug  
FOnMouseButtonClick  
FOnMouseButtonDoubleClick  
FOnSelectionChanged  
FOnWidgetToBeRemoved  
MapKeyFuncs  
MapKeyFuncsSparse  
NullableItemType  
TItemSet  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page