QWizardPage 类

成员函数文档

[明确] QWizardPage::QWizardPage(QWidget *parent = nullptr)

使用给定的parent构建向导页面。

当页面使用QWizard::addPage()或QWizard::setPage()插入到向导中时，父对象会自动设置为向导。

另请参阅向导。

[虚拟 noexcept] QWizardPage::~QWizardPage()

析构函数。

QString QWizardPage::buttonText(QWizard::WizardButton which) const

返回此页面上按钮which上的文本。

如果使用了setButtonText设置文本，则返回此文本。如果没有，如果使用了QWizard::setButtonText设置文本，则返回此文本。

默认情况下，按钮上的文本取决于QWizard::wizardStyle。例如，在macOS上，Next按钮称为Continue。

另请参阅setButtonText、QWizard::buttonText和QWizard::setButtonText。

[虚拟] void QWizardPage::cleanupPage()

当用户通过单击Back离开页面时（除非设置了QWizard::IndependentPages选项），由QWizard::cleanupPage()调用此虚拟函数。

默认情况下，此实现将页面字段重置为其原始值（在调用initializePage()之前具有的值）。

另请参阅 QWizard::cleanupPage()，initializePage()以及QWizard::IndependentPages。

[信号] void QWizardPage::completeChanged()

每当页面的完成状态（即isComplete的值）发生变化时，都会发出此信号。

如果你重写了isComplete，确保在isComplete的值发生变化时发出completeChanged()，以确保QWizard更新其按钮的启用和禁用状态。

另请参阅isComplete。

[保护] QVariant QWizardPage::field(const QString &name) const

返回名为name的字段值。

此函数可以用于访问任意页面的字段。它等同于调用QWizard::field(name)。

示例

        const QString emailAddress = field("details.email").toString();
        licenseText = tr("<u>First-Time License Agreement:</u> "
                         "You can use this software subject to the license "
                         "you will receive by email sent to %1.").arg(emailAddress);

另请参阅 QWizard::field，setField和registerField。

[虚函数] void QWizardPage::initializePage()

此虚拟函数由QWizard::initializePage()调用，以便在以下情况下准备页面：在调用QWizard::restart()之后，或用户点击下一步按钮。然而，如果设置了QWizard::IndependentPages选项，此函数只会在页面第一次显示时被调用。

通过重写此函数，你可以确保页面字段根据以前页面的字段正确初始化。例如

void ConclusionPage::initializePage()
{
    QString licenseText;

    if (wizard()->hasVisitedPage(LicenseWizard::Page_Evaluate)) {
        licenseText = tr("<u>Evaluation License Agreement:</u> "
                         "You can use this software for 30 days and make one "
                         "backup, but you are not allowed to distribute it.");
    } else if (wizard()->hasVisitedPage(LicenseWizard::Page_Details)) {
        const QString emailAddress = field("details.email").toString();
        licenseText = tr("<u>First-Time License Agreement:</u> "
                         "You can use this software subject to the license "
                         "you will receive by email sent to %1.").arg(emailAddress);
    } else {
        licenseText = tr("<u>Upgrade License Agreement:</u> "
                         "This software is licensed under the terms of your "
                         "current license.");
    }
    bottomLabel->setText(licenseText);
}

默认实现不执行任何操作。

另请参阅 QWizard::initializePage，cleanupPage和QWizard::IndependentPages。

bool QWizardPage::isCommitPage() const

如果这是一个提交页面，则返回true；否则返回false。

另请参阅setCommitPage。

[虚函数] bool QWizardPage::isComplete() const

此虚拟函数由QWizard调用，以确定是否启用或禁用下一步或完成按钮。

默认实现在某些强制字段被填写时返回true；否则返回false。

如果你重写此函数，确保从你的实现的其他部分发出completeChanged，这样QWizard就能更新按钮的启用或禁用状态。一个重写的示例在此处：这里。

另请参阅completeChanged()和isFinalPage。

bool QWizardPage::isFinalPage() const

此函数由 QWizard 调用，以确定是否应为此页面显示 完成 按钮。

默认情况下，如果没有下一页（即 nextId() 返回 -1），则返回 true；否则，返回 false。

通过显式调用 setFinalPage(true)，您可以允许用户执行“早期完成”。

另请参阅isComplete() 和 QWizard::HaveFinishButtonOnEarlyPages。

[虚拟] int QWizardPage::nextId() const

此虚拟函数由 QWizard::nextId() 调用，以找到当用户点击 下一步 按钮时应显示的页面。

返回值是下一页的 ID，如果没有后续页面，则返回 -1。

默认情况下，此函数返回高于当前页面 ID 的最低 ID，如果没有这样的 ID，则返回 -1。

通过重写此函数，您可以指定动态页面顺序。例如

