1. Epic GamesDeveloper
  3. STableRow

STableRow

The ListView is populated by Selectable widgets.

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/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

  Type Name Description
Protected variable bool bAllowPreselectedItemActivation When activating an item via mouse button, we generally don't allow pre-selected items to be activated
Protected variable bool bChangedSelectionOnMouseDown  
Protected variable bool bDragWasDetected  
Protected variable bool bProcessingSelectionTouch Did the current a touch interaction start in this item?
Protected variable bool bShowSelection Whether or not to visually show that this row is selected
Protected variable TWeakPtr< SWidget > Content The widget in the content slot for this row
Protected variable TSharedPtr< SExpanderArrow > ExpanderArrowWidget A pointer to the expander arrow on the row (if it exists)
Protected variable const ISlateStyle * ExpanderStyleSet The slate style to use with the expander
Protected variable int32 IndexInList Index of the corresponding data item in the list
Protected variable FSlotBase * InnerContentSlot The slot that contains the inner content for this row.
Protected variable TOptional< EItemDropZone > ItemDropZone Are we currently dragging/dropping over this item?
Protected variable FOnAcceptDrop OnAcceptDrop  
Protected variable FOnCanAcceptDrop OnCanAcceptDrop  
Protected variable FOnDragDetected OnDragDetected_Handler Delegate triggered when a user starts to drag a list item
Protected variable FOnTableRowDragEnter OnDragEnter_Handler Delegate triggered when a user's drag enters the bounds of this list item
Protected variable FOnTableRowDragLeave OnDragLeave_Handler Delegate triggered when a user's drag leaves the bounds of this list item
Protected variable FOnTableRowDrop OnDrop_Handler Delegate triggered when a user's drag is dropped in the bounds of this list item
Protected variable TWeakPtr< ITypedTableView< ItemType > > OwnerTablePtr The list that owns this Selectable
Protected variable FOnPaintDropIndicator PaintDropIndicatorEvent Optional delegate for painting drop indicators
Protected variable ETableRowSignalSelectionMode SignalSelectionMode When should we signal that selection changed for a left click
Protected variable const FTableRowStyle * Style Style used to draw this table row

Constructors

  Type Name Description
Public function   Protected constructor; SWidgets should only be instantiated via declarative syntax.

Functions

  Type Name Description
Public function void

Construct ( const typename STableRow< ItemType >::FArguments& InArgs,
const TSharedRef< STableViewBase >& InOwnerTableView
)

 Construct this widget
Public function Virtual void

ConstructChildren ( ETableViewMode::Type InOwnerTableMode,
const TAttribute< FMargin >& InPadding,
const TSharedRef< SWidget >& InContent
)

  
Protected function void

ConstructInternal ( FArguments const& InArgs,
TSharedRef< STableViewBase > const& InOwnerTableView
)

 An internal method to construct and setup this row widget (purposely avoids child construction).
Public function Virtual Const const FSlateBrush *  
Public function Const const FSlateBrush *

GetDropIndicatorBrush ( EItemDropZone InItemDropZone
)

 Retrieves a brush for rendering a drop indicator for the specified drop zone
Protected function Const FSlateColor  
Protected function Const const ItemType *

GetItemForThis ( const TSharedRef< ITypedTableView< ItemType >>& OwnerTable
)

  
Public function Const bool Callback to determine if the row is selected or not
Public function Const bool Callback to determine if the row is selected singularly and has keyboard focus or not
Public function Virtual void

OnDragEnter ( FGeometry const& MyGeometry,
FDragDropEvent const& DragDropEvent
)

  
Public function Virtual void

OnDragLeave ( FDragDropEvent const& DragDropEvent
)

  
Public function Virtual Const int32

OnPaintDropIndicator ( EItemDropZone InItemDropZone,
const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

  
Public function void

SetExpanderArrowVisibility ( const EVisibility InExpanderArrowVisibility
)

  
Protected function void  
Public function Virtual 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
Public function EItemDropZone  

Overridden from ITableRow

  Type Name Description
Public function Virtual TSharedRef< SWidget >  
Public function Virtual Const int32  
Public function Virtual TSharedPtr< SWidget > Get the inner content of this row
Public function Virtual Const int32  
Public function Virtual int32  
Public function Virtual Const FVector2D

GetRowSizeForColumn ( const FName& InColumnName
)

 By default, this function does nothing, it should be implemented by derived class
Protected function Virtual Const ESelectionMode::Type Called to query the selection mode for the row
Public function Virtual Const TBitArray  
Public function Virtual void Called when the row has been generated and associated with an item in the owning table.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void Called when the expander arrow for this row is shift+clicked
Public function Virtual void Called when the row has been released from the owning table and is no longer associated with any items therein.
Public function Virtual void

SetIndexInList ( int32 InIndexInList
)

  
Public function Virtual void Toggle the expansion of the item associated with this row

Overridden from SBorder

  Type Name Description
Public function Virtual 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

  Type Name Description
Public function Virtual TSharedRef< FSlateAccessibleWidget >  
Public function Virtual FReply

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

 Called when Slate detects that a widget started to be dragged.
Public function Virtual FReply

OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Public function Virtual FReply

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

 See SWidget::OnMouseButtonDown
Public function Virtual FReply

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

 See SWidget::OnMouseButtonUp
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
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.
Public function Virtual FReply

OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted)
Public function Virtual FReply

OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down)

Classes

  Type Name Description
Public struct FArguments    
Protected class 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.
FOnPaintDropIndicator Delegate signature for painting drop indicators.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page