SBreadcrumbTrail

A breadcrumb trail. Allows the user to see their currently selected path and navigate upwards.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/SlateFwd.h

Include

#include "SlateFwd.h"

Syntax

template<typename ItemType>
class SBreadcrumbTrail : public SCompoundWidget

Remarks

A breadcrumb trail. Allows the user to see their currently selected path and navigate upwards.

Functions

Name Description

Public function

void

 

ClearCrumbs

(
    bool bPopAllCrumbsToClear
)

Removes all crumbs from the crumb box

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Constructs this widget with InArgs

Public function Const

void

 

GetAllCrumbData

(
    TArray< ItemType >& CrumbData
)

Gets all the crumb data in the trail

Public function Const

bool

 

HasCrumbs()

Returns true if there are any crumbs in the trail.

Public function Const

int32

 

NumCrumbs()

Returns the number of crumbs in the trail.

Public function Const

ItemType

 

PeekCrumb()

Peeks at the end crumb in the trail. Returns the crumb data.

Public function

ItemType

 

PopCrumb()

Pops a crumb off the end of the trail. Returns the crumb data.

Public function

void

 

PushCrumb

(
    const TAttribute< FText >& CrumbTe...,
    const ItemType& NewCrumbData
)

Adds a crumb to the end of the trail.

Classes

Name

Description

Public struct

FArguments

Typedefs

Name

Description

FGetCrumbMenuContent

Callback for getting the menu content to be displayed when clicking on a crumb's delimiter arrow

FHasCrumbMenuContent

Callback for checking whether the menu to be displayed when clicking on a crumb's delimiter arrow would have any content

FOnCrumbClicked

Callback for when a crumb in the trail has been clicked

FOnCrumbPopped

Callback for when a crumb has been popped off the trail

FOnCrumbPushed

Callback for when a crumb has been pushed on the trail

FOnGetCrumbColor
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss