QWizardPage¶

The QWizardPage class is the base class for wizard pages. More…

Synopsis¶

Functions¶

def buttonText (which)
def field (name)
def isCommitPage ()
def isFinalPage ()
def pixmap (which)
def registerField (name, widget[, property=None[, changedSignal=None]])
def setButtonText (which, text)
def setCommitPage (commitPage)
def setField (name, value)
def setFinalPage (finalPage)
def setPixmap (which, pixmap)
def setSubTitle (subTitle)
def setTitle (title)
def subTitle ()
def title ()
def wizard ()

Virtual functions¶

def cleanupPage ()
def initializePage ()
def isComplete ()
def nextId ()
def validatePage ()

Signals¶

def completeChanged ()

Detailed Description¶

QWizard represents a wizard. Each page is a QWizardPage . When you create your own wizards, you can use QWizardPage directly, or you can subclass it for more control.

A page has the following attributes, which are rendered by QWizard : a title , a subTitle , and a set of pixmaps . See Elements of a Wizard Page for details. Once a page is added to the wizard (using addPage() or setPage() ), wizard() returns a pointer to the associated QWizard object.

Page provides five virtual functions that can be reimplemented to provide custom behavior:

initializePage() is called to initialize the page’s contents when the user clicks the wizard’s Next button. If you want to derive the page’s default from what the user entered on previous pages, this is the function to reimplement.

cleanupPage() is called to reset the page’s contents when the user clicks the wizard’s Back button.

validatePage() validates the page when the user clicks Next or Finish. It is often used to show an error message if the user has entered incomplete or invalid information.

nextId() returns the ID of the next page. It is useful when creating non-linear wizards , which allow different traversal paths based on the information provided by the user.

isComplete() is called to determine whether the Next and/or Finish button should be enabled or disabled. If you reimplement isComplete() , also make sure that completeChanged() is emitted whenever the complete state changes.

Normally, the Next button and the Finish button of a wizard are mutually exclusive. If isFinalPage() returns true, Finish is available; otherwise, Next is available. By default, isFinalPage() is true only when nextId() returns -1. If you want to show Next and Final simultaneously for a page (letting the user perform an “early finish”), call setFinalPage (true) on that page. For wizards that support early finishes, you might also want to set the HaveNextButtonOnLastPage and HaveFinishButtonOnEarlyPages options on the wizard.

In many wizards, the contents of a page may affect the default values of the fields of a later page. To make it easy to communicate between pages, QWizard supports a "field" mechanism that allows you to register a field (e.g., a QLineEdit ) on a page and to access its value from any page. Fields are global to the entire wizard and make it easy for any single page to access information stored by another page, without having to put all the logic in QWizard or having the pages know explicitly about each other. Fields are registered using registerField() and can be accessed at any time using field() and setField() .

See also

QWizard Class Wizard Example License Wizard Example

class PySide6.QtWidgets.QWizardPage([parent=None])¶

Parameters: parent – PySide6.QtWidgets.QWidget

Constructs a wizard page with the given parent.

When the page is inserted into a wizard using addPage() or setPage() , the parent is automatically set to be the wizard.

See also

wizard()

PySide6.QtWidgets.QWizardPage.buttonText(which)¶

Parameters: which – WizardButton
Return type: str

Returns the text on button which on this page.

If a text has ben set using setButtonText() , this text is returned. Otherwise, if a text has been set using setButtonText() , this text is returned.

By default, the text on buttons depends on the wizardStyle . For example, on macOS, the Next button is called Continue.

See also

setButtonText() buttonText() setButtonText()

PySide6.QtWidgets.QWizardPage.cleanupPage()¶

This virtual function is called by cleanupPage() when the user leaves the page by clicking Back (unless the IndependentPages option is set).

The default implementation resets the page’s fields to their original values (the values they had before initializePage() was called).

See also

cleanupPage() initializePage() IndependentPages

PySide6.QtWidgets.QWizardPage.completeChanged()¶

PySide6.QtWidgets.QWizardPage.field(name)¶

Parameters: name – str
Return type: object

Returns the value of the field called name.

This function can be used to access fields on any page of the wizard. It is equivalent to calling wizard() ->``name`` :meth:` <PySide6.QtWidgets.QWizard.field>` ).

Example:

def initializePage(self):

    className = field("className").toString()
    headerLineEdit.setText(className.toLower() + ".h")
    implementationLineEdit.setText(className.toLower() + ".cpp")
    outputDirLineEdit.setText(QDir.toNativeSeparators(QDir.tempPath()))

Widget	Property	Change Notification Signal
`QAbstractButton`	bool `checked`	`toggled()`
`QAbstractSlider`	int `value`	`valueChanged()`
`QComboBox`	int `currentIndex`	`currentIndexChanged()`
`QDateTimeEdit`	`QDateTime` `dateTime`	`dateTimeChanged()`
`QLineEdit`	`QString` `text`	`textChanged()`
`QListWidget`	int `currentRow`	`currentRowChanged()`
`QSpinBox`	int `value`	`valueChanged()`

Table of Contents

Previous topic

Next topic

QWizardPage¶

Synopsis¶

Functions¶

Virtual functions¶

Signals¶

Detailed Description¶