STableRow

The ListView is populated by Selectable widgets.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

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

Syntax

template<typename ItemType>
class STableRow :
public ITableRow,
public SBorder

Remarks

The ListView is populated by Selectable widgets. A Selectable widget is a way of the ListView containing it (OwnerTable) and holds arbitrary Content (Content). A Selectable works with its corresponding ListView to provide selection functionality.

Variables

	Name	Description
bool	bAllowPreselectedItemActivation	When activating an item via mouse button, we generally don't allow pre-selected items to be activated
bool	bChangedSelectionOnMouseDown
bool	bDragWasDetected
bool	bProcessingSelectionTouch	Did the current a touch interaction start in this item?
bool	bShowSelection	Whether or not to visually show that this row is selected
TWeakPtr< SWidg...	Content	The widget in the content slot for this row
const ISlateSty...	ExpanderStyleSet	The slate style to use with the expander
int32	IndexInList	Index of the corresponding data item in the list
FSlotBase *	InnerContentSlot	The slot that contains the inner content for this row.
TOptional< EIte...	ItemDropZone	Are we currently dragging/dropping over this item?
FOnAcceptDrop	OnAcceptDrop
FOnCanAcceptDro...	OnCanAcceptDrop
FOnDragDetected	OnDragDetected_Handler	Delegate triggered when a user starts to drag a list item
FOnTableRowDrag...	OnDragEnter_Handler	Delegate triggered when a user's drag enters the bounds of this list item
FOnTableRowDrag...	OnDragLeave_Handler	Delegate triggered when a user's drag leaves the bounds of this list item
FOnTableRowDrop	OnDrop_Handler	Delegate triggered when a user's drag is dropped in the bounds of this list item
TWeakPtr< IType...	OwnerTablePtr	The list that owns this Selectable
ETableRowSignal...	SignalSelectionMode	When should we signal that selection changed for a left click
const FTableRow...	Style	Style used to draw this table row

Constructors

	Name	Description
	STableRow()	Protected constructor; SWidgets should only be instantiated via declarative syntax.

Functions

	Name	Description
void	Construct ( const typename STableRow< ItemType ..., const TSharedRef< STableViewBase > ... )	Construct this widget
void	ConstructChildren ( ETableViewMode::Type InOwnerTableMo..., const TAttribute< FMargin >& InPad..., const TSharedRef< SWidget >& InCon... )
void	ConstructInternal ( FArguments const& InArgs, TSharedRef< STableViewBase > const ... )	An internal method to construct and setup this row widget (purposely avoids child construction).
const FSlate...	GetBorder()
FSlateColor	GetForegroundBasedOnSelection()
const ItemTy...	GetItemForThis ( const TSharedRef< ITypedTableView< ... )
bool	IsSelected()	Callback to determine if the row is selected or not
bool	IsSelectedExclusively()	Callback to determine if the row is selected singularly and has keyboard focus or not
void	OnDragEnter ( FGeometry const& MyGeometry, FDragDropEvent const& DragDropEven... )
void	OnDragLeave ( FDragDropEvent const& DragDropEven... )
void	SetOwnerTableView ( TSharedPtr< STableViewBase > OwnerT... )
void	SetRowContent ( TSharedRef< SWidget > InContent )	Set the entire content of this row, replacing any extra UI (such as the expander arrows for tree views) that was added by ConstructChildren
EItemDropZon...	ZoneFromPointerPosition ( FVector2D LocalPointerPos, FVector2D LocalSize, EOrientation Orientation )

Overridden from ITableRow

	Name	Description
TSharedRef< ...	AsWidget()
int32	DoesItemHaveChildren()
TSharedPtr< ...	GetContent()	Get the inner content of this row
int32	GetIndentLevel()
int32	GetIndexInList()
FVector2D	GetRowSizeForColumn ( const FName& InColumnName )	By default, this function does nothing, it should be implemented by derived class
ESelectionMo...	GetSelectionMode()	Called to query the selection mode for the row
TBitArray	GetWiresNeededByDepth()
void	InitializeRow()	Called when the row has been generated and associated with an item in the owning table.
bool	IsItemExpanded()
bool	IsItemSelected()
bool	IsLastChild()
void	Private_OnExpanderArrowShiftClicked()	Called when the expander arrow for this row is shift+clicked
void	ResetRow()	Called when the row has been released from the owning table and is no longer associated with any items therein.
void	SetIndexInList ( int32 InIndexInList )
void	ToggleExpansion()	Toggle the expansion of the item associated with this row

Overridden from SBorder

		Name	Description
	void	SetContent ( TSharedRef< SWidget > InContent )	Set the inner content of this row, preserving any extra UI (such as the expander arrows for tree views) that was added by ConstructChildren

Overridden from SWidget

	Name	Description
TSharedRef< ...	CreateAccessibleWidget()
FReply	OnDragDetected ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when Slate detects that a widget started to be dragged.
FReply	OnDragOver ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called during drag and drop when the the mouse is being dragged over a widget.
FReply	OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called when the user is dropping something onto a widget; terminates drag and drop.
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	See SWidget::OnMouseButtonDown
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	See SWidget::OnMouseButtonUp
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
FReply	OnTouchEnded ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is ended (finger lifted)
FReply	OnTouchStarted ( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent )	Called when a touchpad touch is started (finger down)

Classes

	Name	Description
	FArguments
	FSlateAccessibleTableRow	An accessible implementation of STableRow exposed to platform accessibility APIs.

Typedefs

Name	Description
FOnAcceptDrop	Delegate signature for handling the drop of FDragDropEvent onto target of type ItemType
FOnCanAcceptDrop	Delegate signature for querying whether this FDragDropEvent will be handled by the drop target of type ItemType.