1. Epic GamesDeveloper
  3. SObjectTableRow

SObjectTableRow

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

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Slate

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Slate/SObjectTableRow.h
Include #include "Slate/SObjectTableRow.h"

Syntax

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

Remarks

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 IUserListItem UInterface, 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.

Variables

  Type Name Description
Protected variable FOnRowHovered OnHovered  
Protected variable FOnRowHovered OnUnhovered  
Protected variable TWeakObjectPtr< UListViewBase > OwnerListView  
Protected variable TWeakPtr< ITypedTableView< ItemType > > OwnerTablePtr  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

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

  
Public function EActiveTimerReturnType

DetectItemSelectionChanged ( double InCurrentTime,
float InDeltaTime
)

  
Protected function Const const ItemType *

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

  
Protected function Virtual void  
Protected function Const bool  
Public function Virtual void

NotifyItemExpansionChanged ( bool bIsExpanded
)

  
Protected function Virtual void

OnItemSelectionChanged ( bool bIsItemSelected
)

  
Protected function Virtual void  

Overridden from SWidget

  Type Name Description
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

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
)

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

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

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual void

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

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
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)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Overridden from IObjectTableRow

  Type Name Description
Public function Virtual Const UListViewBase *  
Public function Virtual Const UUserWidget *  

Overridden from ITableRow

  Type Name Description
Public function Virtual TSharedRef< SWidget >  
Public function Virtual Const int32  
Public function Virtual TSharedPtr< SWidget >  
Public function Virtual Const int32  
Public function Virtual int32  
Public function Virtual Const FVector2D

GetRowSizeForColumn ( const FName& InColumnName
)

  
Public 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

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page