#include <SListView.h>

Inheritance diagram for SListView< ItemType >:

Public Types
using	NullableItemType = typename TListTypeTraits< ItemType >::NullableType

using	MapKeyFuncs = typename TListTypeTraits< ItemType >::MapKeyFuncs

using	MapKeyFuncsSparse = typename TListTypeTraits< ItemType >::MapKeyFuncsSparse

using	TItemSet = TSet< TObjectPtrWrapTypeOf< ItemType >, typename TListTypeTraits< TObjectPtrWrapTypeOf< ItemType > >::SetKeyFuncs >

using	FOnGenerateRow = typename TSlateDelegates< ItemType >::FOnGenerateRow

using	FOnRefreshRow = typename TSlateDelegates< ItemType >::FOnRefreshRow

using	FOnItemScrolledIntoView = typename TSlateDelegates< ItemType >::FOnItemScrolledIntoView

using	FOnSelectionChanged = typename TSlateDelegates< NullableItemType >::FOnSelectionChanged

using	FIsSelectableOrNavigable = typename TSlateDelegates< ItemType >::FIsSelectableOrNavigable

using	FOnMouseButtonClick = typename TSlateDelegates< ItemType >::FOnMouseButtonClick

using	FOnMouseButtonDoubleClick = typename TSlateDelegates< ItemType >::FOnMouseButtonDoubleClick

typedef TSlateDelegates< ItemType >::FOnItemToString_Debug	FOnItemToString_Debug

Public Member Functions
	DECLARE_DELEGATE_OneParam (FOnWidgetToBeRemoved, const TSharedRef< ITableRow > &)

	DECLARE_DELEGATE_TwoParams (FOnEntryInitialized, ItemType, const TSharedRef< ITableRow > &)

	SLATE_BEGIN_ARGS (SListView< ItemType >)

	SLATE_ARGUMENT (EAllowOverscroll, AllowOverscroll)

	SLATE_STYLE_ARGUMENT (FScrollBarStyle, ScrollBarStyle)

	SLATE_ARGUMENT (bool, PreventThrottling)

	SLATE_ARGUMENT (EConsumeMouseWheel, ConsumeMouseWheel)

	SLATE_ARGUMENT (float, WheelScrollMultiplier)

	SLATE_ARGUMENT (float, NavigationScrollOffset)

	SLATE_ARGUMENT (FMargin, ScrollBarPadding)

	SLATE_ARGUMENT (bool, HandleGamepadEvents)

	SLATE_ARGUMENT (bool, HandleDirectionalNavigation)

	SLATE_ARGUMENT (bool, HandleSpacebarSelection)

	SLATE_EVENT (FOnTableViewBadState, OnEnteredBadState)

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

PRAGMA_DISABLE_DEPRECATION_WARNINGS	SListView (ETableViewMode::Type InListMode=ETableViewMode::List)

virtual bool	SupportsKeyboardFocus () const override

virtual FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override

virtual FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent) override

virtual FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

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

virtual void	Private_SetItemSelection (ItemType TheItem, bool bShouldBeSelected, bool bWasUserDirected=false) override

virtual void	Private_ClearSelection () override

virtual void	Private_SelectRangeFromCurrentTo (ItemType InRangeSelectionEnd) override

virtual void	Private_SignalSelectionChanged (ESelectInfo::Type SelectInfo) override

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

virtual bool	Private_UsesSelectorFocus () const override

virtual bool	Private_HasSelectorFocus (const ItemType &TheItem) const override

virtual bool	Private_IsItemSelected (const ItemType &TheItem) const override

virtual bool	Private_IsItemHighlighted (const ItemType &TheItem) const override

virtual bool	Private_IsItemExpanded (const ItemType &TheItem) const override

virtual bool	Private_IsItemSelectableOrNavigable (const ItemType &TheItem) const override

virtual void	Private_SetItemExpansion (ItemType TheItem, bool bShouldBeExpanded) override

virtual void	Private_OnExpanderArrowShiftClicked (ItemType TheItem, bool bShouldBeExpanded) override

virtual bool	Private_DoesItemHaveChildren (int32 ItemIndexInList) const override

virtual int32	Private_GetNumSelectedItems () const override

virtual void	Private_SetItemHighlighted (ItemType TheItem, bool bShouldBeHighlighted) override

virtual void	Private_ClearHighlightedItems () override

virtual int32	Private_GetNestingDepth (int32 ItemIndexInList) const override

virtual const TBitArray &	Private_GetWiresNeededByDepth (int32 ItemIndexInList) const override

virtual bool	Private_IsLastChild (int32 ItemIndexInList) const override

virtual ESelectionMode::Type	Private_GetSelectionMode () const override

virtual EOrientation	Private_GetOrientation () const override

virtual bool	Private_IsPendingRefresh () const override

virtual void	Private_OnItemRightClicked (ItemType TheItem, const FPointerEvent &MouseEvent) override

virtual bool	Private_OnItemClicked (ItemType TheItem) override

virtual bool	Private_OnItemDoubleClicked (ItemType TheItem) override

virtual ETableViewMode::Type	GetTableViewMode () const override

virtual TSharedRef< SWidget >	AsWidget () override

void	SetStyle (const FTableViewStyle *InStyle)

void	SetShadowBoxStyle (const FScrollBoxStyle *InScrollBoxStyle)

void	SetOnEntryInitialized (const FOnEntryInitialized &Delegate)

virtual void	UpdateSelectionSet () override

virtual FReGenerateResults	ReGenerateItems (const FGeometry &MyGeometry) override

float	GenerateWidgetForItem (const ItemType &CurItem, int32 ItemIndex, int32 StartIndex, float LayoutScaleMultiplier)

void	ReGeneratePinnedItems (const TArray< ItemType > &InItems, const FGeometry &MyGeometry, int32 MaxPinnedItemsOverride=-1)

void	GeneratePinnedWidgetForItem (const ItemType &CurItem, int32 ItemIndex, int32 NumPinnedItems, float LayoutScaleMultiplier)

virtual int32	GetNumItemsBeingObserved () const override

virtual TSharedRef< ITableRow >	GenerateNewPinnedWidget (ItemType InItem, const int32 ItemIndex, const int32 NumPinnedItems)

virtual TSharedRef< ITableRow >	GenerateNewWidget (ItemType InItem)

void	SetItemsSource (const TArray< ItemType > *InListItemsSource)

void	SetItemsSource (TSharedRef<::UE::Slate::Containers::TObservableArray< ItemType > > InListItemsSource)

void	SetItemsSource (TUniquePtr< UE::Slate::ItemsSource::IItemsSource< ItemType > > Provider)

void	ClearItemsSource ()

void	BindToRefreshRow (const FOnRefreshRow &Binding)

void	SetListItemsSource (const TArray< ItemType > &InListItemsSource)

bool	HasValidItemsSource () const

TArrayView< const ItemType >	GetItems () const

const TObjectPtrWrapTypeOf< ItemType > *	ItemFromWidget (const ITableRow *WidgetToFind) const

bool	IsItemSelected (const ItemType &InItem) const

void	SetItemSelection (const ItemType &InItem, bool bSelected, ESelectInfo::Type SelectInfo=ESelectInfo::Direct)

