FirstRunWizardPage Class Reference

Base class for a single step of FirstRunWizard. More...

#include <first_run_wizard_page.h>

Inheritance diagram for FirstRunWizardPage:

Collaboration diagram for FirstRunWizardPage:

Signals
void	completeChanged ()
void	advanceRequested ()

Public Member Functions
	FirstRunWizardPage (QWidget *parent=nullptr)
virtual void	initializePage ()
	Called every time the page becomes visible, including navigating back to it.
virtual bool	validatePage ()
	Called before advancing past this page. Return false to block navigation; the page itself is responsible for telling the user why.
virtual bool	isComplete () const
	Whether Next/Finish should currently be enabled. Pages doing async work can flip this mid-step; emit completeChanged() when they do.
virtual bool	isSkippable () const
	Whether the wizard's "Skip" button should be offered on this page.
virtual QString	stepTitle () const =0
virtual QString	stepSubtitle () const
virtual QString	nextButtonText () const
	Override to replace the "Next"/"Finish" button text on this page. Return an empty string to use the default label.
virtual bool	handleNextClick ()
	Called when the user presses the Next button. Return true to allow advancing to the next page, false to stay on this page (e.g. to trigger an async action first).
virtual void	retranslateUi ()=0

Detailed Description

Base class for a single step of FirstRunWizard.

QWidget-based rather than QWizardPage-based: FirstRunWizard is a QDialog + QStackedWidget shell (not a QWizard) so it can own the banner/step-dot chrome that QWizard's native styles don't give us consistent control over. Naming mirrors OracleWizardPage for familiarity only – the two hierarchies are unrelated.

Constructor & Destructor Documentation

FirstRunWizardPage()

FirstRunWizardPage::FirstRunWizardPage ( QWidget * parent = nullptr )

inlineexplicit

Here is the caller graph for this function:

Member Function Documentation

advanceRequested

void FirstRunWizardPage::advanceRequested ( )

signal

Here is the caller graph for this function:

completeChanged

void FirstRunWizardPage::completeChanged ( )

signal

Here is the caller graph for this function:

handleNextClick()

virtual bool FirstRunWizardPage::handleNextClick ( )

inlinevirtual

Called when the user presses the Next button. Return true to allow advancing to the next page, false to stay on this page (e.g. to trigger an async action first).

Reimplemented in CardDatabaseSetupPage.

Here is the caller graph for this function:

initializePage()

virtual void FirstRunWizardPage::initializePage ( )

inlinevirtual

Called every time the page becomes visible, including navigating back to it.

Reimplemented in CardDatabaseSetupPage, PreferencesSetupPage, and ThemeSetupPage.

isComplete()

virtual bool FirstRunWizardPage::isComplete ( ) const

inlinevirtual

Whether Next/Finish should currently be enabled. Pages doing async work can flip this mid-step; emit completeChanged() when they do.

Reimplemented in CardDatabaseSetupPage.

Here is the caller graph for this function:

isSkippable()

virtual bool FirstRunWizardPage::isSkippable ( ) const

inlinevirtual

Whether the wizard's "Skip" button should be offered on this page.

Reimplemented in AccountSetupPage, CardDatabaseSetupPage, PreferencesSetupPage, and ThemeSetupPage.

Here is the caller graph for this function:

nextButtonText()

virtual QString FirstRunWizardPage::nextButtonText ( ) const

inlinevirtual

Override to replace the "Next"/"Finish" button text on this page. Return an empty string to use the default label.

Reimplemented in CardDatabaseSetupPage.

Here is the caller graph for this function:

retranslateUi()

virtual void FirstRunWizardPage::retranslateUi ( )

pure virtual

Implemented in AccountSetupPage, CardDatabaseSetupPage, FinishPage, PreferencesSetupPage, ThemeSetupPage, and WelcomePage.

stepSubtitle()

virtual QString FirstRunWizardPage::stepSubtitle ( ) const

inlinevirtual

Reimplemented in AccountSetupPage, CardDatabaseSetupPage, PreferencesSetupPage, and ThemeSetupPage.

stepTitle()

virtual QString FirstRunWizardPage::stepTitle ( ) const

pure virtual

Implemented in AccountSetupPage, CardDatabaseSetupPage, FinishPage, PreferencesSetupPage, ThemeSetupPage, and WelcomePage.

validatePage()

virtual bool FirstRunWizardPage::validatePage ( )

inlinevirtual

Called before advancing past this page. Return false to block navigation; the page itself is responsible for telling the user why.

Reimplemented in ThemeSetupPage.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• cockatrice/src/interface/widgets/onboarding/first_run_wizard_page.h