QWizardPage

Synopsis

Functions

• def buttonText (which)
• def field (name)
• def isCommitPage ()
• def isFinalPage ()
• def pixmap (which)
• def registerField (name, widget[, property=0[, changedSignal=0]])
• 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

The PySide.QtGui.QWizardPage class is the base class for wizard pages.

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

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

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

• PySide.QtGui.QWizardPage.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.
• PySide.QtGui.QWizardPage.cleanupPage() is called to reset the page’s contents when the user clicks the wizard’s Back button.
• PySide.QtGui.QWizardPage.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.
• PySide.QtGui.QWizardPage.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.
• PySide.QtGui.QWizardPage.isComplete() is called to determine whether the Next and/or Finish button should be enabled or disabled. If you reimplement PySide.QtGui.QWizardPage.isComplete() , also make sure that PySide.QtGui.QWizardPage.completeChanged() is emitted whenever the complete state changes.

Normally, the Next button and the Finish button of a wizard are mutually exclusive. If PySide.QtGui.QWizardPage.isFinalPage() returns true, Finish is available; otherwise, Next is available. By default, PySide.QtGui.QWizardPage.isFinalPage() is true only when PySide.QtGui.QWizardPage.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, PySide.QtGui.QWizard supports a "field" mechanism that allows you to register a field (e.g., a PySide.QtGui.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 PySide.QtGui.QWizard or having the pages know explicitly about each other. Fields are registered using PySide.QtGui.QWizardPage.registerField() and can be accessed at any time using PySide.QtGui.QWizardPage.field() and PySide.QtGui.QWizardPage.setField() .

See also

PySide.QtGui.QWizard Class Wizard Example License Wizard Example

class PySide.QtGui.QWizardPage([parent=None])

Parameters:parent – PySide.QtGui.QWidget

Constructs a wizard page with the given parent .

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

See also

PySide.QtGui.QWizardPage.wizard()

PySide.QtGui.QWizardPage.buttonText(which)

Parameters:which – PySide.QtGui.QWizard.WizardButton Return type:unicode

PySide.QtGui.QWizardPage.cleanupPage()

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

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

See also

QWizard.cleanupPage() PySide.QtGui.QWizardPage.initializePage() QWizard.IndependentPages

PySide.QtGui.QWizardPage.completeChanged()

PySide.QtGui.QWizardPage.field(name)

Parameters:name – unicode 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 PySide.QtGui.QWizardPage.wizard() ->``name`` :meth:` <PySide.QtGui.QWizard.field>` ).

Example:

def initializePage(self):
    className = field("className")
    self.headerLineEdit.setText(className.lower() + ".h")
    self.implementationLineEdit.setText(className.lower() + ".cpp")
    self.outputDirLineEdit.setText(QDir.convertSeparators(QDir.tempPath()))

See also

QWizard.field() PySide.QtGui.QWizardPage.setField() PySide.QtGui.QWizardPage.registerField()

PySide.QtGui.QWizardPage.initializePage()

This virtual function is called by QWizard.initializePage() to prepare the page just before it is shown either as a result of QWizard.restart() being called, or as a result of the user clicking Next . (However, if the QWizard.IndependentPages option is set, this function is only called the first time the page is shown.)

By reimplementing this function, you can ensure that the page’s fields are properly initialized based on fields from previous pages. For example:

def initializePage(self):
    className = field("className")
    self.headerLineEdit.setText(className.lower() + ".h")
    self.implementationLineEdit.setText(className.lower() + ".cpp")
    self.outputDirLineEdit.setText(QDir.convertSeparators(QDir.tempPath()))

The default implementation does nothing.

See also

QWizard.initializePage() PySide.QtGui.QWizardPage.cleanupPage() QWizard.IndependentPages

PySide.QtGui.QWizardPage.isCommitPage()

Return type:PySide.QtCore.bool

Returns true if this page is a commit page; otherwise returns false.

See also

PySide.QtGui.QWizardPage.setCommitPage()

PySide.QtGui.QWizardPage.isComplete()

Return type:PySide.QtCore.bool

This virtual function is called by PySide.QtGui.QWizard to determine whether the Next or Finish button should be enabled or disabled.

The default implementation returns true if all mandatory fields are filled; otherwise, it returns false.

