1. Epic GamesDeveloper
  3. Views

Views

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets

Classes

  Type Name Description
Public class FArrayPointer    
Private struct FGenerationPassGuard    
Public struct FItemInfo Info needed by every visible item in the tree  
Public class FObservableArrayPointer    
Public struct ForwardedSlateItemsSourceArgument    
Public class FSharedObservableArray    
Public struct FSparseItemInfo Info needed by a (relatively) small fraction of the tree items; some of them may not be visible.  
Public struct FTableViewDimensions Scroll offset from the beginning of the list in items Abstracts away the need to distinguish between X or Y when calculating table layout elements  
Public class IItemsSource A generic container for TableView items.  
Public class ITableRow Interface for table views to talk to their rows.  
Public class SListView A ListView widget observes an array of data items and creates visual representations of these items.  
Public class STableViewBase Contains ListView functionality that does not depend on the type of data being observed by the ListView.  

Typedefs

Name Description
FOnGetMaxRowSizeForColumn Callback to fetch the max row width for a specified column id
FOnSortModeChanged Callback when sort mode changes
FOnTableRowDragEnter  
FOnTableRowDragLeave  
FOnTableRowDrop  
FOnTableViewScrolled  
FOnWidthChanged Callback when the width of the column changes

Enums

  Type Name Description
Public enum EColumnSizeMode::Type    
Public enum EColumnSortMode::Type    
Public enum EColumnSortPriority::Type    
Public enum EHeaderComboVisibility    
Public enum EItemDropZone Where we are going to drop relative to the target item.  
Public enum UEnum BlueprintType EListItemAlignment If the list panel is arranging items as tiles, this enum dictates how the items should be aligned (basically, where any extra space is placed)  
Public enum ETableRowSignalSelectionMode When the table row should signal the owner widget that the selection changed.  

Functions

  Type Name Description
Public function Virtual void Lists and Trees serialize items that they observe because they rely on the property that holding a reference means it will not be garbage collected.
Public function void Cancels a previous request to scroll an item into view (cancels navigation requests as well).
Public function void Empty the highlighted item set.
Public function void  
Public function void Empty the selection set.
Public function Virtual TSharedRef< ITableRow >

GenerateNewPinnedWidget ( ItemType InItem,
const int32 ItemIndex,
const int32 NumPinnedItems
)

  
Public function Virtual TSharedRef< ITableRow >

GenerateNewWidget ( ItemType InItem
)

 Given an data item, generate a widget corresponding to it.
Public function void

GeneratePinnedWidgetForItem ( const ItemType& CurItem,
int32 ItemIndex,
int32 NumPinnedItems,
float LayoutScaleMultiplier
)

  
Public function float

GenerateWidgetForItem ( const ItemType& CurItem,
int32 ItemIndex,
int32 StartIndex,
float LayoutScaleMultiplier
)

  
Protected function Static FOnItemToString_Debug  
Public function Const TArrayView< const ItemType >  
Public function FVector2D

GetMaxRowSizeForColumn ( const FName& ColumnId,
EOrientation ColumnOrientation
)

 Will determine the max row size for the specified column id
Public function Virtual Const int32  
Public function Const int32 Gets the number of selected items.
Public function Virtual Const FString  
Public function Const int32

GetSelectedItems ( TArray< ItemType >& SelectedItemArray
)

  
Public function Virtual Const TArray< ItemType > Returns a list of selected item indices, or an empty array if nothing is selected
Public function Const bool  
Public function Const bool

IsItemSelected ( const ItemType& InItem
)

 Test if the current item is selected.
Public function Const bool

IsItemVisible ( ItemType Item
)

 Checks whether the specified item is currently visible in the list view.
Public function Const const TObjectPtrWrapTypeOf< ItemType > *

ItemFromWidget ( const ITableRow* WidgetToFind
)

 Given a Widget, find the corresponding data item.
Protected function Virtual void

NavigationSelect ( const ItemType& InItemToSelect,
const FInputEvent& InInputEvent
)

 Selects the specified item and scrolls it into view. If shift is held, it will be a range select.
Protected function Virtual void  
Protected function Virtual void  
Protected function TOptional< ItemType >

Private_FindNextSelectableOrNavigable ( const ItemType& InItemToSelect
)

  
Protected function TOptional< ItemType >

Private_FindNextSelectableOrNavigableWithIndexAndDirection ( const ItemType& InItemToSelect,
int32 SelectionIdx,
bool bSelectForward
)

  
Private function void

Private_RequestNavigateToItem ( ItemType Item,
const uint32 UserIndex
)

  
Private function void

Private_SetSelection ( ItemType SoleSelectedItem,
ESelectInfo::Type SelectInfo
)

  
Public function Virtual void  
Public function Virtual FReGenerateResults

ReGenerateItems ( const FGeometry& MyGeometry
)

 Update generate Widgets for Items as needed and clean up any Widgets that are no longer needed.
Public function void

ReGeneratePinnedItems ( const TArray< ItemType >& InItems,
const FGeometry& MyGeometry,
int32 MaxPinnedItemsOverride
)

  
Public function void

RequestNavigateToItem ( ItemType Item,
const uint32 UserIndex
)

 Navigate to a specific item, scrolling it into view if needed.
Public function void

RequestScrollIntoView ( ItemType ItemToView,
const uint32 UserIndex,
const bool NavigateOnScrollIntoView
)

  
Public function void

RequestScrollIntoView ( ItemType ItemToView,
const uint32 UserIndex
)

 Scroll an item into view. If the item is not found, fails silently.
Protected function Virtual float

ScrollBy ( const FGeometry& MyGeometry,
float ScrollByAmountInSlateUnits,
EAllowOverscroll InAllowOverscroll
)

  
Protected function Virtual EScrollIntoViewResult

