Navigation
API > API/Runtime > API/Runtime/Slate
A breadcrumb trail. Allows the user to see their currently selected path and navigate upwards.
| Name | SBreadcrumbTrail |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Navigation/SBreadcrumbTrail.h |
| Include Path | #include "Widgets/Navigation/SBreadcrumbTrail.h" |
Syntax
template<typename ItemType>
class SBreadcrumbTrail : public SBreadcrumbTrailBase
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SBreadcrumbTrailBase → SBreadcrumbTrail
- FSlateControlledConstruction → SWidget → SCompoundWidget → SBreadcrumbTrailBase → SBreadcrumbTrail
- SBreadcrumbTrail
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FCrumbItem | A container for data associated with a single crumb in the trail. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetCrumbButtonContent | TBaseDelegate_TwoParams< TSharedRef< SWidget >, const ItemType &, const FTextBlockStyle *InTextStyle > | Callback for customizing the crumb button content | Widgets/Navigation/SBreadcrumbTrail.h |
| FGetCrumbMenuContent | TBaseDelegate_OneParam< TSharedRef< SWidget >, const ItemType & > | Callback for getting the menu content to be displayed when clicking on a crumb's delimiter arrow | Widgets/Navigation/SBreadcrumbTrail.h |
| FHasCrumbMenuContent | TBaseDelegate_OneParam< bool, const ItemType & > | Callback for checking whether the menu to be displayed when clicking on a crumb's delimiter arrow would have any content | Widgets/Navigation/SBreadcrumbTrail.h |
| FOnCrumbClicked | TBaseDelegate_OneParam< void, const ItemType & > | Callback for when a crumb in the trail has been clicked | Widgets/Navigation/SBreadcrumbTrail.h |
| FOnCrumbPopped | TBaseDelegate_OneParam< void, const ItemType & > | Callback for when a crumb has been popped off the trail | Widgets/Navigation/SBreadcrumbTrail.h |
| FOnCrumbPushed | TBaseDelegate_OneParam< void, const ItemType & > | Callback for when a crumb has been pushed on the trail | Widgets/Navigation/SBreadcrumbTrail.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasStaticBreadcrumbs | bool | If true, don't dynamically remove items when clicking | Widgets/Navigation/SBreadcrumbTrail.h | |
| ButtonContentPadding | TAttribute< FMargin > | The padding for the content in crumb buttons | Widgets/Navigation/SBreadcrumbTrail.h | |
| ButtonStyle | const FButtonStyle * | The button style to apply to all crumbs | Widgets/Navigation/SBreadcrumbTrail.h | |
| CrumbList | TArray< FCrumbItem > | The list of crumbs and their data | Widgets/Navigation/SBreadcrumbTrail.h | |
| DelimiterImage | TAttribute< const FSlateBrush * > | The image to display between crumb trail buttons | Widgets/Navigation/SBreadcrumbTrail.h | |
| GetCrumbButtonContentCallback | FGetCrumbButtonContent | Delegate to invoke to retrieve content a crumb's SButton | Widgets/Navigation/SBreadcrumbTrail.h | |
| GetCrumbMenuContentCallback | FGetCrumbMenuContent | Delegate to invoke to retrieve the content for a crumb's menu | Widgets/Navigation/SBreadcrumbTrail.h | |
| HasCrumbMenuContentCallback | FHasCrumbMenuContent | Delegate to invoke to check whether the crumb's menu would have any content | Widgets/Navigation/SBreadcrumbTrail.h | |
| NextValidCrumbID | int32 | The next ID to assign to a crumb when it is created | Widgets/Navigation/SBreadcrumbTrail.h | |
| OnCrumbClicked | FOnCrumbClicked | Delegate to invoke when selection changes. | Widgets/Navigation/SBreadcrumbTrail.h | |
| OnCrumbPopped | FOnCrumbPopped | Delegate to invoke when a crumb is popped. | Widgets/Navigation/SBreadcrumbTrail.h | |
| OnCrumbPushed | FOnCrumbPushed | Delegate to invoke when a crumb is pushed. | Widgets/Navigation/SBreadcrumbTrail.h | |
| ShowLeadingDelimiter | TAttribute< bool > | If true, a leading delimiter will be added | Widgets/Navigation/SBreadcrumbTrail.h | |
| TextStyle | const FTextBlockStyle * | The text style to apply to all crumbs | Widgets/Navigation/SBreadcrumbTrail.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearCrumbs
(
bool bPopAllCrumbsToClear |
Removes all crumbs from the crumb box | Widgets/Navigation/SBreadcrumbTrail.h | |
void Construct
(
const FArguments& InArgs |
Constructs this widget with InArgs | Widgets/Navigation/SBreadcrumbTrail.h | |
void GetAllCrumbData
(
TArray< ItemType >& CrumbData |
Gets all the crumb data in the trail | Widgets/Navigation/SBreadcrumbTrail.h | |
bool HasCrumbs() |
Returns true if there are any crumbs in the trail. | Widgets/Navigation/SBreadcrumbTrail.h | |
int32 NumCrumbs() |
Returns the number of crumbs in the trail. | Widgets/Navigation/SBreadcrumbTrail.h | |
ItemType PeekCrumb() |
Peeks at the end crumb in the trail. Returns the crumb data. | Widgets/Navigation/SBreadcrumbTrail.h | |
ItemType PopCrumb() |
Pops a crumb off the end of the trail. Returns the crumb data. | Widgets/Navigation/SBreadcrumbTrail.h | |
void PushCrumb
(
const TAttribute< FText >& CrumbText, |
Adds a crumb to the end of the trail. | Widgets/Navigation/SBreadcrumbTrail.h |