1. Epic GamesDeveloper
  3. SObjectTableRow

SObjectTableRow

It's an SObjectWidget! It's an ITableRow! It does it all!

API > API/Runtime > API/Runtime/UMG

It's an SObjectWidget! It's an ITableRow! It does it all!

By using UUserWidget::TakeDerivedWidget(), this class allows UMG to fully leverage the robust Slate list view widgets. The major gain from this is item virtualization, which is an even bigger deal when unnecessary widgets come with a boatload of additional UObject allocations.

The owning UUserWidget is expected to implement the IUserListEntryUInterface, which allows the row widget to respond to various list-related events.

Note: Much of the implementation here matches STableRow exactly, so refer there if looking for additional information.

   
Name SObjectTableRow
Type class
Header File /Engine/Source/Runtime/UMG/Public/Slate/SObjectTableRow.h
Include Path #include "Slate/SObjectTableRow.h"

Syntax

template<typename ItemType>  
class SObjectTableRow :  
    public SObjectWidget ,  
    public IObjectTableRow

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SObjectTableRow()

   Slate/SObjectTableRow.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllowDragDrop bool Whether to allow drag drop operations to be performed on the list Slate/SObjectTableRow.h  
bAllowDragging bool Whether to allow dragging of this item Slate/SObjectTableRow.h  
bAllowKeepPreselectedItems bool If true, when selecting an item via mouse button, we allow pre-selected items to remain selected Slate/SObjectTableRow.h  
bChangedSelectionOnMouseDown bool   Slate/SObjectTableRow.h  
bDragWasDetected bool Whether or not drag was detected Slate/SObjectTableRow.h  
bIsAppearingSelected bool   Slate/SObjectTableRow.h  
bProcessingSelectionTouch bool   Slate/SObjectTableRow.h  
IndexInList int32   Slate/SObjectTableRow.h  
ItemDropZone TOptional< EItemDropZone > Are we currently dragging/dropping over this item? Slate/SObjectTableRow.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs,
const TSharedRef< STableViewBase >& InOwnerTableView,
UUserWidget& InWidgetObject,
UListViewBase* InOwnerListView
)

   Slate/SObjectTableRow.h  

EActiveTimerReturnType DetectItemSelectionChanged ( double InCurrentTime,
float InDeltaTime
)

   Slate/SObjectTableRow.h  

bool GetAllowDragDrop()

   Slate/SObjectTableRow.h  

virtual void HandleEntryDragged ( UDragDropOperation* Operation
)

   Slate/SObjectTableRow.h  

virtual void HandleEntryDropped ( UDragDropOperation* Operation
)

   Slate/SObjectTableRow.h  

virtual void NotifyItemExpansionChanged ( bool bIsExpanded
)

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

Overridden from SObjectWidget

Name Remarks Include Path Unreal Specifiers

virtual void OnDragCancelled ( const FDragDropEvent& DragDropEvent,
UDragDropOperation* Operation
)

   Slate/SObjectTableRow.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

virtual void OnDragLeave ( FDragDropEvent const& DragDropEvent
)

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

virtual bool SupportsKeyboardFocus()

   Slate/SObjectTableRow.h  

Overridden from IObjectTableRow

Name Remarks Include Path Unreal Specifiers

virtual UListViewBase * GetOwningListView()

   Slate/SObjectTableRow.h  

virtual UUserWidget * GetUserWidget()

   Slate/SObjectTableRow.h  

Overridden from ITableRow

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > AsWidget()

   Slate/SObjectTableRow.h  

virtual int32 DoesItemHaveChildren()

   Slate/SObjectTableRow.h  

virtual TSharedPtr< SWidget > GetContent()

   Slate/SObjectTableRow.h  

virtual int32 GetIndentLevel()

   Slate/SObjectTableRow.h  

virtual int32 GetIndexInList()

   Slate/SObjectTableRow.h  

virtual FVector2D GetRowSizeForColumn ( const FName& InColumnName
) const

   Slate/SObjectTableRow.h  

virtual ESelectionMode::Type GetSelectionMode()

   Slate/SObjectTableRow.h  

virtual TBitArray GetWiresNeededByDepth()

   Slate/SObjectTableRow.h  

virtual void InitializeRow()

   Slate/SObjectTableRow.h  

virtual bool IsItemExpanded()

   Slate/SObjectTableRow.h  

virtual bool IsItemSelected()

   Slate/SObjectTableRow.h  

virtual bool IsLastChild()

   Slate/SObjectTableRow.h  

virtual void Private_OnExpanderArrowShiftClicked()

   Slate/SObjectTableRow.h  

virtual void ResetRow()

   Slate/SObjectTableRow.h  

virtual void SetIndexInList ( int32 InIndexInList
)

   Slate/SObjectTableRow.h  

virtual void ToggleExpansion()

   Slate/SObjectTableRow.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void DetectItemSelectionChanged ()

   Slate/SObjectTableRow.h  

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

   Slate/SObjectTableRow.h  

virtual void InitializeObjectRow()

   Slate/SObjectTableRow.h  

bool IsItemSelectable()

   Slate/SObjectTableRow.h  

virtual void OnItemSelectionChanged ( bool bIsItemSelected
)

   Slate/SObjectTableRow.h  

virtual void ResetObjectRow()

   Slate/SObjectTableRow.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page