int IntroPage::nextId() const
{
    if (evaluateRadioButton->isChecked()) {
        return LicenseWizard::Page_Evaluate;
    } else {
        return LicenseWizard::Page_Register;
    }
}

另请参阅QWizard::nextId。

QPixmap QWizardPage::pixmap(QWizard::WizardPixmap which) const

返回为角色 which 设置的位图。

还可以使用 QWizard::setPixmap() 为整个向导程序设置位图，在这种情况下，它们应用于所有未指定位图的页面。

另请参阅setPixmap()、QWizard::pixmap() 和向导页面元素。

[保护的] void QWizardPage::registerField(const QString &name, QWidget *widget, const char *property = nullptr, const char *changedSignal = nullptr)

创建一个名为 name 的字段，与给定的 property 关联给给定的 widget。从那时起，该属性可以通过 field() 和 setField() 访问。

字段属于整个向导，它使得任何单个页面都可以访问由另一个页面存储的信息，而无需在 QWizard 中放置所有逻辑，或者页面需要明确了解彼此。

如果 name 以星号 (*) 结尾，该字段是必需字段。当页面有必需字段时，只有当所有必需字段都已填写时，下一步 和/或 完成 按钮才可用。这需要指定 changedSignal，以便通知 QWizard 重新检查必需字段存储的值。

QWizard 知道最常用的 Qt 小部件。对于这些（或它们的子类），您不需要指定 property 或 changedSignal。以下表格列出了这些小部件

可以使用 QWizard::setDefaultProperty() 向此表添加条目或覆盖现有条目。

为了使一个字段被认为是“已填写”，QWizard 仅简单地检查当前值是否与其原始值（在调用 initializePage() 之前拥有的值）不相等。对于 QLineEdit，它还会检查 hasAcceptableInput() 返回 true，以尊重任何验证器或掩码。

QWizard 的必填字段机制提供方便。可以通过重新实现 QWizardPage::isComplete() 来绕过。

另请参阅 field()、setField() 和 QWizard::setDefaultProperty()。

void QWizardPage::setButtonText(QWizard::WizardButton which, const QString &text)

将按钮 which 的文木设置为该页上的 text。

默认情况下，按钮上的文本取决于 QWizard::wizardStyle，但可以使用 QWizard::setButtonText() 重新定义整个向导的按钮文本。

另请参阅 buttonText()、QWizard::setButtonText() 和 QWizard::buttonText()。

void QWizardPage::setCommitPage(bool commitPage)

如果 commitPage 为 true，则将此页设置为提交页；否则，将其设置为普通页。

提交页表示的动作不能通过点击 后退 或 取消 来撤销。

提交按钮替换了提交页上的 下一步 按钮单击此按钮相当于单击 下一步。

直接从提交页进入的页将 后退 按钮禁用。

另请参阅 isCommitPage()。

[受保护的] void QWizardPage::setField(const QString &name, const QVariant &value)

将名为 name 的字段的值设置为 value。

此函数可以用来设置向导任何页面的字段。它与调用 wizard()->setField(name, value) 相当。

另请参阅 QWizard::setField()、field() 和 registerField()。

void QWizardPage::setFinalPage(bool finalPage)

如果 finalPage 为 true，则显式地将此页设置为最终页。

调用 setFinalPage(true) 后，isFinalPage() 返回 true 并且 完成 按钮可见（如果 isComplete() 返回 true，则启用）。

调用 setFinalPage(false) 后，如果 nextId() 返回 -1，则 isFinalPage() 返回 true；否则，返回 false。

参见 isFinalPage()，isComplete() 和 QWizard::HaveFinishButtonOnEarlyPages。

void QWizardPage::setPixmap(QWizard::WizardPixmap which，const QPixmap &pixmap)

设置角色 which 的精灵为 pixmap。

精灵由 QWizard 在显示页面时使用。实际使用的精灵取决于 向导样式。

还可以使用 QWizard::setPixmap() 为整个向导程序设置位图，在这种情况下，它们应用于所有未指定位图的页面。

参见 pixmap()，QWizard::setPixmap() 和 向导页面元素。

[虚函数] bool QWizardPage::validatePage()

当用户点击 下一步 或 完成 时，此虚函数由 QWizard::validateCurrentPage() 调用以进行一些最后的验证。如果返回 true，则显示下一页（或向导完成）；否则，当前页面保持显示。

默认实现返回 true。

通常，禁用 下一步 或 完成 按钮（通过指定 必填字段 或重写 isComplete()）比重写 validatePage() 更好的风格。

参见 QWizard::validateCurrentPage() 和 isComplete。

[保护] QWizard *QWizardPage::wizard() const

返回与此页面关联的向导，如果此页面尚未插入到 QWizard 中，则返回 nullptr。

参见 QWizard::addPage() 和 QWizard::setPage。