Navigation
API > API/Runtime > API/Runtime/AppFramework > API/Runtime/AppFramework/SWizard
| Name | FArguments |
| Type | struct |
| Header File | /Engine/Source/Runtime/AppFramework/Public/Widgets/Workflow/SWizard.h |
| Include Path | #include "Widgets/Workflow/SWizard.h" |
Syntax
struct FArguments : public TSlateBaseNamedArgs< SWizard >
Inheritance Hierarchy
- FSlateBaseNamedArgs → TSlateBaseNamedArgs → SWizard::FArguments
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FArguments() |
Widgets/Workflow/SWizard.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| WidgetArgsType | FArguments | Widgets/Workflow/SWizard.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & BreadcrumbButtonStyle
(
const FButtonStyle* InArg |
The button style to use for each breadcrumb if ShowBreadcrumbs is set to true. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & BreadcrumbTextStyle
(
const FTextBlockStyle* InArg |
The text style to use for breadcrumbs if ShowBreadcrumbs is set to true. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ButtonStyle
(
const FButtonStyle* InArg |
The button style used by next and back. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ButtonTextStyle
(
const FTextBlockStyle* InArg |
The text style used by the buttons. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & CancelButtonStyle
(
const FButtonStyle* InArg |
The button style used by the cancel button. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & CanFinish
(
const TAttribute< bool >& InAttribute |
Holds a flag indicating whether the 'Finish' button is enabled. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & DesiredSize
(
const TAttribute< FVector2D >& InAttribute |
Holds the desired size. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & FinishButtonStyle
(
const FButtonStyle* InArg |
The button style used by the finish button. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & FinishButtonText
(
const TAttribute< FText >& InAttribute |
Holds the label text of the wizard's 'Finish' button. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & FinishButtonToolTip
(
const TAttribute< FText >& InAttribute |
Holds the tool tip text of the wizard's 'Finish' button. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & InitialPageIndex
(
const TAttribute< int32 >& InAttribute |
Holds the index of the initial page to be displayed (0 = default). | Widgets/Workflow/SWizard.h | |
WidgetArgsType & OnCanceled
(
const FSimpleDelegate& InDelegate |
Exposes a delegate to be invoked when the wizard is canceled. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & OnFinished
(
const FSimpleDelegate& InDelegate |
Exposes a delegate to be invoked when the wizard is finished. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & OnFirstPageBackClicked
(
const FOnClicked& InDelegate |
Exposes a delegate to be invoked when the wizard's 'Back' button is clicked. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & OnGetNextPageIndex
(
const FOnGetPageIndex& InDelegate |
Exposes a delegate to be invoked to control whether the wizard's 'Next' button should be active, and which page should be next if it is clicked. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & OnTryToMoveToPage
(
const FOnGetPageIndex& InDelegate |
Exposes a delegate to be invoked when the wizard tries to move to new next page e.g. when 'Next' is pressed. | Widgets/Workflow/SWizard.h | |
NamedSlotProperty< FArguments > PageFooter() |
Holds an optional widget containing the contents to place above the buttons for all wizard pages | Widgets/Workflow/SWizard.h | |
WidgetArgsType & PageTitleTextStyle
(
const FTextBlockStyle* InArg |
The text style to use for showing the page title if ShowPageTitle is set to true. | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ShowBreadcrumbs
(
bool InArg |
Holds a flag indicating whether a breadcrumb trail should be shown (default = false) | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ShowCancelButton
(
bool InArg |
Holds a flag indicating whether the cancel button should be shown (default = true). | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ShowHistoryButtons
(
bool InArg |
Holds a flag indicating whether the previous and next buttons can be shown (default = true) | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ShowPageList
(
bool InArg |
Holds a flag indicating whether the page list should be shown (default = true). | Widgets/Workflow/SWizard.h | |
WidgetArgsType & ShowPageTitle
(
bool InArg |
Holds a flag indicating whether a page title should be shown for each page (default = false) | Widgets/Workflow/SWizard.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
WidgetArgsType & operator+
(
FWizardPage::FArguments& ArgumentsForNewSlot |
Widgets/Workflow/SWizard.h |