FArguments

Windows
MacOS
Linux

Inheritance Hierarchy

TSlateBaseNamedArgs

SWizard::FArguments

References

Module

AppFramework

Header

/Engine/Source/Runtime/AppFramework/Public/Widgets/Workflow/SWizard.h

Include

#include "Widgets/Workflow/SWizard.h"

Syntax

struct FArguments : public TSlateBaseNamedArgs< SWizard >

Constructors

Name Description

Public function

FArguments()

Functions

Name Description

Public function

WidgetArgsTy...

 

BreadcrumbButtonStyle

(
    const FButtonStyle* InArg
)

The button style to use for each breadcrumb if ShowBreadcrumbs is set to true.

Public function

WidgetArgsTy...

 

BreadcrumbTextStyle

(
    const FTextBlockStyle* InArg
)

The text style to use for breadcrumbs if ShowBreadcrumbs is set to true.

Public function

WidgetArgsTy...

 

ButtonStyle

(
    const FButtonStyle* InArg
)

The button style used by next and back.

Public function

WidgetArgsTy...

 

ButtonTextStyle

(
    const FTextBlockStyle* InArg
)

The text style used by the buttons.

Public function

WidgetArgsTy...

 

CancelButtonStyle

(
    const FButtonStyle* InArg
)

The button style used by the cancel button.

Public function

WidgetArgsTy...

 

CanFinish

(
    const TAttribute< bool >& InAttrib...
)

Holds a flag indicating whether the 'Finish' button is enabled.

Public function

WidgetArgsTy...

 

DesiredSize

(
    const TAttribute< FVector2D >& InA...
)

Holds the desired size.

Public function

WidgetArgsTy...

 

FinishButtonStyle

(
    const FButtonStyle* InArg
)

The button style used by the finish button.

Public function

WidgetArgsTy...

 

FinishButtonText

(
    const TAttribute< FText >& InAttri...
)

Holds the label text of the wizard's 'Finish' button.

Public function

WidgetArgsTy...

 

FinishButtonToolTip

(
    const TAttribute< FText >& InAttri...
)

Holds the tool tip text of the wizard's 'Finish' button.

Public function

WidgetArgsTy...

 

ForegroundColor

(
    FSlateColor InArg
)

The text style used by the buttons.

Public function

WidgetArgsTy...

 

InitialPageIndex

(
    const TAttribute< int32 >& InAttri...
)

Holds the index of the initial page to be displayed (0 = default).

Public function

WidgetArgsTy...

 

OnCanceled

(
    const FSimpleDelegate& InDelegate
)

Exposes a delegate to be invoked when the wizard is canceled.

Public function

WidgetArgsTy...

 

OnFinished

(
    const FSimpleDelegate& InDelegate
)

Exposes a delegate to be invoked when the wizard is finished.

Public function

WidgetArgsTy...

 

OnFirstPageBackClicked

(
    const FOnClicked& InDelegate
)

Exposes a delegate to be invoked when the wizard's 'Back' button is clicked.

Public function

WidgetArgsTy...

 

OnGetNextPageIndex

(
    const FOnGetPageIndex& InDelegate
)

Exposes a delegate to be invoked when the wizard's 'Next' button is clicked.

Public function

NamedSlotPro...

 

PageFooter()

Holds an optional widget containing the contents to place above the buttons for all wizard pages

Public function

WidgetArgsTy...

 

PageTitleTextStyle

(
    const FTextBlockStyle* InArg
)

The text style to use for showing the page title if ShowPageTitle is set to true.

Public function

WidgetArgsTy...

 

ShowBreadcrumbs

(
    bool InArg
)

Holds a flag indicating whether a breadcrumb trail should be shown (default = false)

Public function

WidgetArgsTy...

 

ShowCancelButton

(
    bool InArg
)

Holds a flag indicating whether the cancel button should be shown (default = true).

Public function

WidgetArgsTy...

 

ShowPageList

(
    bool InArg
)

Holds a flag indicating whether the page list should be shown (default = true).

Public function

WidgetArgsTy...

 

ShowPageTitle

(
    bool InArg
)

Holds a flag indicating whether a page title should be shown for each page (default = false)

Operators

Name Description

Public function

WidgetArgsTy...

 

operator+

(
    FWizardPage::FArguments& Arguments...
)

Typedefs

Name

Description

WidgetArgsType

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