void	SetItemSelection (TConstArrayView< ItemType > InItems, bool bSelected, ESelectInfo::Type SelectInfo=ESelectInfo::Direct)

void	ClearSelection ()

void	SetItemHighlighted (const ItemType &TheItem, bool bHighlighted)

void	ClearHighlightedItems ()

int32	GetNumItemsSelected () const

virtual void	RebuildList () override

virtual TArray< ItemType >	GetSelectedItems () const override

int32	GetSelectedItems (TArray< ItemType > &SelectedItemArray) const

bool	IsItemVisible (ItemType Item) const

void	RequestScrollIntoView (ItemType ItemToView, const uint32 UserIndex=0)

void	RequestScrollIntoView (ItemType ItemToView, const uint32 UserIndex, const bool NavigateOnScrollIntoView)

void	RequestNavigateToItem (ItemType Item, const uint32 UserIndex=0)

void	CancelScrollIntoView ()

void	SetSelection (ItemType SoleSelectedItem, ESelectInfo::Type SelectInfo=ESelectInfo::Direct)

void	SetSelectionMode (const TAttribute< ESelectionMode::Type > &NewSelectionMode)

void	SetScrollIntoViewAlignment (EScrollIntoViewAlignment NewScrollIntoViewAlignment)

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

virtual void	AddReferencedObjects (FReferenceCollector &Collector)

virtual FString	GetReferencerName () const

FVector2D	GetMaxRowSizeForColumn (const FName &ColumnId, EOrientation ColumnOrientation)

Public Member Functions inherited from STableViewBase
SLATE_API void	ConstructChildren (const TAttribute< float > &InItemWidth, const TAttribute< float > &InItemHeight, const TAttribute< EListItemAlignment > &InItemAlignment, const TSharedPtr< SHeaderRow > &InHeaderRow, const TSharedPtr< SScrollBar > &InScrollBar, EOrientation InScrollOrientation, const FOnTableViewScrolled &InOnTableViewScrolled, const FScrollBarStyle *InScrollBarStyle=nullptr, const bool bInPreventThrottling=false)

SLATE_API void	SetItemHeight (TAttribute< float > Height)

SLATE_API void	SetItemWidth (TAttribute< float > Width)

SLATE_API void	ScrollBar_OnUserScrolled (float InScrollOffsetFraction)

SLATE_API int32	GetNumGeneratedChildren () const

SLATE_API TSharedPtr< SWidget >	GetGeneratedChildAt (int32 Index) const

SLATE_API TSharedPtr< SHeaderRow >	GetHeaderRow () const

SLATE_API bool	IsRightClickScrolling () const

SLATE_API bool	IsUserScrolling () const

virtual SLATE_API void	RequestListRefresh ()

SLATE_API bool	IsPendingRefresh () const

SLATE_API void	ScrollToTop ()

SLATE_API void	ScrollToBottom ()

SLATE_API bool	IsScrolling () const

SLATE_API float	GetScrollOffset () const

SLATE_API void	SetScrollOffset (const float InScrollOffset)

SLATE_API void	EndInertialScrolling (const bool bInShouldStopScrollNow=false)

SLATE_API void	AddScrollOffset (const float InScrollOffsetDelta, bool RefreshList=false)

SLATE_API EVisibility	GetScrollbarVisibility () const

SLATE_API void	SetScrollbarVisibility (const EVisibility InVisibility)

SLATE_API void	SetScrollbarPadding (const FMargin &InScrollbarPadding)

SLATE_API bool	IsScrollbarNeeded () const

SLATE_API void	SetFixedLineScrollOffset (TOptional< double > InFixedLineScrollOffset)

SLATE_API void	SetIsScrollAnimationEnabled (bool bInEnableScrollAnimation)

SLATE_API void	SetScrollingAnimationInterpolationSpeed (float InScrollingAnimationInterpolationSpeed)

SLATE_API void	SetEnableTouchAnimatedScrolling (bool bInEnableTouchAnimatedScrolling)

SLATE_API void	SetAllowOverscroll (EAllowOverscroll InAllowOverscroll)

SLATE_API void	SetIsRightClickScrollingEnabled (const bool bInEnableRightClickScrolling)

SLATE_API void	SetIsTouchScrollingEnabled (const bool bInEnableTouchScrolling)

SLATE_API void	SetSelectItemOnNavigation (const bool bInSelectItemOnNavigation)

SLATE_API void	SetWheelScrollMultiplier (float NewWheelScrollMultiplier)

SLATE_API void	SetIsPointerScrollingEnabled (bool bInIsPointerScrollingEnabled)

SLATE_API void	SetIsGamepadScrollingEnabled (bool bInIsGamepadScrollingEnabled)

SLATE_API void	SetBackgroundBrush (const TAttribute< const FSlateBrush * > &InBackgroundBrush)

virtual SLATE_API void	OnFocusLost (const FFocusEvent &InFocusEvent) override

virtual SLATE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

virtual SLATE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override

virtual SLATE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent) override

virtual SLATE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API void	OnMouseLeave (const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override

virtual SLATE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const override

virtual SLATE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual SLATE_API bool	ComputeVolatility () const override

virtual SLATE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override

virtual SLATE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override

virtual SLATE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent) override

virtual SLATE_API FVector2D	GetScrollDistance () override

virtual SLATE_API FVector2D	GetScrollDistanceRemaining () override

virtual SLATE_API TSharedRef< class SWidget >	GetScrollWidget () override

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Member Functions inherited from IScrollableWidget
virtual	~IScrollableWidget ()

