Navigation
API > API/Runtime > API/Runtime/AppFramework
Implements a wizard widget.
| Name | SWizard |
| Type | class |
| Header File | /Engine/Source/Runtime/AppFramework/Public/Widgets/Workflow/SWizard.h |
| Include Path | #include "Widgets/Workflow/SWizard.h" |
Syntax
class SWizard : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SWizard
- FSlateControlledConstruction → SWidget → SCompoundWidget → SWizard
Derived Classes
Classes
| Name | Remarks |
|---|---|
| FWizardPage | Implements a wizard page. |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BreadcrumbTrail | TSharedPtr< SBreadcrumbTrail< int32 > > | Holds the breadcrumb trail. | Widgets/Workflow/SWizard.h | |
| DesiredSize | FVector2D | Holds the wizard's desired size. | Widgets/Workflow/SWizard.h | |
| OnCanceled | FSimpleDelegate | Holds a delegate to be invoked when the 'Cancel' button has been clicked. | Widgets/Workflow/SWizard.h | |
| OnFinished | FSimpleDelegate | Holds a delegate to be invoked when the 'Finish' button has been clicked. | Widgets/Workflow/SWizard.h | |
| OnFirstPageBackClicked | FOnClicked | Holds a delegate to be invoked when the 'Previous' button has been clicked on the first page. | Widgets/Workflow/SWizard.h | |
| OnGetNextPageIndex | FOnGetPageIndex | Exposes a delegate to be invoked to control whether the 'Next' button is enabled, and where to attempt to move to if it is clicked. | Widgets/Workflow/SWizard.h | |
| OnNextClicked | FOnClicked | Holds a delegate to be invoked when the 'Next' button has been clicked. | Widgets/Workflow/SWizard.h | |
| OnPrevClicked | FOnClicked | Holds a delegate to be invoked when the 'Previous' button has been clicked. | Widgets/Workflow/SWizard.h | |
| OnTryToMoveToPage | FOnGetPageIndex | Exposes a delegate to be invoked when the wizard's 'Next' button is clicked to allow redirection to another page if processing fails. | Widgets/Workflow/SWizard.h | |
| Pages | TIndirectArray< FWizardPage > | Holds the collection of wizard pages. | Widgets/Workflow/SWizard.h | |
| WidgetSwitcher | TSharedPtr< SWidgetSwitcher > | Holds the widget switcher. | Widgets/Workflow/SWizard.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdvanceToPage
(
int32 PageIndex |
Shows the page with the specified index, but preserves page history. | Widgets/Workflow/SWizard.h | |
bool CanShowPage
(
int32 PageIndex |
Checks whether the page with the specified index can be shown. | Widgets/Workflow/SWizard.h | |
void Construct
(
const FArguments& InArgs |
Construct this widget. | Widgets/Workflow/SWizard.h | |
int32 GetCurrentPageIndex() |
Get the index of the current page. | Widgets/Workflow/SWizard.h | |
int32 GetNumPages() |
Gets the number of pages that this wizard contains. | Widgets/Workflow/SWizard.h | |
int32 GetPageIndex
(
const TSharedPtr< SWidget >& PageWidget |
Gets the index of the specified wizard page widget. | Widgets/Workflow/SWizard.h | |
void ShowPage
(
int32 PageIndex |
Attempts to show the page with the specified index. | Widgets/Workflow/SWizard.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Workflow/SWizard.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FWizardPage::FArguments Page() |
Returns a new slot for a page. | Widgets/Workflow/SWizard.h |