QWizard Class

成员函数文档

[explicit] QWizard::QWizard(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

用给定的parent 和窗口flags 构建向导。

另请参阅 parent() 和windowFlags() 。

[virtual noexcept] QWizard::~QWizard()

销毁向导及其页面，释放已分配的资源。

int QWizard::addPage(QWizardPage *page)

将给定的page 添加到向导中，并返回页面的 ID。

到目前为止，该 ID 保证大于QWizard 中的任何其他 ID。

另请参阅 setPage(),page() 和pageAdded()。

[slot] void QWizard::back()

返回上一页。

这相当于按Back 按钮。

另请参阅 next(),accept(),reject() 和restart().

QAbstractButton *QWizard::button(QWizard::WizardButton which) const

返回角色which 对应的按钮。

另请参阅 setButton() 和setButtonText()。

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

返回which 按钮上的文本。

如果使用setButtonText() 设置了文本，则会返回该文本。

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

另请参阅 button(),setButton(),setButtonText(),QWizardPage::buttonText() 和QWizardPage::setButtonText().

[virtual protected] void QWizard::cleanupPage(int id)

QWizard 在用户点击Back 离开id 页面之前（除非设置了QWizard::IndependentPages 选项），会调用此虚函数来清理页面。

默认实现在 page(id) 上调用QWizardPage::cleanupPage() 。

另请参见 QWizardPage::cleanupPage() 和initializePage()。

[signal] void QWizard::currentIdChanged(int id)

当当前页面发生变化时会发出该信号，新的当前id 。

另请参阅 currentId() 和currentPage()。

QWizardPage *QWizard::currentPage() const

返回指向当前页面的指针，如果没有当前页面（例如，在向导显示之前），则返回nullptr 。

这等同于调用 page(currentId()) 。

另请参阅 page()、currentId() 和restart()。

[signal] void QWizard::customButtonClicked(int which)

当用户点击自定义按钮时会发出该信号。which 可以是CustomButton1 、CustomButton2 或CustomButton3 。

默认情况下，不显示自定义按钮。调用setOption() 和HaveCustomButton1 、HaveCustomButton2 或HaveCustomButton3 可获得一个自定义按钮，并使用setButtonText() 或setButton() 进行配置。

另请参阅 helpRequested()。

[override virtual protected] void QWizard::done(int result)

重实现：QDialog::done(int r)。

[override virtual protected] bool QWizard::event(QEvent *event)

重实现：QWidget::event(QEvent *event).

QVariant QWizard::field(const QString &name) const

返回name 字段的值。

该函数可用于访问向导任何页面上的字段。

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

bool QWizard::hasVisitedPage(int id) const

如果页面历史记录包含页面id ，则返回true ；否则，返回false 。

按Back 会将当前页面再次标记为 "未访问 "页面。

另请参阅 visitedIds() 。

[signal] void QWizard::helpRequested()

当用户点击Help 按钮时会发出该信号。

默认情况下，不显示Help 按钮。调用setOption(HaveHelpButton, true) 可显示一个按钮。

示例：

LicenseWizard::LicenseWizard(QWidget *parent)
    : QWizard(parent)
{
    ...
    setOption(HaveHelpButton, true);
    connect(this, &QWizard::helpRequested, this, &LicenseWizard::showHelp);
    ...
}

void LicenseWizard::showHelp()
{
    static QString lastHelpMessage;

    QString message;

    switch (currentId()) {
    case Page_Intro:
        message = tr("The decision you make here will affect which page you "
                     "get to see next.");
        break;
    ...
    default:
        message = tr("This help is likely not to be of any help.");
    }

    QMessageBox::information(this, tr("License Wizard Help"), message);

}

另请参阅 customButtonClicked().

[virtual protected] void QWizard::initializePage(int id)

在调用QWizard::restart() 或用户点击Next 后，页面id 即将显示之前，QWizard 会调用这个虚拟函数来准备页面 （不过，如果设置了QWizard::IndependentPages 选项，则只有在首次显示页面时才会调用该函数）。

通过重新实现该函数，可以确保页面字段根据之前页面的字段正确初始化。

默认实现在 page(id) 上调用QWizardPage::initializePage() 。

另请参阅 QWizardPage::initializePage() 和cleanupPage()。

[override virtual protected] bool QWizard::nativeEvent(const QByteArray &eventType, void *message, qintptr *result)

重实现：QWidget::nativeEvent(const QByteArray &eventType, void *message, qintptr *result).

[slot] void QWizard::next()

进入下一页。

这相当于按Next 或Commit 按钮。

另请参阅 nextId(),back(),accept(),reject() 和restart().

[virtual] int QWizard::nextId() const

QWizard 调用此虚函数，以确定当用户点击Next 按钮时应显示哪个页面。

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

默认实现在currentPage() 上调用QWizardPage::nextId()。

通过重新实现该函数，可以指定动态页面顺序。

另请参阅 QWizardPage::nextId() 和currentPage()。

QWizardPage *QWizard::page(int id) const

返回给定id 的页面，如果没有，则返回nullptr 。

另请参阅 addPage() 和setPage()。

[signal] void QWizard::pageAdded(int id)

每当向导中添加一个页面时，就会发出该信号。页面的id 将作为参数传递。

另请参阅 addPage(),setPage() 和startId().

QList<int> QWizard::pageIds() const

返回页面 ID 列表。

[signal] void QWizard::pageRemoved(int id)

每当从向导中删除一个页面时，就会发出该信号。页面的id 将作为参数传递。

另请参阅 removePage() 和startId() 。

[override virtual protected] void QWizard::paintEvent(QPaintEvent *event)

重实现：QWidget::paintEvent(QPaintEvent *event).

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

返回为角色which 设置的像素图。

默认情况下，设置的唯一像素图是 macOS 上的BackgroundPixmap 。

另请参阅 setPixmap(),QWizardPage::pixmap() 和Elements of a Wizard Page 。

void QWizard::removePage(int id)

删除带有给定id 的页面。如有必要，将调用cleanupPage() 。

另请参阅 addPage()、setPage()、pageRemoved() 和startId()。

[override virtual protected] void QWizard::resizeEvent(QResizeEvent *event)

重实现：QDialog::resizeEvent(QResizeEvent *)。

[slot] void QWizard::restart()

在起始页重新启动向导。向导显示时会自动调用该函数。

另请参阅 startId().

void QWizard::setButton(QWizard::WizardButton which, QAbstractButton *button)

将与角色which 对应的按钮设置为button 。

要在向导中添加额外的按钮（如Print 按钮），一种方法是调用 setButton() 并使用CustomButton1 至CustomButton3 ，然后使用HaveCustomButton1 至HaveCustomButton3 选项使按钮可见。

另请参阅 button(),setButtonText(),setButtonLayout() 和options 。

void QWizard::setButtonLayout(const QList<QWizard::WizardButton> &layout)

将按钮的显示顺序设为layout ，其中layout 是WizardButton的列表。

默认布局取决于所设置的选项（例如，是否HelpButtonOnRight ）。如果需要比options 提供的更多按钮布局控制功能，可以调用此函数。

您可以使用Stretch 在布局中指定水平拉伸。

示例

MyWizard::MyWizard(QWidget *parent)
    : QWizard(parent)
{
    ...
    QList<QWizard::WizardButton> layout;
    layout << QWizard::Stretch << QWizard::BackButton << QWizard::CancelButton
           << QWizard::NextButton << QWizard::FinishButton;
    setButtonLayout(layout);
    ...
}

另请参阅 setButton(),setButtonText() 和setOptions().

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

将which 按钮上的文本设置为text 。

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

要在向导中添加额外的按钮（如Print 按钮），一种方法是调用 setButtonText() 设置CustomButton1 、CustomButton2 或CustomButton3 的文本，并使用HaveCustomButton1 、HaveCustomButton2 和/或HaveCustomButton3 选项使按钮可见。

也可以使用QWizardPage::setButtonText() 按页面设置按钮文本。

另请参阅 buttonText(),setButton(),button(),setButtonLayout(),setOptions(), 和QWizardPage::setButtonText().

[slot] void QWizard::setCurrentId(int id)

将currentId 设置为id ，而不访问currentId 和id 之间的页面。

如果

• 向导中没有页面
• 当前页面无效
• 给定页面等于currentId()
• 给定页面超出范围

注：如果已跳过页面且id 为 0，则将删除页面访问历史记录

另请参阅 currentId() 。

void QWizard::setDefaultProperty(const char *className, const char *property, const char *changedSignal)

将className 的默认属性设置为property ，并将相关的更改信号设置为changedSignal 。

当className （或其子类之一）的实例传递给QWizardPage::registerField() 且未指定属性时，将使用默认属性。

QWizard 知道最常见的 Qt Widget。对于这些部件（或其子类），无需指定 或 。下表列出了这些部件：property changedSignal

另请参见 QWizardPage::registerField().

void QWizard::setField(const QString &name, const QVariant &value)

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

此函数可用于设置向导任何页面上的字段。

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

void QWizard::setOption(QWizard::WizardOption option, bool on = true)

如果on 为 true，则设置option 为启用状态；否则，清除给定的option 。

另请参阅 options,testOption() 和setWizardStyle()。

void QWizard::setPage(int id, QWizardPage *page)

将给定的page 与给定的id 一起添加到向导中。

另请参阅 addPage(),page() 和pageAdded() 。

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

将角色which 的像素图设置为pixmap 。

QWizard 在显示页面时会使用像素图。实际使用的像素图取决于wizard style 。

也可以使用QWizardPage::setPixmap() 为特定页面设置像素图。

另请参阅 pixmap(),QWizardPage::setPixmap() 和Elements of a Wizard Page 。

void QWizard::setSideWidget(QWidget *widget)

将给定的widget 设置为显示在向导的左侧。对于使用WatermarkPixmap 的样式（ClassicStyle 和ModernStyle ），侧边小部件会显示在水印的顶部；对于其他样式或未提供水印时，侧边小部件会显示在向导的左侧。

通过nullptr 则不显示侧边小部件。

当widget 不是nullptr 时，向导会将其重置。

之前的任何侧边部件都会被隐藏。

您可以在不同时间使用相同的 Widget 调用 setSideWidget()。

所有在此设置的 Widget 都将在向导销毁时被向导删除，除非您在设置其他侧 Widget（或nullptr ）后单独重新设置 Widget。

默认情况下，不存在边部件。

另请参见 sideWidget().

[override virtual] void QWizard::setVisible(bool visible)

重实现：QDialog::setVisible(bool visible)。

QWidget *QWizard::sideWidget() const

返回向导左侧的 widget 或nullptr 。

默认情况下，没有侧边部件。

另请参阅 setSideWidget() 。

[override virtual] QSize QWizard::sizeHint() const

重实现：QDialog::sizeHint() const.

bool QWizard::testOption(QWizard::WizardOption option) const

如果给定的option 已启用，则返回true ；否则，返回 false。

另请参阅 options,setOption() 和setWizardStyle()。

[virtual] bool QWizard::validateCurrentPage()

当用户点击Next 或Finish 进行最后的验证时，QWizard 将调用此虚函数。如果返回true ，则显示下一页（或向导结束）；否则，当前页保持不变。

默认实现在currentPage() 上调用QWizardPage::validatePage() 。

在可能的情况下，禁用Next 或Finish 按钮（指定mandatory fields 或重新实现QWizardPage::isComplete() ）通常比重新实现 validateCurrentPage() 更好。

另请参阅 QWizardPage::validatePage() 和currentPage()。

QList<int> QWizard::visitedIds() const

按访问页面的顺序返回已访问页面的 ID 列表。

另请参见 hasVisitedPage()。