SWizard.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "SlateFwd.h"
#include "Containers/IndirectArray.h"
#include "Misc/Attribute.h"
#include "Layout/Visibility.h"
#include "Styling/SlateColor.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Input/Reply.h"
#include "Widgets/SWidget.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/Navigation/SBreadcrumbTrail.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
#include "Styling/AppStyle.h"
 
DECLARE_DELEGATE_RetVal_OneParam(int32, FOnGetPageIndex, int32)
 
 
class SWizard
    : public SCompoundWidget
{
public:
 
    class FWizardPage
    {
    public:
 
        SLATE_BEGIN_ARGS(FWizardPage)
            : _ButtonContent()
            , _CanShow(true)
            , _PageContent()
        { }
 
            SLATE_NAMED_SLOT(FArguments, ButtonContent)
            
            
            SLATE_ATTRIBUTE(FText, Name)
 
            
            SLATE_ATTRIBUTE(bool, CanShow)
 
            
            SLATE_EVENT(FSimpleDelegate, OnEnter)
 
            
            SLATE_EVENT(FSimpleDelegate, OnLeave)
 
            
            SLATE_DEFAULT_SLOT(FArguments, PageContent)
 
        SLATE_END_ARGS()
 
    public:
 
        FWizardPage( const FArguments& InArgs )
            : ButtonContent(InArgs._ButtonContent)
            , Showable(InArgs._CanShow)
            , OnEnterDelegate(InArgs._OnEnter)
            , OnLeaveDelegate(InArgs._OnLeave)
            , PageContent(InArgs._PageContent)
            , Name(InArgs._Name)
        { }
 
    public:
 
        bool CanShow() const
        {
            return Showable.Get();
        }
 
        FText GetName() const
        {
            return Name.Get();
        }
 
        const TSharedRef<SWidget>& GetButtonContent() const
        {
            return ButtonContent.Widget;
        }
 
        const TSharedRef<SWidget>& GetPageContent() const
        {
            return PageContent.Widget;
        }
 
        FSimpleDelegate& OnEnter()
        {
            return OnEnterDelegate;
        }
 
        FSimpleDelegate& OnLeave()
        {
            return OnLeaveDelegate;
        }
 
    private:
 
        // Holds the button content.
        TAlwaysValidWidget ButtonContent;
 
        // Holds a flag indicating whether this page can be activated.
        TAttribute<bool> Showable;
 
        // Holds a delegate to be invoked when the page is activated.
        FSimpleDelegate OnEnterDelegate;
 
        // Holds a delegate to be invoked when the page is deactivated.
        FSimpleDelegate OnLeaveDelegate;
 
        // Holds the page content.
        TAlwaysValidWidget PageContent;
 
        // Holds the name of the page.
        TAttribute<FText> Name;
    };
 
public:
 
    SLATE_BEGIN_ARGS(SWizard)
        : _ButtonStyle(&FAppStyle::Get().GetWidgetStyle<FButtonStyle>("Button"))
        , _CancelButtonStyle(&FAppStyle::Get().GetWidgetStyle<FButtonStyle>("Button"))
        , _FinishButtonStyle(&FAppStyle::Get().GetWidgetStyle<FButtonStyle>("PrimaryButton"))
        , _ButtonTextStyle(&FAppStyle::Get().GetWidgetStyle<FTextBlockStyle>("DialogButtonText"))
        , _CanFinish(true)
        , _FinishButtonText(NSLOCTEXT("SWizard", "DefaultFinishButtonText", "Finish"))
        , _FinishButtonToolTip(NSLOCTEXT("SWizard", "DefaultFinishButtonTooltip", "Finish the wizard"))
        , _InitialPageIndex(0)
        , _DesiredSize(FVector2D(0, 0))
        , _ShowPageList(true)
        , _ShowCancelButton(true)
        , _ShowBreadcrumbs(false)
        , _BreadcrumbButtonStyle(&FCoreStyle::Get().GetWidgetStyle< FButtonStyle >("BreadcrumbButton"))
        , _BreadcrumbTextStyle(&FCoreStyle::Get().GetWidgetStyle< FTextBlockStyle >("NormalText"))
        , _ShowHistoryButtons(true)
        , _ShowPageTitle(false)
        , _PageTitleTextStyle(&FCoreStyle::Get().GetWidgetStyle< FTextBlockStyle >("Wizard.PageTitle"))
        , _PageFooter()
    { }
 
    SLATE_SUPPORTS_SLOT_WITH_ARGS(FWizardPage)
 
        
        SLATE_STYLE_ARGUMENT(FButtonStyle, ButtonStyle)
 
        
        SLATE_STYLE_ARGUMENT(FButtonStyle, CancelButtonStyle)
 
        
        SLATE_STYLE_ARGUMENT(FButtonStyle, FinishButtonStyle)
 
        
        SLATE_STYLE_ARGUMENT(FTextBlockStyle, ButtonTextStyle)
 
        
        SLATE_ATTRIBUTE(bool, CanFinish)
 
        
        SLATE_ATTRIBUTE(FText, FinishButtonText)
 
        
        SLATE_ATTRIBUTE(FText, FinishButtonToolTip)
 
        
        SLATE_ATTRIBUTE(int32, InitialPageIndex)
 
        
        SLATE_ATTRIBUTE(FVector2D, DesiredSize)
 
        
        SLATE_EVENT(FSimpleDelegate, OnCanceled)
 
        
        SLATE_EVENT(FSimpleDelegate, OnFinished)
 
        
        SLATE_EVENT(FOnClicked, OnFirstPageBackClicked)
 
        
        SLATE_EVENT(FOnGetPageIndex, OnGetNextPageIndex)
 
        
        SLATE_EVENT(FOnGetPageIndex, OnTryToMoveToPage)
 
        
        SLATE_ARGUMENT(bool, ShowPageList)
 
        
        SLATE_ARGUMENT(bool, ShowCancelButton)
 
        
        SLATE_ARGUMENT(bool, ShowBreadcrumbs)
 
        
        SLATE_STYLE_ARGUMENT(FButtonStyle, BreadcrumbButtonStyle);
 
        SLATE_STYLE_ARGUMENT(FTextBlockStyle, BreadcrumbTextStyle);
 
        SLATE_ARGUMENT(bool, ShowHistoryButtons)
 
        
        SLATE_ARGUMENT(bool, ShowPageTitle)
 
        
        SLATE_STYLE_ARGUMENT(FTextBlockStyle, PageTitleTextStyle);
 
        SLATE_NAMED_SLOT(FArguments, PageFooter)
 
    SLATE_END_ARGS()
 
public:
 
    APPFRAMEWORK_API bool CanShowPage( int32 PageIndex ) const;
 
    APPFRAMEWORK_API void Construct( const FArguments& InArgs );
 
    APPFRAMEWORK_API int32 GetNumPages() const;
 
    APPFRAMEWORK_API int32 GetCurrentPageIndex() const;
 
    APPFRAMEWORK_API int32 GetPageIndex( const TSharedPtr<SWidget>& PageWidget ) const;
 
    APPFRAMEWORK_API void ShowPage( int32 PageIndex );
 
    APPFRAMEWORK_API void AdvanceToPage( int32 PageIndex );
 
    APPFRAMEWORK_API TSharedPtr<SWidget> GetWidgetToFocusOnActivate();
 
public:
 
    // SCompoundWidget interface
 
    APPFRAMEWORK_API virtual FVector2D ComputeDesiredSize(float) const override;
 
public:
 
    static FWizardPage::FArguments Page()
    {
        FWizardPage::FArguments Args;
        return Args;
    }
 
private:
 
    // Callback for clicking the 'Cancel' button.
    APPFRAMEWORK_API FReply HandleCancelButtonClicked();
 
    // Callback for clicking the 'Launch' button.
    APPFRAMEWORK_API FReply HandleFinishButtonClicked();
 
    // Callback for clicking the 'Next' button.
    APPFRAMEWORK_API FReply HandleNextButtonClicked();
 
    // Callback for getting the enabled state of the 'Next' button.
    APPFRAMEWORK_API bool HandleNextButtonIsEnabled() const;
 
    // Callback for getting the visibility of the 'Next' button.
    APPFRAMEWORK_API EVisibility HandleNextButtonVisibility() const;
 
    // Callback for getting the checked state of a page button.
    APPFRAMEWORK_API void HandlePageButtonCheckStateChanged( ECheckBoxState NewState, int32 PageIndex );
 
    // Callback for clicking a page button.
    APPFRAMEWORK_API ECheckBoxState HandlePageButtonIsChecked( int32 PageIndex ) const;
 
    // Callback for getting the enabled state of a page button.
    APPFRAMEWORK_API bool HandlePageButtonIsEnabled( int32 PageIndex ) const;
 
    // Callback for clicking the 'Previous' button.
    APPFRAMEWORK_API FReply HandlePrevButtonClicked();
 
    // Callback for getting the enabled state of the 'Previous' button.
    APPFRAMEWORK_API bool HandlePrevButtonIsEnabled() const;
 
    // Callback for getting the visibility of the 'Previous' button.
    APPFRAMEWORK_API EVisibility HandlePrevButtonVisibility() const;
 
    // Callback for when a breadcrumb is clicked.
    APPFRAMEWORK_API void HandleBreadcrumbClicked(const int32& PageIndex);
 
    // Get the next page index to display.
    APPFRAMEWORK_API int32 GetNextPageIndex() const;
 
    // Get the previous page index to display.
    APPFRAMEWORK_API int32 GetPrevPageIndex() const;
 
    // Get the page title to display for the current page.
    APPFRAMEWORK_API FText HandleGetPageTitle() const;
 
private:
 
    // Holds the wizard's desired size.
    FVector2D DesiredSize;
 
    // Holds the collection of wizard pages.
    TIndirectArray<FWizardPage> Pages;
 
    // Holds the widget switcher.
    TSharedPtr<SWidgetSwitcher> WidgetSwitcher;
 
    // Holds the breadcrumb trail.
    TSharedPtr<SBreadcrumbTrail<int32>> BreadcrumbTrail;
 
    // Whether to show the "Previous" and "Next" buttons
    bool bShowHistoryButtons;
 
    TSharedPtr<SWidget> FinishButton;
 
private:
 
    // Holds a delegate to be invoked when the 'Cancel' button has been clicked.
    FSimpleDelegate OnCanceled;
 
    // Holds a delegate to be invoked when the 'Finish' button has been clicked.
    FSimpleDelegate OnFinished;
 
    // Holds a delegate to be invoked when the 'Next' button has been clicked.
    FOnClicked OnNextClicked;
 
    // Holds a delegate to be invoked when the 'Previous' button has been clicked.
    FOnClicked OnPrevClicked;
 
    // Holds a delegate to be invoked when the 'Previous' button has been clicked on the first page.
    FOnClicked OnFirstPageBackClicked;
 
    // 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.
    FOnGetPageIndex OnGetNextPageIndex;
 
    // Exposes a delegate to be invoked when the wizard's 'Next' button is clicked to allow redirection to another page if processing fails
    FOnGetPageIndex OnTryToMoveToPage;
};