SHeaderRow

The header that appears above lists and trees when they are showing multiple columns.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Views/SHeaderRow.h

Include

#include "Widgets/Views/SHeaderRow.h"

Syntax

class SHeaderRow : public SBorder

Remarks

The header that appears above lists and trees when they are showing multiple columns.

Functions

Name Description

Public function

void

 

AddColumn

(
    FColumn & NewColumn
)

Adds a column to the header

Public function

void

 

AddColumn

(
    const FColumn::FArguments & NewColu...
)

Adds a column to the header

Public function

void

 

ClearColumns()

Removes all columns from the header

Public function Static

FColumn::FAr ...

 

Column

(
    const FName & InColumnId
)

Create a column with the specified ColumnId

Public function

void

 

Construct

(
    const FArguments & InArgs
)

Public function Const

const TIndir ...

 

GetColumns()

Public function Const

TArray < FNam ...

 

GetHiddenColumnIds()

Public function Const

FVector2D

 

GetRowSizeForSlotIndex

(
    int32 SlotIndex
)

Will return the size for this row at the specified slot index

Public function

void

 

InsertColumn

(
    const FColumn::FArguments & NewColu...,
    int32 InsertIdx
)

Inserts a column at the specified index in the header

Public function

void

 

InsertColumn

(
    FColumn & NewColumn,
    int32 InsertIdx
)

Inserts a column at the specified index in the header

Public function Const

bool

 

IsColumnGenerated

(
    const FName & InColumnId
)

Public function

FColumnsChan ...

 

OnColumnsChanged()

Public function

void

 

RefreshColumns()

Force refreshing of the column widgets

Public function

void

 

RemoveColumn

(
    const FName & InColumnId
)

Removes a column from the header

Public function

void

 

ResetColumnWidths()

Restore the columns to their original width

Public function

void

 

SetAssociatedVerticalScrollBar

(
    const TSharedRef < SScrollBar >& Sc...,
    const float ScrollBarSize
)

Public function

void

 

SetColumnWidth

(
    const FName & InColumnId,
    float InWidth
)

Sets the column, with the specified name, to the desired width

Public function

void

 

SetOnGetMaxRowSizeForColumn

(
    const FOnGetMaxRowSizeForColumn & D...
)

Simple function to set the delegate to fetch the max row size for column id

Public function Const

bool

 

ShouldGeneratedColumn

(
    const FName & InColumnId
)

Overridden from SWidget

Name Description

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.

Classes

Name

Description

Public struct

FArguments

Public class

FColumn

Describes a single column header

Public class

FColumnsChanged

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback