Complex Wizard Example

The Title-, Evaluate-, Register-, Details-, and FinishPage Classes

The pages are defined in licensewizard.h and implemented in licensewizard.cpp, together with LicenseWizard.

Here's the definition and implementation of TitlePage:

    class TitlePage : public LicenseWizardPage
    {
    public:
        TitlePage(LicenseWizard *wizard);

        void resetPage();
        WizardPage *nextPage();

    private:
        QLabel *topLabel;
        QRadioButton *registerRadioButton;
        QRadioButton *evaluateRadioButton;
    };

We reimplement the resetPage() and nextPage() functions from WizardPage. For the other two virtual functions (isLastPage() and isComplete()), the default implementations suffice ("not the last page, always complete").

    TitlePage::TitlePage(LicenseWizard *wizard)
        : LicenseWizardPage(wizard)
    {
        topLabel = new QLabel(tr("<center><font color=\"blue\" size=\"5\"><b><i>"
                                 "Super Product One</i></b></font></center>"));

        registerRadioButton = new QRadioButton(tr("&Register your copy"));
        evaluateRadioButton = new QRadioButton(tr("&Evaluate our product"));
        setFocusProxy(registerRadioButton);

        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(topLabel);
        layout->addSpacing(10);
        layout->addWidget(registerRadioButton);
        layout->addWidget(evaluateRadioButton);
        layout->addStretch(1);
        setLayout(layout);
    }

The TitlePage constructor takes a LicenseWizard and passes it on to LicenseWizardPage, which stores it in its wizard member.

The constructor sets up the page. The QWidget::setFocusProxy() call ensures that whenever ComplexWizard calls setFocus() on the page, the Register your copy button gets the focus.

    void TitlePage::resetPage()

Resetting the TitlePage consists in checking the Evaluate our product option.

    {
        registerRadioButton->setChecked(true);
    }

    WizardPage *TitlePage::nextPage()
    {
        if (evaluateRadioButton->isChecked())
            return wizard->evaluatePage;
        else
            return wizard->registerPage;
    }

The nextPage() function returns the EvaluatePage if the Evaluate our product option is checked; otherwise it returns the RegisterPage. We can access the wizard's pointers because we made all the wizard pages friends of the LicenseWizard class.

The EvaluatePage is slightly more involved:

    class EvaluatePage : public LicenseWizardPage
    {
    public:
        EvaluatePage(LicenseWizard *wizard);

        void resetPage();
        WizardPage *nextPage();
        bool isComplete();

    private:
        QLabel *topLabel;
        QLabel *nameLabel;
        QLabel *emailLabel;
        QLabel *bottomLabel;
        QLineEdit *nameLineEdit;
        QLineEdit *emailLineEdit;
    };

This time, we reimplement isComplete() in addition to resetPage() and nextPage(). Here's the constructor:

    EvaluatePage::EvaluatePage(LicenseWizard *wizard)
        : LicenseWizardPage(wizard)
    {
        topLabel = new QLabel(tr("<center><b>Evaluate Super Product One"
                                 "</b></center>"));

        nameLabel = new QLabel(tr("&Name:"));
        nameLineEdit = new QLineEdit;
        nameLabel->setBuddy(nameLineEdit);
        setFocusProxy(nameLineEdit);

        emailLabel = new QLabel(tr("&Email address:"));
        emailLineEdit = new QLineEdit;
        emailLabel->setBuddy(emailLineEdit);

        bottomLabel = new QLabel(tr("Please fill in both fields.\nThis will "
                                    "entitle you to a 30-day evaluation."));

        connect(nameLineEdit, SIGNAL(textChanged(QString)),
                this, SIGNAL(completeStateChanged()));
        connect(emailLineEdit, SIGNAL(textChanged(QString)),
                this, SIGNAL(completeStateChanged()));

        QGridLayout *layout = new QGridLayout;
        layout->addWidget(topLabel, 0, 0, 1, 2);
        layout->setRowMinimumHeight(1, 10);
        layout->addWidget(nameLabel, 2, 0);
        layout->addWidget(nameLineEdit, 2, 1);
        layout->addWidget(emailLabel, 3, 0);
        layout->addWidget(emailLineEdit, 3, 1);
        layout->setRowMinimumHeight(4, 10);
        layout->addWidget(bottomLabel, 5, 0, 1, 2);
        layout->setRowStretch(6, 1);
        setLayout(layout);
    }

The interesting part is the two QObject::connect() calls near the middle. Whenever the user types in some text in the Name or Email address fields, we emit the completeStateChanged() signal, even though the complete state might not actually have changed. It doesn't hurt anyway.

    void EvaluatePage::resetPage()
    {
        nameLineEdit->clear();
        emailLineEdit->clear();
    }

Resetting the page amounts to clearing the two text fields.

    WizardPage *EvaluatePage::nextPage()
    {
        return wizard->finishPage;
    }

The next page is always the FinishPage.

    bool EvaluatePage::isComplete()
    {
        return !nameLineEdit->text().isEmpty() && !emailLineEdit->text().isEmpty();
    }

The page is considered complete when both the Name and the Email address fields contain some text.

The RegisterPage and DetailsPage are very similar. Let's go directly to the FinishPage:

    class FinishPage : public LicenseWizardPage
    {
    public:
        FinishPage(LicenseWizard *wizard);

        void resetPage();
        bool isLastPage() { return true; }
        bool isComplete();

    private:
        QLabel *topLabel;
        QLabel *bottomLabel;
        QCheckBox *agreeCheckBox;
    };

This time, we reimplement isLastPage() to return true.

The resetPage() implementation is also interesting:

    void FinishPage::resetPage()
    {
        QString licenseText;

        if (wizard->historyPages().contains(wizard->evaluatePage)) {
            licenseText = tr("Evaluation License Agreement: "
                             "You can use this software for 30 days and make one "
                             "back up, but you are not allowed to distribute it.");
        } else if (wizard->historyPages().contains(wizard->detailsPage)) {
            licenseText = tr("First-Time License Agreement: "
                             "You can use this software subject to the license "
                             "you will receive by email.");
        } else {
            licenseText = tr("Upgrade License Agreement: "
                             "This software is licensed under the terms of your "
                             "current license.");
        }
        bottomLabel->setText(licenseText);
        agreeCheckBox->setChecked(false);
    }

We use historyPages() to determine the type of license agreement the user has chosen. If the user filled the EvaluatePage, the license text refers to an Evaluation License Agreement. If the user filled the DetailsPage, the license text is a First-Time License Agreement. If the user provided an upgrade key and skipped the DetailsPage, the license text is an Update License Agreement.

    bool FinishPage::isComplete()
    {
        return agreeCheckBox->isChecked();
    }

The FinishPage is complete when the user checks the I agree to the terms and conditions of the license option.