If you reimplement this function, make sure to emit PySide.QtGui.QWizardPage.completeChanged() , from the rest of your implementation, whenever the value of PySide.QtGui.QWizardPage.isComplete() changes. This ensures that PySide.QtGui.QWizard updates the enabled or disabled state of its buttons. An example of the reimplementation is available here.

See also

PySide.QtGui.QWizardPage.completeChanged() PySide.QtGui.QWizardPage.isFinalPage()

PySide.QtGui.QWizardPage.isFinalPage()

Return type:PySide.QtCore.bool

This function is called by PySide.QtGui.QWizard to determine whether the Finish button should be shown for this page or not.

By default, it returns true if there is no next page (i.e., PySide.QtGui.QWizardPage.nextId() returns -1); otherwise, it returns false.

By explicitly calling setFinalPage(true), you can let the user perform an “early finish”.

See also

PySide.QtGui.QWizardPage.isComplete() QWizard.HaveFinishButtonOnEarlyPages

PySide.QtGui.QWizardPage.nextId()

Return type:PySide.QtCore.int

This virtual function is called by QWizard.nextId() to find out which page to show when the user clicks the Next button.

The return value is the ID of the next page, or -1 if no page follows.

By default, this function returns the lowest ID greater than the ID of the current page, or -1 if there is no such ID.

By reimplementing this function, you can specify a dynamic page order. For example:

# class IntroPage
def nextId(self):

    if evaluateRadioButton.isChecked():
        return LicenseWizard.Page_Evaluate
    else:
        return LicenseWizard.Page_Register

See also

QWizard.nextId()

PySide.QtGui.QWizardPage.pixmap(which)

Parameters:which – PySide.QtGui.QWizard.WizardPixmap Return type:PySide.QtGui.QPixmap

PySide.QtGui.QWizardPage.registerField(name, widget[, property=0[, changedSignal=0]])

Parameters:

• name – unicode
• widget – PySide.QtGui.QWidget
• property – str
• changedSignal – str

Creates a field called name associated with the given property of the given widget . From then on, that property becomes accessible using PySide.QtGui.QWizardPage.field() and PySide.QtGui.QWizardPage.setField() .

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 PySide.QtGui.QWizard or having the pages know explicitly about each other.

If name ends with an asterisk (* ), the field is a mandatory field. When a page has mandatory fields, the Next and/or Finish buttons are enabled only when all mandatory fields are filled. This requires a changedSignal to be specified, to tell PySide.QtGui.QWizard to recheck the value stored by the mandatory field.

PySide.QtGui.QWizard knows the most common Qt widgets. For these (or their subclasses), you don’t need to specify a property or a changedSignal . The table below lists these widgets:

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

You can use QWizard.setDefaultProperty() to add entries to this table or to override existing entries.

To consider a field “filled”, PySide.QtGui.QWizard simply checks that their current value doesn’t equal their original value (the value they had before PySide.QtGui.QWizardPage.initializePage() was called). For PySide.QtGui.QLineEdit , it also checks that PySide.QtGui.QLineEdit.hasAcceptableInput() returns true, to honor any validator or mask.

PySide.QtGui.QWizard ‘s mandatory field mechanism is provided for convenience. It can be bypassed by reimplementing QWizardPage.isComplete() .

See also

PySide.QtGui.QWizardPage.field() PySide.QtGui.QWizardPage.setField() QWizard.setDefaultProperty()

PySide.QtGui.QWizardPage.setButtonText(which, text)

Parameters:

• which – PySide.QtGui.QWizard.WizardButton
• text – unicode

PySide.QtGui.QWizardPage.setCommitPage(commitPage)

Parameters:commitPage – PySide.QtCore.bool

Sets this page to be a commit page if commitPage is true; otherwise, sets it to be a normal page.

A commit page is a page that represents an action which cannot be undone by clicking Back or Cancel .

A Commit button replaces the Next button on a commit page. Clicking this button simply calls QWizard.next() just like clicking Next does.

A page entered directly from a commit page has its Back button disabled.

See also

PySide.QtGui.QWizardPage.isCommitPage()

PySide.QtGui.QWizardPage.setField(name, value)

Parameters:

• name – unicode
• value – object