Protected Member Functions
FReply	OnKeyDown_Internal (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual EScrollIntoViewResult	ScrollIntoView (const FGeometry &ListViewGeometry) override

virtual void	NotifyItemScrolledIntoView () override

virtual void	NotifyFinishedScrolling () override

virtual float	ScrollBy (const FGeometry &MyGeometry, float ScrollByAmountInSlateUnits, EAllowOverscroll InAllowOverscroll) override

TOptional< ItemType >	Private_FindNextSelectableOrNavigableWithIndexAndDirection (const ItemType &InItemToSelect, int32 SelectionIdx, bool bSelectForward)

TOptional< ItemType >	Private_FindNextSelectableOrNavigable (const ItemType &InItemToSelect)

virtual void	NavigationSelect (const ItemType &InItemToSelect, const FInputEvent &InInputEvent)

virtual void	NavigationSelect (const ItemType &InItemToSelect, const FNavigationEvent &InNavigationEvent)

Protected Member Functions inherited from STableViewBase
SLATE_API	STableViewBase (ETableViewMode::Type InTableViewMode)

virtual SLATE_API	~STableViewBase ()

SLATE_API double	GetTargetScrollOffset () const

virtual SLATE_API float	ScrollTo (float InScrollOffset)

SLATE_API void	InsertWidget (const TSharedRef< ITableRow > &WidgetToInset)

SLATE_API void	AppendWidget (const TSharedRef< ITableRow > &WidgetToAppend)

SLATE_API const FChildren *	GetConstructedTableItems () const

SLATE_API void	ClearWidgets ()

SLATE_API void	InsertPinnedWidget (const TSharedRef< SWidget > &WidgetToInset)

SLATE_API void	AppendPinnedWidget (const TSharedRef< SWidget > &WidgetToAppend)

SLATE_API void	ClearPinnedWidgets ()

SLATE_API float	GetItemWidth () const

SLATE_API float	GetItemHeight () const

SLATE_API UE::Slate::FDeprecateVector2DResult	GetItemSize () const

virtual SLATE_API float	GetNumLiveWidgets () const

virtual SLATE_API int32	GetNumItemsPerLine () const

virtual SLATE_API float	GetFirstLineScrollOffset () const

virtual void	OnRightMouseButtonDown (const FPointerEvent &MouseEvent)

virtual SLATE_API void	OnRightMouseButtonUp (const FPointerEvent &MouseEvent)

SLATE_API float	GetScrollRateInItems () const

SLATE_API void	RequestLayoutRefresh ()

SLATE_API int32	GetNumPinnedItems () const

SLATE_API EVisibility	GetPinnedItemsVisiblity () const

SLATE_API void	NavigateToWidget (const uint32 UserIndex, const TSharedPtr< SWidget > &NavigationDestination, ENavigationSource NavigationSource=ENavigationSource::FocusedWidget, EUINavigation NavigationType=EUINavigation::Invalid) const

SLATE_API int32	FindChildUnderPosition (FArrangedChildren &ArrangedChildren, const FVector2D &ArrangedSpacePosition) const

float	GetScrollComponentFromVector (FVector2f Vector) const

virtual SLATE_API void	OnClippingChanged () override

FSlateColor	GetStartShadowOpacity () const

FSlateColor	GetEndShadowOpacity () const

SLATE_API bool	CanUseInertialScroll (float ScrollAmount) const

SLATE_API EActiveTimerReturnType	UpdateInertialScroll (double InCurrentTime, float InDeltaTime)

SLATE_API EActiveTimerReturnType	EnsureTickToRefresh (double InCurrentTime, float InDeltaTime)

float	GetSmoothDeltaTime (float InDeltaTime)

void	UpdateSmoothDeltaTime (float InDeltaTime)

Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions
static FOnItemToString_Debug	GetDefaultDebugDelegate ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Protected Attributes
FWidgetGenerator	WidgetGenerator

FWidgetGenerator	PinnedWidgetGenerator

FOnEntryInitialized	OnEntryInitialized

FOnGenerateRow	OnGenerateRow

FOnGenerateRow	OnGeneratePinnedRow

FOnRefreshRow	OnRefreshRow

FOnItemToString_Debug	OnItemToString_Debug

FOnTableViewBadState	OnEnteredBadState

FOnWidgetToBeRemoved	OnRowReleased

FOnItemScrolledIntoView	OnItemScrolledIntoView

FOnFinishedScrolling	OnFinishedScrolling

TItemSet	SelectedItems

NullableItemType	SelectorItem

NullableItemType	RangeSelectionStart

TItemSet	HighlightedItems

const TArray< ItemType > *	ItemsSource

NullableItemType	ItemToScrollIntoView

uint32	UserRequestingScrollIntoView

NullableItemType	ItemToNotifyWhenInView

EScrollIntoViewAlignment	ScrollIntoViewAlignment

FOnSelectionChanged	OnSelectionChanged

FIsSelectableOrNavigable	OnIsSelectableOrNavigable

FOnMouseButtonClick	OnClick

FOnMouseButtonDoubleClick	OnDoubleClick

FOnKeyDown	OnKeyDownHandler

TAttribute< bool >	IsFocusable

float	NavigationScrollOffset = 0.5f

bool	bClearSelectionOnClick

bool	bHandleGamepadEvents

bool	bHandleDirectionalNavigation

bool	bHandleSpacebarSelection = false

bool	bReturnFocusToSelection

bool	bClearScrollVelocityOnSelection = true

bool	bNavigateOnScrollIntoView = false

EUINavigation	NavigationTypeOnScrollIntoView = EUINavigation::Invalid

const FTableViewStyle *	Style

TAttribute< int32 >	MaxPinnedItems

TAttribute< int32 >	DefaultMaxPinnedItems

bool	bIsHierarchyCollapsed = false

Protected Attributes inherited from STableViewBase
TSharedPtr< SListPanel >	ItemsPanel

TSharedPtr< SListPanel >	PinnedItemsPanel

TSharedPtr< SScrollBar >	ScrollBar

FMargin	ScrollBarSlotPadding

FOnTableViewScrolled	OnTableViewScrolled

TOptional< double >	FixedLineScrollOffset

bool	bEnableAnimatedScrolling = false

float	ScrollingAnimationInterpolationSpeed = 12.f

bool	bEnableTouchAnimatedScrolling = false

bool	bEnableRightClickScrolling = true

bool	bEnableTouchScrolling = true

bool	bSelectItemOnNavigation = true

double	CurrentScrollOffset = 0.

double	DesiredScrollOffset = 0.

bool	bStartedTouchInteraction

float	AmountScrolledWhileRightMouseDown

FVector2f	PressedScreenSpacePosition

float	TickScrollDelta

FReGenerateResults	LastGenerateResults

bool	bWasAtEndOfList

FGeometry	PanelGeometryLastTick

FOnContextMenuOpening	OnContextMenuOpening

FSimpleDelegate	OnItemsRebuilt

TAttribute< ESelectionMode::Type >	SelectionMode

TSharedPtr< SHeaderRow >	HeaderRow

FInertialScrollManager	InertialScrollManager

FVector2f	SoftwareCursorPosition

bool	bShowSoftwareCursor

float	WheelScrollMultiplier

bool	bIsPointerScrollingEnabled = true

bool	bIsGamepadScrollingEnabled = true

EOrientation	Orientation = Orient_Vertical

bool	bShouldUseShadowBoxStyle = false

const FScrollBoxStyle *	ShadowBoxStyle

FInvalidatableBrushAttribute	BackgroundBrush

bool	bIsScrollingActiveTimerRegistered

FOverscroll	Overscroll

EAllowOverscroll	AllowOverscroll

EConsumeMouseWheel	ConsumeMouseWheel

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Friends
class	FWidgetGenerator

class	SListViewPinnedRowWidget

Additional Inherited Members
Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Public Attributes inherited from STableViewBase
const ETableViewMode::Type	TableViewMode

Protected Types inherited from STableViewBase
enum class	EScrollIntoViewResult { Success , Deferred , Failure }

Detailed Description

template<typename ItemType>
class SListView< ItemType >

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<FText> nor SListView<FText*> are valid, while SListView< TSharedPtr<FText> > and SListView< UObject* > are valid.

A trivial use case appear below:

Given: TArray< TSharedPtr<FText> > Items;

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

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<ITableRow> MyClass::GenerateItemRow(TSharedPtr<FText> Item, const TSharedRef<STableViewBase>& OwnerTable) { return SNew(STableRow<TSharedPtr<FText>>, OwnerTable) [ SNew(STextBlock) .Text(*Item) ]; }

Member Typedef Documentation

◆ FIsSelectableOrNavigable

template<typename ItemType >

using SListView< ItemType >::FIsSelectableOrNavigable = typename TSlateDelegates< ItemType >::FIsSelectableOrNavigable

◆ FOnGenerateRow

template<typename ItemType >

using SListView< ItemType >::FOnGenerateRow = typename TSlateDelegates< ItemType >::FOnGenerateRow

◆ FOnItemScrolledIntoView

template<typename ItemType >

using SListView< ItemType >::FOnItemScrolledIntoView = typename TSlateDelegates< ItemType >::FOnItemScrolledIntoView

◆ FOnItemToString_Debug

template<typename ItemType >

typedef TSlateDelegates<ItemType>::FOnItemToString_Debug SListView< ItemType >::FOnItemToString_Debug

◆ FOnMouseButtonClick

template<typename ItemType >

using SListView< ItemType >::FOnMouseButtonClick = typename TSlateDelegates< ItemType >::FOnMouseButtonClick

◆ FOnMouseButtonDoubleClick

template<typename ItemType >

using SListView< ItemType >::FOnMouseButtonDoubleClick = typename TSlateDelegates< ItemType >::FOnMouseButtonDoubleClick

◆ FOnRefreshRow

template<typename ItemType >

using SListView< ItemType >::FOnRefreshRow = typename TSlateDelegates< ItemType >::FOnRefreshRow

◆ FOnSelectionChanged

template<typename ItemType >

using SListView< ItemType >::FOnSelectionChanged = typename TSlateDelegates< NullableItemType >::FOnSelectionChanged

◆ MapKeyFuncs

template<typename ItemType >

using SListView< ItemType >::MapKeyFuncs = typename TListTypeTraits<ItemType>::MapKeyFuncs

◆ MapKeyFuncsSparse

template<typename ItemType >

using SListView< ItemType >::MapKeyFuncsSparse = typename TListTypeTraits<ItemType>::MapKeyFuncsSparse

◆ NullableItemType

template<typename ItemType >

using SListView< ItemType >::NullableItemType = typename TListTypeTraits< ItemType >::NullableType

◆ TItemSet

template<typename ItemType >

using SListView< ItemType >::TItemSet = TSet< TObjectPtrWrapTypeOf<ItemType>, typename TListTypeTraits< TObjectPtrWrapTypeOf<ItemType> >::SetKeyFuncs >

Constructor & Destructor Documentation

◆ SListView()

template<typename ItemType >

PRAGMA_DISABLE_DEPRECATION_WARNINGS SListView< ItemType >::SListView ( ETableViewMode::Type InListMode = ETableViewMode::List )

inline

Member Function Documentation

◆ AddReferencedObjects()

template<typename ItemType >

virtual void SListView< ItemType >::AddReferencedObjects ( FReferenceCollector & Collector )

inlinevirtual

Lists and Trees serialize items that they observe because they rely on the property that holding a reference means it will not be garbage collected.

Parameters

Ar	The archive to serialize with

◆ AsWidget()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ BindToRefreshRow()

template<typename ItemType >

void SListView< ItemType >::BindToRefreshRow ( const FOnRefreshRow & Binding )

inline

◆ CancelScrollIntoView()

template<typename ItemType >

void SListView< ItemType >::CancelScrollIntoView ( )

inline

Cancels a previous request to scroll an item into view (cancels navigation requests as well).

◆ ClearHighlightedItems()

template<typename ItemType >

void SListView< ItemType >::ClearHighlightedItems ( )

inline

Empty the highlighted item set.

◆ ClearItemsSource()

template<typename ItemType >

void SListView< ItemType >::ClearItemsSource ( )

inline

◆ ClearSelection()

template<typename ItemType >

void SListView< ItemType >::ClearSelection ( )

inline

Empty the selection set.

◆ Construct()

template<typename ItemType >

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

inline

Callback delegate to have first chance handling of the OnKeyDown event Construct this widget

Parameters

InArgs The declaration data for this widget

◆ DECLARE_DELEGATE_OneParam()

template<typename ItemType >

SListView< ItemType >::DECLARE_DELEGATE_OneParam	(	FOnWidgetToBeRemoved	,
		const TSharedRef< ITableRow > &
	)

◆ DECLARE_DELEGATE_TwoParams()

template<typename ItemType >

SListView< ItemType >::DECLARE_DELEGATE_TwoParams	(	FOnEntryInitialized	,
		ItemType	,
		const TSharedRef< ITableRow > &
	)

◆ GenerateNewPinnedWidget()

template<typename ItemType >

virtual TSharedRef< ITableRow > SListView< ItemType >::GenerateNewPinnedWidget	(	ItemType	InItem,
		const int32	ItemIndex,
		const int32	NumPinnedItems
	)

inlinevirtual

◆ GenerateNewWidget()

template<typename ItemType >

virtual TSharedRef< ITableRow > SListView< ItemType >::GenerateNewWidget ( ItemType InItem )

inlinevirtual

Given an data item, generate a widget corresponding to it.

Parameters

InItem The data item which to visualize.

Returns: A new Widget that represents the data item.

Reimplemented in STreeView< ItemType >.

◆ GeneratePinnedWidgetForItem()

template<typename ItemType >

void SListView< ItemType >::GeneratePinnedWidgetForItem	(	const ItemType &	CurItem,
		int32	ItemIndex,
		int32	NumPinnedItems,
		float	LayoutScaleMultiplier
	)

inline

◆ GenerateWidgetForItem()

template<typename ItemType >

float SListView< ItemType >::GenerateWidgetForItem	(	const ItemType &	CurItem,
		int32	ItemIndex,
		int32	StartIndex,
		float	LayoutScaleMultiplier
	)

inline

◆ GetDefaultDebugDelegate()

template<typename ItemType >

static FOnItemToString_Debug SListView< ItemType >::GetDefaultDebugDelegate ( )

inlinestaticprotected

◆ GetItems()

template<typename ItemType >

TArrayView< const ItemType > SListView< ItemType >::GetItems ( ) const

inline

◆ GetMaxRowSizeForColumn()

template<typename ItemType >

FVector2D SListView< ItemType >::GetMaxRowSizeForColumn	(	const FName &	ColumnId,
		EOrientation	ColumnOrientation
	)

inline

Will determine the max row size for the specified column id

Parameters

ColumnId	Column Id
ColumnOrientation	Orientation that is main axis you want to query

Returns: The max size for a column Id.

◆ GetNumItemsBeingObserved()

template<typename ItemType >

virtual int32 SListView< ItemType >::GetNumItemsBeingObserved ( ) const

inlineoverridevirtual

Returns: how many items there are in the TArray being observed

Implements STableViewBase.

Reimplemented in STileView< ItemType >, STileView< TSharedPtr< FTestData > >, STileView< TSharedPtr< int32 > >, and STileView< UObject * >.

◆ GetNumItemsSelected()

template<typename ItemType >

int32 SListView< ItemType >::GetNumItemsSelected ( ) const

inline

Gets the number of selected items.

Returns: Number of selected items.

◆ GetReferencerName()

template<typename ItemType >

virtual FString SListView< ItemType >::GetReferencerName ( ) const

inlinevirtual

◆ GetSelectedItems() [1/2]

template<typename ItemType >

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

inlineoverridevirtual

Returns a list of selected item indices, or an empty array if nothing is selected

Returns: List of selected item indices (in no particular order)

Implements ITypedTableView< ItemType >.

◆ GetSelectedItems() [2/2]

template<typename ItemType >

int32 SListView< ItemType >::GetSelectedItems ( TArray< ItemType > & SelectedItemArray ) const

inline

◆ GetTableViewMode()

template<typename ItemType >

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

inlineoverridevirtual

Returns: Is the tableview a tree or a list?

Implements ITypedTableView< ItemType >.

◆ HasValidItemsSource()

template<typename ItemType >

bool SListView< ItemType >::HasValidItemsSource ( ) const

inline

◆ IsItemSelected()

template<typename ItemType >

bool SListView< ItemType >::IsItemSelected ( const ItemType & InItem ) const

inline

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.

◆ IsItemVisible()

template<typename ItemType >

bool SListView< ItemType >::IsItemVisible ( ItemType Item ) const

inline

Checks whether the specified item is currently visible in the list view.

Parameters

Item	- The item to check.

Returns: true if the item is visible, false otherwise.

◆ ItemFromWidget()

template<typename ItemType >

const TObjectPtrWrapTypeOf< ItemType > * SListView< ItemType >::ItemFromWidget ( const ITableRow * WidgetToFind ) const

inline

Given a Widget, find the corresponding data item.

Parameters

WidgetToFind An widget generated by the list view for some data item.

Returns: the data item from which the WidgetToFind was generated

◆ NavigationSelect() [1/2]

template<typename ItemType >

virtual void SListView< ItemType >::NavigationSelect	(	const ItemType &	InItemToSelect,
		const FInputEvent &	InInputEvent
	)

inlineprotectedvirtual

Selects the specified item and scrolls it into view. If shift is held, it will be a range select. If ctrl is held and multi selection is allowed, the item will be added to the list of currently selected items

Parameters

ItemToSelect	The item that was selected by a keystroke
InInputEvent	The key event that caused this selection

◆ NavigationSelect() [2/2]

template<typename ItemType >

virtual void SListView< ItemType >::NavigationSelect	(	const ItemType &	InItemToSelect,
		const FNavigationEvent &	InNavigationEvent
	)

inlineprotectedvirtual

Special handling for navigation events

◆ NotifyFinishedScrolling()

template<typename ItemType >

virtual void SListView< ItemType >::NotifyFinishedScrolling ( )

inlineoverrideprotectedvirtual

Called at the end of a Tick when

CurrentScrollOffset == TargetScrollOffset
the user is not scrolling
the table view is not scrolling from an overscroll position

Implements STableViewBase.

◆ NotifyItemScrolledIntoView()

template<typename ItemType >

virtual void SListView< ItemType >::NotifyItemScrolledIntoView ( )

inlineoverrideprotectedvirtual

Called when an item has entered the visible geometry to check to see if the ItemScrolledIntoView delegate should be fired.

Implements STableViewBase.

◆ OnKeyDown()

template<typename ItemType >

virtual FReply SListView< ItemType >::OnKeyDown	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

inlineoverridevirtual

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

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from STableViewBase.

Reimplemented in STreeView< ItemType >, STreeView< TSharedPtr< FTestData > >, STreeView< TSharedPtr< int32 > >, STreeView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and STreeView< UObject * >.

◆ OnKeyDown_Internal()

template<typename ItemType >

FReply SListView< ItemType >::OnKeyDown_Internal	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

inlineprotected

◆ OnMouseButtonDown()

template<typename ItemType >

virtual FReply SListView< ItemType >::OnMouseButtonDown	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

inlineoverridevirtual

The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from STableViewBase.

◆ OnMouseButtonUp()

template<typename ItemType >

virtual FReply SListView< ItemType >::OnMouseButtonUp	(	const FGeometry &	MyGeometry,
		const FPointerEvent &	MouseEvent
	)

inlineoverridevirtual

The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.

Parameters

MyGeometry	The Geometry of the widget receiving the event
MouseEvent	Information about the input event

Returns: Whether the event was handled along with possible requests for the system to take action.

Reimplemented from STableViewBase.

◆ OnNavigation()

template<typename ItemType >

virtual FNavigationReply SListView< ItemType >::OnNavigation	(	const FGeometry &	MyGeometry,
		const FNavigationEvent &	InNavigationEvent
	)

inlineoverridevirtual

Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events.

Parameters

InNavigationEvent The navigation event generated

Reimplemented from SWidget.

Reimplemented in STileView< ItemType >, STileView< TSharedPtr< FTestData > >, STileView< TSharedPtr< int32 > >, and STileView< UObject * >.

◆ Private_ClearHighlightedItems()

template<typename ItemType >

virtual void SListView< ItemType >::Private_ClearHighlightedItems ( )

inlineoverridevirtual

Empty the set of highlighted items.

Implements ITypedTableView< ItemType >.

◆ Private_ClearSelection()

template<typename ItemType >

virtual void SListView< ItemType >::Private_ClearSelection ( )

inlineoverridevirtual

Empty the selection set.

Implements ITypedTableView< ItemType >.

◆ Private_DoesItemHaveChildren()

template<typename ItemType >

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

inlineoverridevirtual

Parameters

ItemIndexInList The index of the data item in the linearized array.

Returns: true if the item has children

Implements ITypedTableView< ItemType >.

◆ Private_FindNextSelectableOrNavigable()

template<typename ItemType >

TOptional< ItemType > SListView< ItemType >::Private_FindNextSelectableOrNavigable ( const ItemType & InItemToSelect )

inlineprotected

◆ Private_FindNextSelectableOrNavigableWithIndexAndDirection()

template<typename ItemType >

TOptional< ItemType > SListView< ItemType >::Private_FindNextSelectableOrNavigableWithIndexAndDirection	(	const ItemType &	InItemToSelect,
		int32	SelectionIdx,
		bool	bSelectForward
	)

inlineprotected

◆ Private_GetNestingDepth()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_GetNumSelectedItems()

template<typename ItemType >

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

inlineoverridevirtual

Returns: the number of items that are selected

Implements ITypedTableView< ItemType >.

◆ Private_GetOrientation()

template<typename ItemType >

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

inlineoverridevirtual

Returns: the orientation of this TableView

Implements ITypedTableView< ItemType >.

◆ Private_GetSelectionMode()

template<typename ItemType >

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

inlineoverridevirtual

Returns: the selection mode of this TableView

Implements ITypedTableView< ItemType >.

◆ Private_GetWiresNeededByDepth()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_HasSelectorFocus()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_IsItemExpanded()

template<typename ItemType >

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

inlineoverridevirtual

Parameters

InItem The data item whose expansion state to query

Returns: true if the item is expanded; false otherwise.

Implements ITypedTableView< ItemType >.

◆ Private_IsItemHighlighted()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_IsItemSelectableOrNavigable()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_IsItemSelected()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_IsLastChild()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_IsPendingRefresh()

template<typename ItemType >

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

inlineoverridevirtual

Is the list pending a refresh?

Implements ITypedTableView< ItemType >.

◆ Private_ItemFromWidget()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_OnEntryInitialized()

template<typename ItemType >

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

inline

◆ Private_OnExpanderArrowShiftClicked()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_OnItemClicked()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_OnItemDoubleClicked()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_OnItemRightClicked()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_SelectRangeFromCurrentTo()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_SetItemExpansion()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_SetItemHighlighted()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

◆ Private_SetItemSelection()

template<typename ItemType >

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

inlineoverridevirtual

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

Implements ITypedTableView< ItemType >.

◆ Private_SignalSelectionChanged()

template<typename ItemType >

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

inlineoverridevirtual

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

Parameters

SelectInfo Provides context on how the selection changed

Implements ITypedTableView< ItemType >.

Reimplemented in STreeView< ItemType >, STreeView< TSharedPtr< FTestData > >, STreeView< TSharedPtr< int32 > >, STreeView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and STreeView< UObject * >.

◆ Private_UsesSelectorFocus()

template<typename ItemType >

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

inlineoverridevirtual

Returns whether the table view uses selector focus.

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

Implements ITypedTableView< ItemType >.

◆ RebuildList()

template<typename ItemType >

virtual void SListView< ItemType >::RebuildList ( )

inlineoverridevirtual

Completely wipe existing widgets and fully regenerate them on next tick.

Implements STableViewBase.

Reimplemented in STreeView< ItemType >, STreeView< TSharedPtr< FTestData > >, STreeView< TSharedPtr< int32 > >, STreeView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and STreeView< UObject * >.

◆ ReGenerateItems()

template<typename ItemType >

virtual FReGenerateResults SListView< ItemType >::ReGenerateItems ( const FGeometry & MyGeometry )

inlineoverridevirtual

Update generate Widgets for Items as needed and clean up any Widgets that are no longer needed. Re-arrange the visible widget order as necessary.

Implements STableViewBase.

Reimplemented in STileView< ItemType >, STileView< TSharedPtr< FTestData > >, STileView< TSharedPtr< int32 > >, STileView< UObject * >, STreeView< ItemType >, STreeView< TSharedPtr< FTestData > >, STreeView< TSharedPtr< int32 > >, STreeView< TSharedPtr< UE::PropertyViewer::Private::FTreeNode > >, and STreeView< UObject * >.

◆ ReGeneratePinnedItems()

template<typename ItemType >

void SListView< ItemType >::ReGeneratePinnedItems	(	const TArray< ItemType > &	InItems,
		const FGeometry &	MyGeometry,
		int32	MaxPinnedItemsOverride = `-1`
	)

inline

◆ RequestNavigateToItem()

template<typename ItemType >

void SListView< ItemType >::RequestNavigateToItem	(	ItemType	Item,
		const uint32	UserIndex = `0`
	)

inline

Navigate to a specific item, scrolling it into view if needed. If the item is not found, fails silently.

Parameters

Item	The item to navigate to on the next tick.

◆ RequestScrollIntoView() [1/2]

template<typename ItemType >

void SListView< ItemType >::RequestScrollIntoView	(	ItemType	ItemToView,
		const uint32	UserIndex,
		const bool	NavigateOnScrollIntoView
	)

inline

◆ RequestScrollIntoView() [2/2]

template<typename ItemType >

void SListView< ItemType >::RequestScrollIntoView	(	ItemType	ItemToView,
		const uint32	UserIndex = `0`
	)

inline

Scroll an item into view. If the item is not found, fails silently.

Parameters

ItemToView The item to scroll into view on next tick.

◆ ScrollBy()

template<typename ItemType >

virtual float SListView< ItemType >::ScrollBy	(	const FGeometry &	MyGeometry,
		float	ScrollByAmount,
		EAllowOverscroll	InAllowOverscroll
	)

inlineoverrideprotectedvirtual

Scroll the list view by some number of screen units.

Parameters

MyGeometry	The geometry of the ListView at the time
ScrollByAmount	The amount to scroll by in Slate Screen Units.
AllowOverscroll	Should we allow scrolling past the beginning/end of the list?

Returns: The amount actually scrolled in items

Reimplemented from STableViewBase.

Reimplemented in STileView< ItemType >, STileView< TSharedPtr< FTestData > >, STileView< TSharedPtr< int32 > >, and STileView< UObject * >.

◆ ScrollIntoView()

template<typename ItemType >

virtual EScrollIntoViewResult SListView< ItemType >::ScrollIntoView ( const FGeometry & ListViewGeometry )

inlineoverrideprotectedvirtual

If there is a pending request to scroll an item into view, do so.

Parameters

ListViewGeometry The geometry of the listView; can be useful for centering the item.

Implements STableViewBase.

Reimplemented in STileView< ItemType >, STileView< TSharedPtr< FTestData > >, STileView< TSharedPtr< int32 > >, and STileView< UObject * >.

◆ SetItemHighlighted()

template<typename ItemType >

void SListView< ItemType >::SetItemHighlighted	(	const ItemType &	TheItem,
		bool	bHighlighted
	)

inline

Set the highlighted state of an item.

Parameters

TheItem	The Item whose highlight state you wish to modify
bHighlighted	True to enable the soft parent highlight, false to disable it.

◆ SetItemSelection() [1/2]

template<typename ItemType >

void SListView< ItemType >::SetItemSelection	(	const ItemType &	InItem,
		bool	bSelected,
		ESelectInfo::Type	SelectInfo = `ESelectInfo::Direct`
	)

inline

Set the selection state of an item.

Parameters

InItem	The Item whose selection state to modify
bSelected	true to select the item; false to unselect
SelectInfo	Provides context on how the selection changed

◆ SetItemSelection() [2/2]

template<typename ItemType >

void SListView< ItemType >::SetItemSelection	(	TConstArrayView< ItemType >	InItems,
		bool	bSelected,
		ESelectInfo::Type	SelectInfo = `ESelectInfo::Direct`
	)

inline

Set the selection state of multiple items.

Parameters

InItems	The Items whose selection state to modify
bSelected	true to select the items; false to unselect
SelectInfo	Provides context on how the selection changed

◆ SetItemsSource() [1/3]

template<typename ItemType >

void SListView< ItemType >::SetItemsSource ( const TArray< ItemType > * InListItemsSource )

inline

Establishes a wholly new list of items being observed by the list. Wipes all existing state and requests and will fully rebuild on the next tick.

◆ SetItemsSource() [2/3]

template<typename ItemType >

void SListView< ItemType >::SetItemsSource ( TSharedRef<::UE::Slate::Containers::TObservableArray< ItemType > > InListItemsSource )

inline

Establishes a wholly new list of items being observed by the list. Wipes all existing state and requests and will fully rebuild on the next tick. The ObservableArray will notify the Widget when it needs to refresh.

◆ SetItemsSource() [3/3]

template<typename ItemType >

void SListView< ItemType >::SetItemsSource ( TUniquePtr< UE::Slate::ItemsSource::IItemsSource< ItemType > > Provider )

inline

Establishes a wholly new list of items being observed by the list. Wipes all existing state and requests and will fully rebuild on the next tick.

◆ SetListItemsSource()

template<typename ItemType >

void SListView< ItemType >::SetListItemsSource ( const TArray< ItemType > & InListItemsSource )

inline

◆ SetOnEntryInitialized()

template<typename ItemType >

void SListView< ItemType >::SetOnEntryInitialized ( const FOnEntryInitialized & Delegate )

inline

Sets the OnEntryInitializer delegate. This delegate is invoked after initializing an entry being generated, before it may be added to the actual widget hierarchy.

◆ SetScrollIntoViewAlignment()

template<typename ItemType >

void SListView< ItemType >::SetScrollIntoViewAlignment ( EScrollIntoViewAlignment NewScrollIntoViewAlignment )

inline

◆ SetSelection()

template<typename ItemType >

void SListView< ItemType >::SetSelection	(	ItemType	SoleSelectedItem,
		ESelectInfo::Type	SelectInfo = `ESelectInfo::Direct`
	)

inline

Set the currently selected Item.

Parameters

SoleSelectedItem	Sole item that should be selected.
SelectInfo	Provides context on how the selection changed

◆ SetSelectionMode()

template<typename ItemType >

void SListView< ItemType >::SetSelectionMode ( const TAttribute< ESelectionMode::Type > & NewSelectionMode )

inline

Set the current selection mode of the list. If going from multi-select to a type of single-select and one item is selected, it will be maintained (otherwise all will be cleared). If disabling selection, any current selections will be cleared.

◆ SetShadowBoxStyle()

template<typename ItemType >

void SListView< ItemType >::SetShadowBoxStyle ( const FScrollBoxStyle * InScrollBoxStyle )

inline

◆ SetStyle()

template<typename ItemType >

void SListView< ItemType >::SetStyle ( const FTableViewStyle * InStyle )

inline

◆ SLATE_ARGUMENT() [1/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	bool	,
		HandleDirectionalNavigation
	)

◆ SLATE_ARGUMENT() [2/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	bool	,
		HandleGamepadEvents
	)

◆ SLATE_ARGUMENT() [3/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	bool	,
		HandleSpacebarSelection
	)

◆ SLATE_ARGUMENT() [4/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	bool	,
		PreventThrottling
	)

◆ SLATE_ARGUMENT() [5/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	EAllowOverscroll	,
		AllowOverscroll
	)

◆ SLATE_ARGUMENT() [6/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	EConsumeMouseWheel	,
		ConsumeMouseWheel
	)

◆ SLATE_ARGUMENT() [7/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	float	,
		NavigationScrollOffset
	)

◆ SLATE_ARGUMENT() [8/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	float	,
		WheelScrollMultiplier
	)

◆ SLATE_ARGUMENT() [9/9]

template<typename ItemType >

SListView< ItemType >::SLATE_ARGUMENT	(	FMargin	,
		ScrollBarPadding
	)

◆ SLATE_BEGIN_ARGS()

template<typename ItemType >

SListView< ItemType >::SLATE_BEGIN_ARGS ( SListView< ItemType > )

inline

◆ SLATE_EVENT()

template<typename ItemType >

SListView< ItemType >::SLATE_EVENT	(	FOnTableViewBadState	,
		OnEnteredBadState
	)

Assign this to get more diagnostics from the list view.

◆ SLATE_STYLE_ARGUMENT()

template<typename ItemType >

SListView< ItemType >::SLATE_STYLE_ARGUMENT	(	FScrollBarStyle	,
		ScrollBarStyle
	)

◆ SupportsKeyboardFocus()

template<typename ItemType >

virtual bool SListView< ItemType >::SupportsKeyboardFocus ( ) const

inlineoverridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns: True if this widget can take keyboard focus

Reimplemented from STableViewBase.

◆ UpdateSelectionSet()

template<typename ItemType >

virtual void SListView< ItemType >::UpdateSelectionSet ( )

inlineoverridevirtual

Remove any items that are no longer in the list from the selection set.

Implements STableViewBase.

◆ WidgetFromItem()

template<typename ItemType >

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

inlineoverridevirtual

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.

Implements ITypedTableView< ItemType >.

Friends And Related Symbol Documentation

◆ FWidgetGenerator

template<typename ItemType >

friend class FWidgetGenerator

friend

◆ SListViewPinnedRowWidget

template<typename ItemType >

friend class SListViewPinnedRowWidget

friend

Member Data Documentation

◆ bClearScrollVelocityOnSelection

template<typename ItemType >

bool SListView< ItemType >::bClearScrollVelocityOnSelection = true

protected

True to force the scroll velocity to reset to 0 when an item of the list is selected

◆ bClearSelectionOnClick

template<typename ItemType >

bool SListView< ItemType >::bClearSelectionOnClick

protected

If true, the selection will be cleared if the user clicks in empty space (not on an item)

◆ bHandleDirectionalNavigation

template<typename ItemType >

bool SListView< ItemType >::bHandleDirectionalNavigation

protected

Should directional nav be supported

◆ bHandleGamepadEvents

template<typename ItemType >

bool SListView< ItemType >::bHandleGamepadEvents

protected

Should gamepad nav be supported

◆ bHandleSpacebarSelection

template<typename ItemType >

bool SListView< ItemType >::bHandleSpacebarSelection = false

protected

Should space bar based selection be supported

◆ bIsHierarchyCollapsed

template<typename ItemType >

bool SListView< ItemType >::bIsHierarchyCollapsed = false

protected

If true, number of pinned items > MaxPinnedItems so some items are collapsed in the hierarchy

◆ bNavigateOnScrollIntoView

template<typename ItemType >

bool SListView< ItemType >::bNavigateOnScrollIntoView = false

protected

If true, the item currently slated to be scrolled into view will also be navigated to after being scrolled in

◆ bReturnFocusToSelection

template<typename ItemType >

bool SListView< ItemType >::bReturnFocusToSelection

protected

If true, the focus will be returned to the last selected object in a list when navigated to.

◆ DefaultMaxPinnedItems

template<typename ItemType >

TAttribute<int32> SListView< ItemType >::DefaultMaxPinnedItems

protected

The initial value of MaxPinnedItems (used to restore it back if overriden)

◆ HighlightedItems

template<typename ItemType >

TItemSet SListView< ItemType >::HighlightedItems

protected

A set of which items should be highlighted

◆ IsFocusable

template<typename ItemType >

TAttribute<bool> SListView< ItemType >::IsFocusable

protected

True when the list view supports keyboard focus

◆ ItemsSource

template<typename ItemType >

const TArray<ItemType>* SListView< ItemType >::ItemsSource

protected

Pointer to the array of data items that we are observing

◆ ItemToNotifyWhenInView

template<typename ItemType >

NullableItemType SListView< ItemType >::ItemToNotifyWhenInView

protected

When set, the list will notify this item when it has been scrolled into view

◆ ItemToScrollIntoView

template<typename ItemType >

NullableItemType SListView< ItemType >::ItemToScrollIntoView

protected

When not null, the list will try to scroll to this item on tick.

◆ MaxPinnedItems

template<typename ItemType >

TAttribute<int32> SListView< ItemType >::MaxPinnedItems

protected

The maximum number of pinned items allowed

◆ NavigationScrollOffset

template<typename ItemType >

float SListView< ItemType >::NavigationScrollOffset = 0.5f

protected

The additional scroll offset (in items) to show when navigating to rows at the edge of the visible area (i.e. how much of the following item(s) to show)

◆ NavigationTypeOnScrollIntoView

template<typename ItemType >

EUINavigation SListView< ItemType >::NavigationTypeOnScrollIntoView = EUINavigation::Invalid

protected

Cached navigation direction to forward to navigate widget call

◆ OnClick

template<typename ItemType >

FOnMouseButtonClick SListView< ItemType >::OnClick

protected

Called when the user clicks on an element in the list view with the left mouse button

◆ OnDoubleClick

template<typename ItemType >

FOnMouseButtonDoubleClick SListView< ItemType >::OnDoubleClick

protected

Called when the user double-clicks on an element in the list view with the left mouse button

◆ OnEnteredBadState

template<typename ItemType >

FOnTableViewBadState SListView< ItemType >::OnEnteredBadState

protected

Invoked when the tree enters a bad state.

◆ OnEntryInitialized

template<typename ItemType >

FOnEntryInitialized SListView< ItemType >::OnEntryInitialized

protected

Invoked after initializing an entry being generated, before it may be added to the actual widget hierarchy.

◆ OnFinishedScrolling

template<typename ItemType >

FOnFinishedScrolling SListView< ItemType >::OnFinishedScrolling

protected

Delegate to be invoked when TargetScrollOffset is reached at the end of a Tick.

◆ OnGeneratePinnedRow

template<typename ItemType >

FOnGenerateRow SListView< ItemType >::OnGeneratePinnedRow

protected

Delegate to be invoked when the list needs to generate a new pinned widget from a data item.

◆ OnGenerateRow

template<typename ItemType >

FOnGenerateRow SListView< ItemType >::OnGenerateRow

protected

Delegate to be invoked when the list needs to generate a new widget from a data item.

◆ OnIsSelectableOrNavigable

template<typename ItemType >

FIsSelectableOrNavigable SListView< ItemType >::OnIsSelectableOrNavigable

protected

Delegate to invoke to see if we can navigate or select item.

◆ OnItemScrolledIntoView

template<typename ItemType >

FOnItemScrolledIntoView SListView< ItemType >::OnItemScrolledIntoView

protected

Delegate to be invoked when an item has come into view after it was requested to come into view.

◆ OnItemToString_Debug

template<typename ItemType >

FOnItemToString_Debug SListView< ItemType >::OnItemToString_Debug

protected

Assign this to get more diagnostics from the list view.

◆ OnKeyDownHandler

template<typename ItemType >

FOnKeyDown SListView< ItemType >::OnKeyDownHandler

protected

Called when the user presses a keyboard key

◆ OnRefreshRow

template<typename ItemType >

FOnRefreshRow SListView< ItemType >::OnRefreshRow

protected

Delegate to be invoked when the list needs to update an existing widget for an item.

◆ OnRowReleased

template<typename ItemType >

FOnWidgetToBeRemoved SListView< ItemType >::OnRowReleased

protected

◆ OnSelectionChanged

template<typename ItemType >

FOnSelectionChanged SListView< ItemType >::OnSelectionChanged

protected

Delegate to invoke when selection changes.

◆ PinnedWidgetGenerator

template<typename ItemType >

FWidgetGenerator SListView< ItemType >::PinnedWidgetGenerator

protected

A widget generator component used for pinned items in the list

◆ RangeSelectionStart

template<typename ItemType >

NullableItemType SListView< ItemType >::RangeSelectionStart

protected

The item which was last manipulated; used as a start for shift-click selection

◆ ScrollIntoViewAlignment

template<typename ItemType >

EScrollIntoViewAlignment SListView< ItemType >::ScrollIntoViewAlignment

protected

How to scroll an item into view

◆ SelectedItems

template<typename ItemType >

TItemSet SListView< ItemType >::SelectedItems

protected

A set of selected data items

◆ SelectorItem

template<typename ItemType >

NullableItemType SListView< ItemType >::SelectorItem

protected

The item to manipulate selection for

◆ Style

template<typename ItemType >

const FTableViewStyle* SListView< ItemType >::Style

protected

Style resource for the list

◆ UserRequestingScrollIntoView

template<typename ItemType >

uint32 SListView< ItemType >::UserRequestingScrollIntoView

protected

The user index requesting the item to be scrolled into view.

◆ WidgetGenerator

template<typename ItemType >

FWidgetGenerator SListView< ItemType >::WidgetGenerator

protected

A widget generator component

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

Engine/Source/Runtime/Slate/Public/Widgets/Views/SListView.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FIsSelectableOrNavigable

◆ FOnGenerateRow

◆ FOnItemScrolledIntoView

◆ FOnItemToString_Debug

◆ FOnMouseButtonClick

◆ FOnMouseButtonDoubleClick

◆ FOnRefreshRow

◆ FOnSelectionChanged

◆ MapKeyFuncs

◆ MapKeyFuncsSparse

◆ NullableItemType

◆ TItemSet

Constructor & Destructor Documentation

◆ SListView()

Member Function Documentation

◆ AddReferencedObjects()

◆ AsWidget()

◆ BindToRefreshRow()

◆ CancelScrollIntoView()

◆ ClearHighlightedItems()

◆ ClearItemsSource()

◆ ClearSelection()

◆ Construct()

◆ DECLARE_DELEGATE_OneParam()

◆ DECLARE_DELEGATE_TwoParams()

◆ GenerateNewPinnedWidget()

◆ GenerateNewWidget()

◆ GeneratePinnedWidgetForItem()

◆ GenerateWidgetForItem()

◆ GetDefaultDebugDelegate()

◆ GetItems()

◆ GetMaxRowSizeForColumn()

◆ GetNumItemsBeingObserved()

◆ GetNumItemsSelected()

◆ GetReferencerName()

◆ GetSelectedItems() [1/2]

◆ GetSelectedItems() [2/2]

◆ GetTableViewMode()

◆ HasValidItemsSource()

◆ IsItemSelected()

◆ IsItemVisible()

◆ ItemFromWidget()

◆ NavigationSelect() [1/2]

◆ NavigationSelect() [2/2]

◆ NotifyFinishedScrolling()

◆ NotifyItemScrolledIntoView()

◆ OnKeyDown()

◆ OnKeyDown_Internal()

◆ OnMouseButtonDown()

◆ OnMouseButtonUp()

◆ OnNavigation()

◆ Private_ClearHighlightedItems()

◆ Private_ClearSelection()

◆ Private_DoesItemHaveChildren()

◆ Private_FindNextSelectableOrNavigable()

◆ Private_FindNextSelectableOrNavigableWithIndexAndDirection()

◆ Private_GetNestingDepth()

◆ Private_GetNumSelectedItems()

◆ Private_GetOrientation()

◆ Private_GetSelectionMode()

◆ Private_GetWiresNeededByDepth()

◆ Private_HasSelectorFocus()

◆ Private_IsItemExpanded()

◆ Private_IsItemHighlighted()

◆ Private_IsItemSelectableOrNavigable()

◆ Private_IsItemSelected()

◆ Private_IsLastChild()

◆ Private_IsPendingRefresh()

◆ Private_ItemFromWidget()

◆ Private_OnEntryInitialized()

◆ Private_OnExpanderArrowShiftClicked()