Navigation
API > API/Runtime > API/Runtime/Slate
The header that appears above lists and trees when they are showing multiple columns.
| Name | SHeaderRow |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Views/SHeaderRow.h |
| Include Path | #include "Widgets/Views/SHeaderRow.h" |
Syntax
class SHeaderRow : public SBorder
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBorder → SHeaderRow
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBorder → SHeaderRow
Classes
| Name | Remarks |
|---|---|
| FColumn | Describes a single column header |
| FColumnsChanged |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCanSelectGeneratedColumn | bool | Widgets/Views/SHeaderRow.h | ||
| Columns | TIndirectArray< FColumn > | Information about the various columns | Widgets/Views/SHeaderRow.h | |
| ColumnsChanged | FColumnsChanged | Widgets/Views/SHeaderRow.h | ||
| HeaderWidgets | TArray< TSharedPtr< class STableColumnHeader > > | Widgets/Views/SHeaderRow.h | ||
| OnGetMaxRowSizeForColumn | FOnGetMaxRowSizeForColumn | Widgets/Views/SHeaderRow.h | ||
| OnHiddenColumnsListChanged | FSimpleDelegate | Widgets/Views/SHeaderRow.h | ||
| ResizeMode | ESplitterResizeMode::Type | Widgets/Views/SHeaderRow.h | ||
| ScrollBarThickness | FVector2f | Widgets/Views/SHeaderRow.h | ||
| ScrollBarVisibility | TAttribute< EVisibility > | Widgets/Views/SHeaderRow.h | ||
| SplitterHandleSize | float | Widgets/Views/SHeaderRow.h | ||
| Style | const FHeaderRowStyle * | Widgets/Views/SHeaderRow.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Widgets/Views/SHeaderRow.h | |||
void AddColumn
(
const FColumn::FArguments& NewColumnArgs |
Adds a column to the header | Widgets/Views/SHeaderRow.h | |
void ClearColumns() |
Removes all columns from the header | Widgets/Views/SHeaderRow.h | |
void Construct
(
const FArguments& InArgs |
Widgets/Views/SHeaderRow.h | ||
const TIndirectArray< FColumn > & GetColumns() |
Widgets/Views/SHeaderRow.h | ||
| Widgets/Views/SHeaderRow.h | |||
FVector2D GetRowSizeForSlotIndex
(
int32 SlotIndex |
Will return the size for this row at the specified slot index | Widgets/Views/SHeaderRow.h | |
void InsertColumn
(
const FColumn::FArguments& NewColumnArgs, |
Inserts a column at the specified index in the header | Widgets/Views/SHeaderRow.h | |
void InsertColumn
(
FColumn& NewColumn, |
Widgets/Views/SHeaderRow.h | ||
bool IsColumnGenerated
(
const FName& InColumnId |
Widgets/Views/SHeaderRow.h | ||
bool IsColumnVisible
(
const FName& InColumnId |
Widgets/Views/SHeaderRow.h | ||
FColumnsChanged * OnColumnsChanged() |
Widgets/Views/SHeaderRow.h | ||
void RefreshColumns() |
Force refreshing of the column widgets | Widgets/Views/SHeaderRow.h | |
void RemoveColumn
(
const FName& InColumnId |
Removes a column from the header | Widgets/Views/SHeaderRow.h | |
void ResetColumnWidths() |
Restore the columns to their original width | Widgets/Views/SHeaderRow.h | |
void SetAssociatedVerticalScrollBar
(
const TSharedRef< SScrollBar >& ScrollBar, |
Widgets/Views/SHeaderRow.h | ||
void SetColumnWidth
(
const FName& InColumnId, |
Sets the column, with the specified name, to the desired width | Widgets/Views/SHeaderRow.h | |
void SetOnGetMaxRowSizeForColumn
(
const FOnGetMaxRowSizeForColumn& Delegate |
Simple function to set the delegate to fetch the max row size for column id | Widgets/Views/SHeaderRow.h | |
void SetShowGeneratedColumn
(
const FName& InColumnIdm, |
Show or Hide a generated column | Widgets/Views/SHeaderRow.h | |
bool ShouldGeneratedColumn
(
const FName& InColumnId |
Widgets/Views/SHeaderRow.h | ||
bool ShouldGenerateEmptyColumnForSpacing
(
const FName& InColumnId |
Widgets/Views/SHeaderRow.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Views/SHeaderRow.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FColumn::FArguments Column
(
const FName& InColumnId |
Create a column with the specified ColumnId | Widgets/Views/SHeaderRow.h |