ScrollIntoView ( const FGeometry& ListViewGeometry
)

 If there is a pending request to scroll an item into view, do so.
Public function void

SetItemHighlighted ( const ItemType& TheItem,
bool bHighlighted
)

 Set the highlighted state of an item.
Public function void

SetItemSelection ( TConstArrayView< ItemType > InItems,
bool bSelected,
ESelectInfo::Type SelectInfo
)

 Set the selection state of multiple items.
Public function void

SetItemSelection ( const ItemType& InItem,
bool bSelected,
ESelectInfo::Type SelectInfo
)

 Set the selection state of an item.
Public function void

SetItemsSource ( const TArray< ItemType >* InListItemsSource
)

 Establishes a wholly new list of items being observed by the list.
Public function void Establishes a wholly new list of items being observed by the list.
Public function void Establishes a wholly new list of items being observed by the list.
Public function void

SetListItemsSource ( const TArray< ItemType >& InListItemsSource
)

  
Public function void

SetOnEntryInitialized ( const FOnEntryInitialized& Delegate
)

 Sets the OnEntryInitializer delegate.
Public function void

SetSelection ( ItemType SoleSelectedItem,
ESelectInfo::Type SelectInfo
)

 Set the currently selected Item.
Public function void

SetSelectionMode ( const TAttribute< ESelectionMode::Type >& NewSelectionMode
)

 Set the current selection mode of the list.
Public function void

SetStyle ( const FTableViewStyle* InStyle
)

  
Public function const TBitArray & Helper for implementing an efficient version of an item that is not in the tree view, and therefore does not to know about parent wires.
Public function Virtual void Remove any items that are no longer in the list from the selection set.
Public function Virtual Const TSharedPtr< ITableRow >

WidgetFromItem ( const ItemType& InItem
)

 Find a widget for this item if it has already been constructed.

Variables

  Type Name Description
Protected variable bool bClearSelectionOnClick If true, the selection will be cleared if the user clicks in empty space (not on an item)
Protected variable bool bHandleDirectionalNavigation Should directional nav be supported
Protected variable bool bHandleGamepadEvents Should gamepad nav be supported
Protected variable bool bHandleSpacebarSelection Should space bar based selection be supported
Protected variable bool bIsHierarchyCollapsed If true, number of pinned items > MaxPinnedItems so some items are collapsed in the hierarchy
Protected variable bool bNavigateOnScrollIntoView If true, the item currently slated to be scrolled into view will also be navigated to after being scrolled in
Protected variable bool bReturnFocusToSelection If true, the focus will be returned to the last selected object in a list when navigated to.
Protected variable TAttribute< int32 > DefaultMaxPinnedItems The initial value of MaxPinnedItems (used to restore it back if overriden)
Protected variable TItemSet HighlightedItems A set of which items should be highlighted
Protected variable TAttribute< bool > IsFocusable True when the list view supports keyboard focus
Protected variable const TArray< ItemType > * ItemsSource Pointer to the array of data items that we are observing
Protected variable NullableItemType ItemToNotifyWhenInView When set, the list will notify this item when it has been scrolled into view
Protected variable NullableItemType ItemToScrollIntoView When not null, the list will try to scroll to this item on tick.
Protected variable TAttribute< int32 > MaxPinnedItems The maximum number of pinned items allowed
Protected variable float NavigationScrollOffset The additional scroll offset (in items) to show when navigating to rows at the edge of the visible area (i.e. how much of the following item(s) to show)
Protected variable FOnMouseButtonClick OnClick Called when the user clicks on an element in the list view with the left mouse button
Protected variable FOnMouseButtonDoubleClick OnDoubleClick Called when the user double-clicks on an element in the list view with the left mouse button
Protected variable FOnTableViewBadState OnEnteredBadState Invoked when the tree enters a bad state.
Protected variable FOnEntryInitialized OnEntryInitialized Invoked after initializing an entry being generated, before it may be added to the actual widget hierarchy.
Protected variable FOnFinishedScrolling OnFinishedScrolling Delegate to be invoked when TargetScrollOffset is reached at the end of a ::Tick.
Protected variable FOnGenerateRow OnGeneratePinnedRow Delegate to be invoked when the list needs to generate a new pinned widget from a data item.
Protected variable FOnGenerateRow OnGenerateRow Delegate to be invoked when the list needs to generate a new widget from a data item.
Protected variable FIsSelectableOrNavigable OnIsSelectableOrNavigable Delegate to invoke to see if we can navigate or select item.
Protected variable FOnItemScrolledIntoView OnItemScrolledIntoView Delegate to be invoked when an item has come into view after it was requested to come into view.
Protected variable FOnItemToString_Debug OnItemToString_Debug Assign this to get more diagnostics from the list view.
Protected variable FOnKeyDown OnKeyDownHandler Called when the user presses a keyboard key
Protected variable FOnWidgetToBeRemoved OnRowReleased  
Protected variable FOnSelectionChanged OnSelectionChanged Delegate to invoke when selection changes.
Protected variable FWidgetGenerator PinnedWidgetGenerator A widget generator component used for pinned items in the list
Protected variable NullableItemType RangeSelectionStart The item which was last manipulated; used as a start for shift-click selection
Protected variable TItemSet SelectedItems A set of selected data items
Protected variable NullableItemType SelectorItem The item to manipulate selection for
Protected variable const FTableViewStyle * Style Style resource for the list
Protected variable uint32 UserRequestingScrollIntoView The user index requesting the item to be scrolled into view.
Private variable TUniquePtr< UE::Slate::ItemsSource::IItemsSource< ItemType > > ViewSource Pointer to the source data that we are observing
Protected variable FWidgetGenerator WidgetGenerator A widget generator component

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page