1. Epic GamesDeveloper
  3. STableRow

STableRow

The ListView is populated by Selectable widgets.

API > API/Runtime > API/Runtime/Slate

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.

   
Name STableRow
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Views/STableRow.h
Include Path #include "Widgets/Views/STableRow.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

STableRow derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

STableRow()

 Protected constructor; SWidgets should only be instantiated via declarative syntax. Widgets/Views/STableRow.h  

Classes

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

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnAcceptDrop TBaseDelegate_ThreeParams< FReply, const FDragDropEvent &, EItemDropZone, ItemType > Delegate signature for handling the drop of FDragDropEvent onto target of type ItemType Widgets/Views/STableRow.h
FOnCanAcceptDrop TBaseDelegate_ThreeParams< TOptional< EItemDropZone >, const FDragDropEvent &, EItemDropZone, ItemType > Delegate signature for querying whether this FDragDropEvent will be handled by the drop target of type ItemType. Widgets/Views/STableRow.h
FOnPaintDropIndicator TBaseDelegate_EightParams< int32, EItemDropZone, const FPaintArgs &, const FGeometry &, const FSlateRect &, FSlateWindowElementList &, int32, const FWidgetStyle &, bool > Delegate signature for painting drop indicators. Widgets/Views/STableRow.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bShowWires bool   Widgets/Views/STableRow.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Construct this widget Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

virtual const FSlateBrush * GetBorder()

   Widgets/Views/STableRow.h  

const FSlateBrush * GetDropIndicatorBrush ( EItemDropZone InItemDropZone
) const

 Retrieves a brush for rendering a drop indicator for the specified drop zone Widgets/Views/STableRow.h  

bool IsHighlighted()

 Callback to determine if the row is highlighted or not Widgets/Views/STableRow.h  

bool IsSelected()

 Callback to determine if the row is selected or not Widgets/Views/STableRow.h  

bool IsSelectedExclusively()

 Callback to determine if the row is selected singularly and has keyboard focus or not Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

void SetExpanderArrowVisibility ( const EVisibility InExpanderArrowVisibility
)

   Widgets/Views/STableRow.h  

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 Widgets/Views/STableRow.h  

EItemDropZone ZoneFromPointerPosition ( UE::Slate::FDeprecateVector2DParameter LocalPointerPos,
UE::Slate::FDeprecateVector2DParameter LocalSize,
EOrientation Orientation
)

   Widgets/Views/STableRow.h  

Overridden from ITableRow

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > AsWidget()

   Widgets/Views/STableRow.h  

virtual int32 DoesItemHaveChildren()

   Widgets/Views/STableRow.h  

virtual TSharedPtr< SWidget > GetContent()

 Get the inner content of this row Widgets/Views/STableRow.h  

virtual int32 GetIndentLevel()

   Widgets/Views/STableRow.h  

virtual int32 GetIndexInList()

   Widgets/Views/STableRow.h  

virtual FVector2D GetRowSizeForColumn ( const FName& InColumnName
) const

 By default, this function does nothing, it should be implemented by derived class Widgets/Views/STableRow.h  

virtual TBitArray GetWiresNeededByDepth()

   Widgets/Views/STableRow.h  

virtual void InitializeRow ()

 Called when the row has been generated and associated with an item in the owning table. Widgets/Views/STableRow.h  

virtual bool IsItemExpanded()

   Widgets/Views/STableRow.h  

virtual bool IsItemSelected()

   Widgets/Views/STableRow.h  

virtual bool IsLastChild()

   Widgets/Views/STableRow.h  

virtual void Private_OnExpanderArrowShiftClicked()

 Called when the expander arrow for this row is shift+clicked Widgets/Views/STableRow.h  

virtual void ResetRow ()

 Called when the row has been released from the owning table and is no longer associated with any items therein. Widgets/Views/STableRow.h  

virtual void SetIndexInList ( int32 InIndexInList
)

   Widgets/Views/STableRow.h  

virtual void ToggleExpansion()

 Toggle the expansion of the item associated with this row Widgets/Views/STableRow.h  

Overridden from SBorder

Name Remarks Include Path Unreal Specifiers

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 Widgets/Views/STableRow.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget()

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

virtual void OnDragLeave ( FDragDropEvent const& DragDropEvent
)

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

 Called when a mouse button is double clicked. Override this in derived classes. Widgets/Views/STableRow.h  

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

 See SWidget::OnMouseButtonDown Widgets/Views/STableRow.h  

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

 See SWidget::OnMouseButtonUp Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 An internal method to construct and setup this row widget (purposely avoids child construction). Widgets/Views/STableRow.h  

FSlateColor GetForegroundBasedOnSelection()

   Widgets/Views/STableRow.h  

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

   Widgets/Views/STableRow.h  

void SetOwnerTableView ( TSharedPtr< STableViewBase > OwnerTableView
)

   Widgets/Views/STableRow.h  

Overridden from ITableRow

Name Remarks Include Path Unreal Specifiers

virtual ESelectionMode::Type GetSelectionMode()

 Called to query the selection mode for the row Widgets/Views/STableRow.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page