SWizard

Implements a wizard widget.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AppFramework

Header

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

Include

#include "Widgets/Workflow/SWizard.h"

Syntax

class SWizard : public SCompoundWidget

Remarks

Implements a wizard widget.

Functions

Name Description

Public function

void

 

AdvanceToPage

(
    int32 PageIndex
)

Shows the page with the specified index, but preserves page history.

Public function Const

bool

 

CanShowPage

(
    int32 PageIndex
)

Checks whether the page with the specified index can be shown.

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct this widget.

Public function Const

int32

 

GetCurrentPageIndex()

Get the index of the current page.

Public function Const

int32

 

GetNumPages()

Gets the number of pages that this wizard contains.

Public function Const

int32

 

GetPageIndex

(
    const TSharedPtr< SWidget >& PageW...
)

Gets the index of the specified wizard page widget.

Public function Static

FWizardPage:...

 

Page()

Returns a new slot for a page.

Public function

void

 

ShowPage

(
    int32 PageIndex
)

Attempts to show the page with the specified index.

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Classes

Name

Description

Public struct

FArguments

Public class

FWizardPage

Implements a wizard page.

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