Sets the value of the field called name to value .

This function can be used to set fields on any page of the wizard. It is equivalent to calling PySide.QtGui.QWizardPage.wizard() ->``name`` :meth:` <PySide.QtGui.QWizard.setField>` , value ).

See also

QWizard.setField() PySide.QtGui.QWizardPage.field() PySide.QtGui.QWizardPage.registerField()

PySide.QtGui.QWizardPage.setFinalPage(finalPage)

Parameters:finalPage – PySide.QtCore.bool

Explicitly sets this page to be final if finalPage is true.

After calling setFinalPage(true), PySide.QtGui.QWizardPage.isFinalPage() returns true and the Finish button is visible (and enabled if PySide.QtGui.QWizardPage.isComplete() returns true).

After calling setFinalPage(false), PySide.QtGui.QWizardPage.isFinalPage() returns true if PySide.QtGui.QWizardPage.nextId() returns -1; otherwise, it returns false.

See also

PySide.QtGui.QWizardPage.isFinalPage() PySide.QtGui.QWizardPage.isComplete() QWizard.HaveFinishButtonOnEarlyPages

PySide.QtGui.QWizardPage.setPixmap(which, pixmap)

Parameters:

• which – PySide.QtGui.QWizard.WizardPixmap
• pixmap – PySide.QtGui.QPixmap

PySide.QtGui.QWizardPage.setSubTitle(subTitle)

Parameters:subTitle – unicode

This property holds the subtitle of the page.

The subtitle is shown by the PySide.QtGui.QWizard , between the title and the actual page. Subtitles are optional. In ClassicStyle and ModernStyle , using subtitles is necessary to make the header appear. In MacStyle , the subtitle is shown as a text label just above the actual page.

The subtitle may be plain text or HTML, depending on the value of the QWizard.subTitleFormat property.

By default, this property contains an empty string.

See also

PySide.QtGui.QWizardPage.title() QWizard.IgnoreSubTitles Elements of a Wizard Page

PySide.QtGui.QWizardPage.setTitle(title)

Parameters:title – unicode

This property holds the title of the page.

The title is shown by the PySide.QtGui.QWizard , above the actual page. All pages should have a title.

The title may be plain text or HTML, depending on the value of the QWizard.titleFormat property.

By default, this property contains an empty string.

See also

PySide.QtGui.QWizardPage.subTitle() Elements of a Wizard Page

PySide.QtGui.QWizardPage.subTitle()

Return type:unicode

This property holds the subtitle of the page.

The subtitle is shown by the PySide.QtGui.QWizard , between the title and the actual page. Subtitles are optional. In ClassicStyle and ModernStyle , using subtitles is necessary to make the header appear. In MacStyle , the subtitle is shown as a text label just above the actual page.

The subtitle may be plain text or HTML, depending on the value of the QWizard.subTitleFormat property.

By default, this property contains an empty string.

See also

PySide.QtGui.QWizardPage.title() QWizard.IgnoreSubTitles Elements of a Wizard Page

PySide.QtGui.QWizardPage.title()

Return type:unicode

This property holds the title of the page.

The title is shown by the PySide.QtGui.QWizard , above the actual page. All pages should have a title.

The title may be plain text or HTML, depending on the value of the QWizard.titleFormat property.

By default, this property contains an empty string.

See also

PySide.QtGui.QWizardPage.subTitle() Elements of a Wizard Page

PySide.QtGui.QWizardPage.validatePage()

Return type:PySide.QtCore.bool

This virtual function is called by QWizard.validateCurrentPage() when the user clicks Next or Finish to perform some last-minute validation. If it returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

The default implementation returns true.

When possible, it is usually better style to disable the Next or Finish button (by specifying mandatory fields or reimplementing PySide.QtGui.QWizardPage.isComplete() ) than to reimplement PySide.QtGui.QWizardPage.validatePage() .

See also

QWizard.validateCurrentPage() PySide.QtGui.QWizardPage.isComplete()

PySide.QtGui.QWizardPage.wizard()

Return type:PySide.QtGui.QWizard

Returns the wizard associated with this page, or 0 if this page hasn’t been inserted into a PySide.QtGui.QWizard yet.

See also

QWizard.addPage() QWizard.setPage()