Skip to content

PythonQt.QtGui.QWizard

QWizard

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A wizard (also called an assistant on macOS) is a special type of input dialog that consists of a sequence of pages. A wizard's purpose is to guide the user through a process step by step. Wizards are useful for complex or infrequent tasks that users may find difficult to learn.

QWizard inherits QDialog and represents a wizard. Each page is a QWizardPage (a QWidget subclass). To create your own wizards, you can use these classes directly, or you can subclass them for more control.

Topics:

A Trivial Example

The following example illustrates how to create wizard pages and add them to a wizard. For more advanced examples, see Class Wizard and License Wizard.

QWizardPage *createIntroPage()
{
    QWizardPage *page = new QWizardPage;
    page->setTitle("Introduction");

    QLabel *label = new QLabel("This wizard will help you register your copy "
                               "of Super Product Two.");
    label->setWordWrap(true);

    QVBoxLayout *layout = new QVBoxLayout;
    layout->addWidget(label);
    page->setLayout(layout);

    return page;
}

QWizardPage *createRegistrationPage()
{
    ...
}

QWizardPage *createConclusionPage()
{
    ...
}

int main(int argc, char *argv[])
{
    QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps);

    QApplication app(argc, argv);

#ifndef QT_NO_TRANSLATION
    QString translatorFileName = QLatin1String("qtbase_");
    translatorFileName += QLocale::system().name();
    QTranslator *translator = new QTranslator(&app);
    if (translator->load(translatorFileName, QLibraryInfo::location(QLibraryInfo::TranslationsPath)))
        app.installTranslator(translator);
#endif

    QWizard wizard;
    wizard.addPage(createIntroPage());
    wizard.addPage(createRegistrationPage());
    wizard.addPage(createConclusionPage());

    wizard.setWindowTitle("Trivial Wizard");
    wizard.show();

    return app.exec();
}

Wizard Look and Feel

QWizard supports four wizard looks:

You can explicitly set the look to use using setWizardStyle() (e.g., if you want the same look on all platforms).

ClassicStyle ModernStyle MacStyle AeroStyle

Note: AeroStyle has effect only on a Windows Vista system with alpha compositing enabled. ModernStyle is used as a fallback when this condition is not met.

In addition to the wizard style, there are several options that control the look and feel of the wizard. These can be set using setOption() or setOptions(). For example, HaveHelpButton makes QWizard show a Help button along with the other wizard buttons.

You can even change the order of the wizard buttons to any arbitrary order using setButtonLayout(), and you can add up to three custom buttons (e.g., a Print button) to the button row. This is achieved by calling setButton() or setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set up the button, and by enabling the HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 options. Whenever the user clicks a custom button, customButtonClicked() is emitted. For example:

        wizard()->setButtonText(QWizard::CustomButton1, tr("&Print"));
        wizard()->setOption(QWizard::HaveCustomButton1, true);
        connect(wizard(), &QWizard::customButtonClicked,
                this, &ConclusionPage::printButtonClicked);

Elements of a Wizard Page

Wizards consist of a sequence of QWizardPages. At any time, only one page is shown. A page has the following attributes:

The diagram belows shows how QWizard renders these attributes, assuming they are all present and ModernStyle is used:

When a subTitle is set, QWizard displays it in a header, in which case it also uses the BannerPixmap and the LogoPixmap to decorate the header. The WatermarkPixmap is displayed on the left side, below the header. At the bottom, there is a row of buttons allowing the user to navigate through the pages.

The page itself (the QWizardPage widget) occupies the area between the header, the watermark, and the button row. Typically, the page is a QWizardPage on which a QGridLayout is installed, with standard child widgets (QLabels, QLineEdits, etc.).

If the wizard's style is MacStyle, the page looks radically different:

The watermark, banner, and logo pixmaps are ignored by the MacStyle. If the BackgroundPixmap is set, it is used as the background for the wizard; otherwise, a default "assistant" image is used.

The title and subtitle are set by calling QWizardPage::setTitle() and QWizardPage::setSubTitle() on the individual pages. They may be plain text or HTML (see titleFormat and subTitleFormat). The pixmaps can be set globally for the entire wizard using setPixmap(), or on a per-page basis using QWizardPage::setPixmap().

Registering and Using Fields

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. It is also possible to specify mandatory fields (i.e., fields that must be filled before the user can advance to the next page).

To register a field, call QWizardPage::registerField() field. For example:

ClassInfoPage::ClassInfoPage(QWidget *parent)
    : QWizardPage(parent)
{
    ...
    classNameLabel = new QLabel(tr("&Class name:"));
    classNameLineEdit = new QLineEdit;
    classNameLabel->setBuddy(classNameLineEdit);

    baseClassLabel = new QLabel(tr("B&ase class:"));
    baseClassLineEdit = new QLineEdit;
    baseClassLabel->setBuddy(baseClassLineEdit);

    qobjectMacroCheckBox = new QCheckBox(tr("Generate Q_OBJECT &macro"));

    registerField("className*", classNameLineEdit);
    registerField("baseClass", baseClassLineEdit);
    registerField("qobjectMacro", qobjectMacroCheckBox);
    ...
}

The above code registers three fields, className, baseClass, and qobjectMacro, which are associated with three child widgets. The asterisk (*) next to className denotes a mandatory field.

The fields of any page are accessible from any other page. For example:

void OutputFilesPage::initializePage()
{
    QString className = field("className").toString();
    headerLineEdit->setText(className.toLower() + ".h");
    implementationLineEdit->setText(className.toLower() + ".cpp");
    outputDirLineEdit->setText(QDir::toNativeSeparators(QDir::tempPath()));
}

Here, we call QWizardPage::field() to access the contents of the className field (which was defined in the ClassInfoPage) and use it to initialize the OutputFilePage. The field's contents is returned as a QVariant.

When we create a field using QWizardPage::registerField(), we pass a unique field name and a widget. We can also provide a Qt property name and a "changed" signal (a signal that is emitted when the property changes) as third and fourth arguments; however, this is not necessary for the most common Qt widgets, such as QLineEdit, QCheckBox, and QComboBox, because QWizard knows which properties to look for.

If an asterisk (*) is appended to the name when the property is registered, 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.

To consider a field "filled", QWizard simply checks that the field's current value doesn't equal the original value (the value it had when initializePage() was called). For QLineEdit and QAbstractSpinBox subclasses, QWizard also checks that hasAcceptableInput() returns true, to honor any validator or mask.

QWizard's mandatory field mechanism is provided for convenience. A more powerful (but also more cumbersome) alternative is to reimplement QWizardPage::isComplete() and to emit the QWizardPage::completeChanged() signal whenever the page becomes complete or incomplete.

The enabled/disabled state of the Next and/or Finish buttons is one way to perform validation on the user input. Another way is to reimplement validateCurrentPage() (or QWizardPage::validatePage()) to perform some last-minute validation (and show an error message if the user has entered incomplete or invalid information). If the function returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

Creating Linear Wizards

Most wizards have a linear structure, with page 1 followed by page 2 and so on until the last page. The Class Wizard example is such a wizard. With QWizard, linear wizards are created by instantiating the QWizardPages and inserting them using addPage(). By default, the pages are shown in the order in which they were added. For example:

ClassWizard::ClassWizard(QWidget *parent)
    : QWizard(parent)
{
    addPage(new IntroPage);
    addPage(new ClassInfoPage);
    addPage(new CodeStylePage);
    addPage(new OutputFilesPage);
    addPage(new ConclusionPage);
    ...
}

When a page is about to be shown, QWizard calls initializePage() (which in turn calls QWizardPage::initializePage()) to fill the page with default values. By default, this function does nothing, but it can be reimplemented to initialize the page's contents based on other pages' fields (see the example above).

If the user presses Back, cleanupPage() is called (which in turn calls QWizardPage::cleanupPage()). The default implementation resets the page's fields to their original values (the values they had before initializePage() was called). If you want the Back button to be non-destructive and keep the values entered by the user, simply enable the IndependentPages option.

Creating Non-Linear Wizards

Some wizards are more complex in that they allow different traversal paths based on the information provided by the user. The License Wizard example illustrates this. It provides five wizard pages; depending on which options are selected, the user can reach different pages.

In complex wizards, pages are identified by IDs. These IDs are typically defined using an enum. For example:

class LicenseWizard : public QWizard
{
    ...
    enum { Page_Intro, Page_Evaluate, Page_Register, Page_Details,
           Page_Conclusion };
    ...
};

The pages are inserted using setPage(), which takes an ID and an instance of QWizardPage (or of a subclass):

LicenseWizard::LicenseWizard(QWidget *parent)
    : QWizard(parent)
{
    setPage(Page_Intro, new IntroPage);
    setPage(Page_Evaluate, new EvaluatePage);
    setPage(Page_Register, new RegisterPage);
    setPage(Page_Details, new DetailsPage);
    setPage(Page_Conclusion, new ConclusionPage);
    ...
}

By default, the pages are shown in increasing ID order. To provide a dynamic order that depends on the options chosen by the user, we must reimplement QWizardPage::nextId(). For example:

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

int EvaluatePage::nextId() const
{
    return LicenseWizard::Page_Conclusion;
}

int RegisterPage::nextId() const
{
    if (upgradeKeyLineEdit->text().isEmpty()) {
        return LicenseWizard::Page_Details;
    } else {
        return LicenseWizard::Page_Conclusion;
    }
}

int DetailsPage::nextId() const
{
    return LicenseWizard::Page_Conclusion;
}

int ConclusionPage::nextId() const
{
    return -1;
}

It would also be possible to put all the logic in one place, in a QWizard::nextId() reimplementation. For example:

int LicenseWizard::nextId() const
{
    switch (currentId()) {
    case Page_Intro:
        if (field("intro.evaluate").toBool()) {
            return Page_Evaluate;
        } else {
            return Page_Register;
        }
    case Page_Evaluate:
        return Page_Conclusion;
    case Page_Register:
        if (field("register.upgradeKey").toString().isEmpty()) {
            return Page_Details;
        } else {
            return Page_Conclusion;
        }
    case Page_Details:
        return Page_Conclusion;
    case Page_Conclusion:
    default:
        return -1;
    }
}

To start at another page than the page with the lowest ID, call setStartId().

To test whether a page has been visited or not, call hasVisitedPage(). For example:

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)) {
        licenseText = tr("<u>First-Time License Agreement:</u> "
                         "You can use this software subject to the license "
                         "you will receive by email.");
    } else {
        licenseText = tr("<u>Upgrade License Agreement:</u> "
                         "This software is licensed under the terms of your "
                         "current license.");
    }
    bottomLabel->setText(licenseText);
}

Source: https://doc.qt.io/archives/qt-5.15/qwizard.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
Accepted attribute Any (shared captured text)
AeroStyle attribute Any
BackButton attribute Any (shared captured text)
BackgroundPixmap attribute Any
BannerPixmap attribute Any
CancelButton attribute Any
CancelButtonOnLeft attribute Any
ClassicStyle attribute Any
CommitButton attribute Any
CustomButton1 attribute Any
CustomButton2 attribute Any
CustomButton3 attribute Any
DialogCode attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
DisabledBackButtonOnLastPage attribute Any
DrawChildren attribute Any (shared captured text)
DrawWindowBackground attribute Any (shared captured text)
ExtendedWatermarkPixmap attribute Any
FinishButton attribute Any
HaveCustomButton1 attribute Any
HaveCustomButton2 attribute Any
HaveCustomButton3 attribute Any
HaveFinishButtonOnEarlyPages attribute Any
HaveHelpButton attribute Any
HaveNextButtonOnLastPage attribute Any
HelpButton attribute Any
HelpButtonOnRight attribute Any
IgnoreMask attribute Any (shared captured text)
IgnoreSubTitles attribute Any
IndependentPages attribute Any
LogoPixmap attribute Any
MacStyle attribute Any
ModernStyle attribute Any
NButtons attribute Any
NPixmaps attribute Any
NStandardButtons attribute Any
NStyles attribute Any
NextButton attribute Any
NoBackButtonOnLastPage attribute Any
NoBackButtonOnStartPage attribute Any
NoButton attribute Any (shared captured text)
NoCancelButton attribute Any
NoCancelButtonOnLastPage attribute Any
NoDefaultButton attribute Any
PaintDeviceMetric attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
PdmDepth attribute Any (shared captured text)
PdmDevicePixelRatio attribute Any (shared captured text)
PdmDevicePixelRatioScaled attribute Any (shared captured text)
PdmDpiX attribute Any (shared captured text)
PdmDpiY attribute Any (shared captured text)
PdmHeight attribute Any (shared captured text)
PdmHeightMM attribute Any (shared captured text)
PdmNumColors attribute Any (shared captured text)
PdmPhysicalDpiX attribute Any (shared captured text)
PdmPhysicalDpiY attribute Any (shared captured text)
PdmWidth attribute Any (shared captured text)
PdmWidthMM attribute Any (shared captured text)
Rejected attribute Any (shared captured text)
RenderFlag attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
RenderFlags attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
Stretch attribute Any (shared captured text)
WatermarkPixmap attribute Any
WizardButton attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
WizardOption attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
WizardOptions attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
WizardPixmap attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
WizardStyle attribute type Convert a number or string to an integer, or return 0 if no arguments are given.
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
accept function (self) -> Any (shared captured text)
acceptDrops attribute Any (shared captured text)
accepted function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.accepted; argument details are not documented.
accessibleDescription attribute Any (shared captured text)
accessibleName attribute Any (shared captured text)
actionEvent function (self, event: Any) -> Any (shared captured text)
actions function (self) -> tuple X.actions() -> tuple (shared captured text)
activateWindow function (self) -> Any (shared captured text)
addAction function (self, action: Any) -> Any (shared captured text)
addActions function (self, actions: Any) -> Any (shared captured text)
addPage function (self, page: Any) -> int X.addPage(page) -> int
adjustPosition function (self, arg__1: Any) -> Any (shared captured text)
adjustSize function (self) -> Any (shared captured text)
autoFillBackground attribute Any (shared captured text)
back function (self) -> None Goes back to the previous page.
backgroundRole function (self) -> Any (shared captured text)
backingStore function (self) -> Any X.backingStore() -> PythonQt.QtGui.QBackingStore (shared captured text)
baseSize attribute QSize (shared captured text)
blockSignals function (self, b: Any) -> bool X.blockSignals(b) -> bool (shared captured text)
button function (self, which: Any) -> Any X.button(which) -> PythonQt.QtGui.QAbstractButton
buttonText function (self, which: Any) -> str X.buttonText(which) -> str
changeEvent function (self, arg__1: Any) -> Any (shared captured text)
childAt function (self, x: Any, y: Any) -> Any X.childAt(x, y) -> PythonQt.QtGui.QWidget (shared captured text)
childEvent function (self, event: Any) -> Any (shared captured text)
children function (self) -> tuple X.children() -> tuple (shared captured text)
childrenRect attribute QRect (shared captured text)
childrenRegion attribute QRegion (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
cleanupPage function (self, id: int) -> None This virtual function is called by [QWizard](https://doc.qt.io/archives/qt-5.15/qwizard.html) to clean up page id just before the user leaves it by clicking Back (unless the…
clearFocus function (self) -> Any (shared captured text)
clearMask function (self) -> Any (shared captured text)
close function (self) -> bool X.close() -> bool (shared captured text)
closeEvent function (self, arg__1: Any) -> Any (shared captured text)
colorCount function (self) -> int X.colorCount() -> int (shared captured text)
connect function (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool X.connect(signal, receiver, slot, type) -> bool (shared captured text)
contentsMargins function (self) -> Any X.contentsMargins() -> PythonQt.QtGui.QMargins (shared captured text)
contentsRect function (self) -> Any X.contentsRect() -> PythonQt.QtCore.QRect (shared captured text)
contextMenuEvent function (self, arg__1: Any) -> Any (shared captured text)
contextMenuPolicy attribute Any (shared captured text)
createWinId function (self) -> Any (shared captured text)
createWindowContainer function (self, window: Any, parent: Any, arg2: flags) -> Any X.createWindowContainer(window, parent, flags) -> PythonQt.QtGui.QWidget (shared captured text)
currentId attribute int This property holds the ID of the current page
currentIdChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.currentIdChanged; argument details are not documented.
currentPage function (self) -> Any X.currentPage() -> PythonQt.QtGui.QWizardPage
cursor attribute QCursor (shared captured text)
customButtonClicked function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.customButtonClicked; argument details are not documented.
customContextMenuRequested function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.customContextMenuRequested; argument details are not documented.
customEvent function (self, event: Any) -> Any (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
deleteLater function (self) -> Any (shared captured text)
depth function (self) -> int X.depth() -> int (shared captured text)
destroy function (self, destroyWindow: Any, destroySubWindows: Any) -> Any X.destroy(destroyWindow, destroySubWindows) (shared captured text)
destroyed function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.destroyed; argument details are not documented.
devType function (self) -> int X.devType() -> int (shared captured text)
devicePixelRatio function (self) -> int X.devicePixelRatio() -> int (shared captured text)
devicePixelRatioF function (self) -> float X.devicePixelRatioF() -> float (shared captured text)
devicePixelRatioFScale function (self) -> float X.devicePixelRatioFScale() -> float (shared captured text)
disconnect function (self, signal: Any, receiver: Any, slot: Any) -> bool X.disconnect(signal, receiver, slot) -> bool (shared captured text)
done function (self, result: int) -> None Reimplements: [QDialog::done](https://doc.qt.io/archives/qt-5.15/qdialog.html#done)(int r).
dragEnterEvent function (self, event: Any) -> Any (shared captured text)
dragLeaveEvent function (self, event: Any) -> Any (shared captured text)
dragMoveEvent function (self, event: Any) -> Any (shared captured text)
dropEvent function (self, event: Any) -> Any (shared captured text)
dumpObjectInfo function (self) -> Any (shared captured text)
dumpObjectTree function (self) -> Any (shared captured text)
dynamicPropertyNames function (self) -> Any (shared captured text)
effectiveWinId function (self) -> int X.effectiveWinId() -> int (shared captured text)
enabled attribute Any (shared captured text)
ensurePolished function (self) -> Any (shared captured text)
enterEvent function (self, event: Any) -> Any (shared captured text)
event function (self, event: Any) -> bool X.event(event) -> bool
eventFilter function (self, arg__1: Any, arg__2: Any) -> bool X.eventFilter(arg__1, arg__2) -> bool (shared captured text)
exec function (self) -> int X.exec() -> int (shared captured text)
field function (self, name: str) -> Any X.field(name) -> object
findChild function (self, type: Any, name: Any) -> Any X.findChild(type, name) -> PythonQt.private.QObject (shared captured text)
findChildren function (self, type: Any, name: Any) -> tuple X.findChildren(type, name) -> tuple (shared captured text)
finished function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.finished; argument details are not documented.
focus attribute Any (shared captured text)
focusInEvent function (self, event: Any) -> Any (shared captured text)
focusNextChild function (self) -> bool X.focusNextChild() -> bool (shared captured text)
focusNextPrevChild function (self, next: Any) -> bool X.focusNextPrevChild(next) -> bool (shared captured text)
focusOutEvent function (self, event: Any) -> Any (shared captured text)
focusPolicy attribute Any (shared captured text)
focusPreviousChild function (self) -> bool X.focusPreviousChild() -> bool (shared captured text)
focusProxy function (self) -> Any X.focusProxy() -> PythonQt.QtGui.QWidget (shared captured text)
focusWidget function (self) -> Any X.focusWidget() -> PythonQt.QtGui.QWidget (shared captured text)
font attribute QFont (shared captured text)
fontInfo function (self) -> Any X.fontInfo() -> PythonQt.QtGui.QFontInfo (shared captured text)
fontMetrics function (self) -> Any X.fontMetrics() -> PythonQt.QtGui.QFontMetrics (shared captured text)
foregroundRole function (self) -> Any (shared captured text)
frameGeometry attribute QRect (shared captured text)
frameSize attribute QSize (shared captured text)
fullScreen attribute Any (shared captured text)
geometry attribute QRect (shared captured text)
grab function (self, rectangle: Any) -> Any X.grab(rectangle) -> PythonQt.QtGui.QPixmap (shared captured text)
grabGesture function (self, type: Any, arg1: flags) -> Any X.grabGesture(type, flags) (shared captured text)
grabKeyboard function (self) -> Any (shared captured text)
grabMouse function (self, arg__1: Any) -> Any (shared captured text)
grabShortcut function (self, key: Any, context: Any) -> int X.grabShortcut(key, context) -> int (shared captured text)
graphicsEffect function (self) -> Any X.graphicsEffect() -> PythonQt.QtGui.QGraphicsEffect (shared captured text)
graphicsProxyWidget function (self) -> Any X.graphicsProxyWidget() -> PythonQt.QtGui.QGraphicsProxyWidget (shared captured text)
hasFocus function (self) -> bool X.hasFocus() -> bool (shared captured text)
hasHeightForWidth function (self) -> bool X.hasHeightForWidth() -> bool (shared captured text)
hasMouseTracking function (self) -> bool X.hasMouseTracking() -> bool (shared captured text)
hasVisitedPage function (self, id: int) -> bool X.hasVisitedPage(id) -> bool
height attribute Any (shared captured text)
heightForWidth function (self, arg__1: Any) -> int X.heightForWidth(arg__1) -> int (shared captured text)
heightMM function (self) -> int X.heightMM() -> int (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
helpRequested function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.helpRequested; argument details are not documented.
hide function (self) -> Any (shared captured text)
hideEvent function (self, event: Any) -> Any (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
initPainter function (self, painter: Any) -> Any (shared captured text)
initializePage function (self, id: int) -> None This virtual function is called by [QWizard](https://doc.qt.io/archives/qt-5.15/qwizard.html) to prepare page id just before it is shown either as a result of…
inputMethodEvent function (self, arg__1: Any) -> Any (shared captured text)
inputMethodHints attribute Any (shared captured text)
inputMethodQuery function (self, arg__1: Any) -> Any X.inputMethodQuery(arg__1) -> object (shared captured text)
insertAction function (self, before: Any, action: Any) -> Any X.insertAction(before, action) (shared captured text)
insertActions function (self, before: Any, actions: Any) -> Any X.insertActions(before, actions) (shared captured text)
installEventFilter function (self, filterObj: Any) -> Any (shared captured text)
isActiveWindow attribute Any (shared captured text)
isAncestorOf function (self, child: Any) -> bool X.isAncestorOf(child) -> bool (shared captured text)
isEnabled function (self) -> bool X.isEnabled() -> bool (shared captured text)
isEnabledTo function (self, arg__1: Any) -> bool X.isEnabledTo(arg__1) -> bool (shared captured text)
isFullScreen function (self) -> bool X.isFullScreen() -> bool (shared captured text)
isHidden function (self) -> bool X.isHidden() -> bool (shared captured text)
isLeftToRight function (self) -> bool X.isLeftToRight() -> bool (shared captured text)
isMaximized function (self) -> bool X.isMaximized() -> bool (shared captured text)
isMinimized function (self) -> bool X.isMinimized() -> bool (shared captured text)
isModal function (self) -> bool X.isModal() -> bool (shared captured text)
isRightToLeft function (self) -> bool X.isRightToLeft() -> bool (shared captured text)
isSignalConnected function (self, signal: Any) -> bool X.isSignalConnected(signal) -> bool (shared captured text)
isSizeGripEnabled function (self) -> bool X.isSizeGripEnabled() -> bool (shared captured text)
isVisible function (self) -> bool X.isVisible() -> bool (shared captured text)
isVisibleTo function (self, arg__1: Any) -> bool X.isVisibleTo(arg__1) -> bool (shared captured text)
isWidgetType function (self) -> bool X.isWidgetType() -> bool (shared captured text)
isWindow function (self) -> bool X.isWindow() -> bool (shared captured text)
isWindowModified function (self) -> bool X.isWindowModified() -> bool (shared captured text)
isWindowType function (self) -> bool X.isWindowType() -> bool (shared captured text)
keyPressEvent function (self, arg__1: Any) -> Any (shared captured text)
keyReleaseEvent function (self, event: Any) -> Any (shared captured text)
keyboardGrabber function (self) -> Any X.keyboardGrabber() -> PythonQt.QtGui.QWidget (shared captured text)
killTimer function (self, id: Any) -> Any (shared captured text)
layout function (self) -> Any X.layout() -> PythonQt.QtGui.QLayout (shared captured text)
layoutDirection attribute Any (shared captured text)
leaveEvent function (self, event: Any) -> Any (shared captured text)
locale attribute QLocale (shared captured text)
logicalDpiX function (self) -> int X.logicalDpiX() -> int (shared captured text)
logicalDpiY function (self) -> int X.logicalDpiY() -> int (shared captured text)
lower function (self) -> Any (shared captured text)
mapFrom function (self, arg__1: Any, arg__2: Any) -> Any X.mapFrom(arg__1, arg__2) -> PythonQt.QtCore.QPoint (shared captured text)
mapFromGlobal function (self, arg__1: Any) -> Any X.mapFromGlobal(arg__1) -> PythonQt.QtCore.QPoint (shared captured text)
mapFromParent function (self, arg__1: Any) -> Any X.mapFromParent(arg__1) -> PythonQt.QtCore.QPoint (shared captured text)
mapTo function (self, arg__1: Any, arg__2: Any) -> Any X.mapTo(arg__1, arg__2) -> PythonQt.QtCore.QPoint (shared captured text)
mapToGlobal function (self, arg__1: Any) -> Any X.mapToGlobal(arg__1) -> PythonQt.QtCore.QPoint (shared captured text)
mapToParent function (self, arg__1: Any) -> Any X.mapToParent(arg__1) -> PythonQt.QtCore.QPoint (shared captured text)
mask function (self) -> Any X.mask() -> PythonQt.QtGui.QRegion (shared captured text)
maximized attribute Any (shared captured text)
maximumHeight attribute Any (shared captured text)
maximumSize attribute QSize (shared captured text)
maximumWidth attribute Any (shared captured text)
metaObject function (self) -> Any X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text)
metric function (self, arg__1: Any) -> int X.metric(arg__1) -> int (shared captured text)
minimized attribute Any (shared captured text)
minimumHeight attribute Any (shared captured text)
minimumSize attribute QSize (shared captured text)
minimumSizeHint attribute QSize (shared captured text)
minimumWidth attribute Any (shared captured text)
modal attribute Any (shared captured text)
mouseDoubleClickEvent function (self, event: Any) -> Any (shared captured text)
mouseGrabber function (self) -> Any X.mouseGrabber() -> PythonQt.QtGui.QWidget (shared captured text)
mouseMoveEvent function (self, event: Any) -> Any (shared captured text)
mousePressEvent function (self, event: Any) -> Any (shared captured text)
mouseReleaseEvent function (self, event: Any) -> Any (shared captured text)
mouseTracking attribute Any (shared captured text)
move function (self, x: Any, y: Any) -> Any X.move(x, y) (shared captured text)
moveEvent function (self, event: Any) -> Any (shared captured text)
moveToThread function (self, thread: Any) -> Any (shared captured text)
nativeEvent function (self, eventType: Any, message: Any, result: Any) -> bool X.nativeEvent(eventType, message, result) -> bool
nativeParentWidget function (self) -> Any X.nativeParentWidget() -> PythonQt.QtGui.QWidget (shared captured text)
next function (self) -> None Advances to the next page.
nextId function (self) -> int X.nextId() -> int
nextInFocusChain function (self) -> Any X.nextInFocusChain() -> PythonQt.QtGui.QWidget (shared captured text)
normalGeometry attribute QRect (shared captured text)
objectName attribute Any (shared captured text)
objectNameChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.objectNameChanged; argument details are not documented.
open function (self) -> Any (shared captured text)
options attribute Any This property holds the various options that affect the look and feel of the wizard
overrideWindowFlags function (self, type: Any) -> Any (shared captured text)
overrideWindowState function (self, state: Any) -> Any (shared captured text)
page function (self, id: int) -> Any X.page(id) -> PythonQt.QtGui.QWizardPage
pageAdded function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.pageAdded; argument details are not documented.
pageIds function (self) -> tuple X.pageIds() -> tuple
pageRemoved function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.pageRemoved; argument details are not documented.
paintEngine function (self) -> Any X.paintEngine() -> PythonQt.QtGui.QPaintEngine (shared captured text)
paintEvent function (self, event: Any) -> None Reimplements: [QWidget::paintEvent](https://doc.qt.io/archives/qt-5.15/qwidget.html#paintEvent)(QPaintEvent *event).
paintingActive function (self) -> bool X.paintingActive() -> bool (shared captured text)
palette attribute QPalette (shared captured text)
parent function (self) -> Any X.parent() -> PythonQt.private.QObject (shared captured text)
parentWidget function (self) -> Any X.parentWidget() -> PythonQt.QtGui.QWidget (shared captured text)
physicalDpiX function (self) -> int X.physicalDpiX() -> int (shared captured text)
physicalDpiY function (self) -> int X.physicalDpiY() -> int (shared captured text)
pixmap function (self, which: Any) -> Any X.pixmap(which) -> PythonQt.QtGui.QPixmap
pos attribute QPoint (shared captured text)
previousInFocusChain function (self) -> Any X.previousInFocusChain() -> PythonQt.QtGui.QWidget (shared captured text)
property function (self, name: Any) -> Any X.property(name) -> object (shared captured text)
raise_ function (self) -> Any Native spelling: raise; access it through getattr on the native object. (shared captured text)
rect attribute QRect (shared captured text)
redirected function (self, offset: Any) -> Any X.redirected(offset) -> PythonQt.QtGui.QPaintDevice (shared captured text)
reject function (self) -> Any (shared captured text)
rejected function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.rejected; argument details are not documented.
releaseKeyboard function (self) -> Any (shared captured text)
releaseMouse function (self) -> Any (shared captured text)
releaseShortcut function (self, id: Any) -> Any (shared captured text)
removeAction function (self, action: Any) -> Any (shared captured text)
removeEventFilter function (self, obj: Any) -> Any (shared captured text)
removePage function (self, id: int) -> None Removes the page with the given id.
render function (self, target: Any, targetOffset: Any, sourceRegion: Any, renderFlags: Any) -> Any X.render(target, targetOffset, sourceRegion, renderFlags) (shared captured text)
repaint function (self, x: Any, y: Any, w: Any, h: Any) -> Any X.repaint(x, y, w, h) (shared captured text)
resize function (self, w: Any, h: Any) -> Any X.resize(w, h) (shared captured text)
resizeEvent function (self, event: Any) -> None Reimplements: [QDialog::resizeEvent](https://doc.qt.io/archives/qt-5.15/qdialog.html#resizeEvent)(QResizeEvent *).
restart function (self) -> None Restarts the wizard at the start page.
restoreGeometry function (self, geometry: Any) -> bool X.restoreGeometry(geometry) -> bool (shared captured text)
result function (self) -> int X.result() -> int (shared captured text)
saveGeometry function (self) -> Any X.saveGeometry() -> PythonQt.QtCore.QByteArray (shared captured text)
scroll function (self, dx: Any, dy: Any, arg__3: Any) -> Any X.scroll(dx, dy, arg__3) (shared captured text)
sender function (self) -> Any X.sender() -> PythonQt.private.QObject (shared captured text)
senderSignalIndex function (self) -> int X.senderSignalIndex() -> int (shared captured text)
setAcceptDrops function (self, on: Any) -> Any (shared captured text)
setAccessibleDescription function (self, description: Any) -> Any (shared captured text)
setAccessibleName function (self, name: Any) -> Any (shared captured text)
setAttribute function (self, arg__1: Any, on: Any) -> Any X.setAttribute(arg__1, on) (shared captured text)
setAutoFillBackground function (self, enabled: Any) -> Any (shared captured text)
setBackgroundRole function (self, arg__1: Any) -> Any (shared captured text)
setBaseSize function (self, basew: Any, baseh: Any) -> Any X.setBaseSize(basew, baseh) (shared captured text)
setButton function (self, which: Any, button: Any) -> None X.setButton(which, button)
setButtonLayout function (self, layout: Any) -> None Sets the order in which buttons are displayed to layout, where layout is a list of [WizardButton](https://doc.qt.io/archives/qt-5.15/qwizard.html#WizardButton-enum)s.
setButtonText function (self, which: Any, text: str) -> None X.setButtonText(which, text)
setContentsMargins function (self, left: Any, top: Any, right: Any, bottom: Any) -> Any X.setContentsMargins(left, top, right, bottom) (shared captured text)
setContextMenuPolicy function (self, policy: Any) -> Any (shared captured text)
setCursor function (self, arg__1: Any) -> Any (shared captured text)
setDisabled function (self, a: Any) -> Any (shared captured text)
setEnabled function (self, a: Any) -> Any (shared captured text)
setField function (self, name: str, value: Any) -> None X.setField(name, value)
setFixedHeight function (self, h: Any) -> Any (shared captured text)
setFixedSize function (self, w: Any, h: Any) -> Any X.setFixedSize(w, h) (shared captured text)
setFixedWidth function (self, w: Any) -> Any (shared captured text)
setFocus function (self, reason: Any) -> Any (shared captured text)
setFocusPolicy function (self, policy: Any) -> Any (shared captured text)
setFocusProxy function (self, arg__1: Any) -> Any (shared captured text)
setFont function (self, arg__1: Any) -> Any (shared captured text)
setForegroundRole function (self, arg__1: Any) -> Any (shared captured text)
setGeometry function (self, x: Any, y: Any, w: Any, h: Any) -> Any X.setGeometry(x, y, w, h) (shared captured text)
setGraphicsEffect function (self, effect: Any) -> Any (shared captured text)
setHidden function (self, hidden: Any) -> Any (shared captured text)
setInputMethodHints function (self, hints: Any) -> Any (shared captured text)
setLayout function (self, arg__1: Any) -> Any (shared captured text)
setLayoutDirection function (self, direction: Any) -> Any (shared captured text)
setLocale function (self, locale: Any) -> Any (shared captured text)
setMask function (self, arg__1: Any) -> Any (shared captured text)
setMaximumHeight function (self, maxh: Any) -> Any (shared captured text)
setMaximumSize function (self, maxw: Any, maxh: Any) -> Any X.setMaximumSize(maxw, maxh) (shared captured text)
setMaximumWidth function (self, maxw: Any) -> Any (shared captured text)
setMinimumHeight function (self, minh: Any) -> Any (shared captured text)
setMinimumSize function (self, minw: Any, minh: Any) -> Any X.setMinimumSize(minw, minh) (shared captured text)
setMinimumWidth function (self, minw: Any) -> Any (shared captured text)
setModal function (self, modal: Any) -> Any (shared captured text)
setMouseTracking function (self, enable: Any) -> Any (shared captured text)
setObjectName function (self, name: Any) -> Any (shared captured text)
setOption function (self, option: Any, on: bool) -> None X.setOption(option, on)
setOptions function (self, options: Any) -> None
setPage function (self, id: int, page: Any) -> None X.setPage(id, page)
setPalette function (self, arg__1: Any) -> Any (shared captured text)
setParent function (self, parent: Any, f: Any) -> Any X.setParent(parent, f) (shared captured text)
setPixmap function (self, which: Any, pixmap: Any) -> None X.setPixmap(which, pixmap)
setProperty function (self, name: Any, value: Any) -> bool X.setProperty(name, value) -> bool (shared captured text)
setResult function (self, r: Any) -> Any (shared captured text)
setShortcutAutoRepeat function (self, id: Any, enable: Any) -> Any X.setShortcutAutoRepeat(id, enable) (shared captured text)
setShortcutEnabled function (self, id: Any, enable: Any) -> Any X.setShortcutEnabled(id, enable) (shared captured text)
setSideWidget function (self, widget: Any) -> None Sets the given widget to be shown on the left side of the wizard.
setSizeGripEnabled function (self, arg__1: Any) -> Any (shared captured text)
setSizeIncrement function (self, w: Any, h: Any) -> Any X.setSizeIncrement(w, h) (shared captured text)
setSizePolicy function (self, horizontal: Any, vertical: Any) -> Any X.setSizePolicy(horizontal, vertical) (shared captured text)
setStartId function (self, id: int) -> None
setStatusTip function (self, arg__1: Any) -> Any (shared captured text)
setStyle function (self, arg__1: Any) -> Any (shared captured text)
setStyleSheet function (self, styleSheet: Any) -> Any (shared captured text)
setSubTitleFormat function (self, format: Any) -> None
setTabOrder function (self, arg__1: Any, arg__2: Any) -> Any X.setTabOrder(arg__1, arg__2) (shared captured text)
setTitleFormat function (self, format: Any) -> None
setToolTip function (self, arg__1: Any) -> Any (shared captured text)
setToolTipDuration function (self, msec: Any) -> Any (shared captured text)
setUpdatesEnabled function (self, enable: Any) -> Any (shared captured text)
setVisible function (self, visible: bool) -> None Reimplements: [QDialog::setVisible](https://doc.qt.io/archives/qt-5.15/qdialog.html#setVisible)(bool visible).
setWhatsThis function (self, arg__1: Any) -> Any (shared captured text)
setWindowFilePath function (self, filePath: Any) -> Any (shared captured text)
setWindowFlags function (self, type: Any) -> Any (shared captured text)
setWindowIcon function (self, icon: Any) -> Any (shared captured text)
setWindowIconText function (self, arg__1: Any) -> Any (shared captured text)
setWindowModality function (self, windowModality: Any) -> Any (shared captured text)
setWindowModified function (self, a: Any) -> Any (shared captured text)
setWindowOpacity function (self, level: Any) -> Any (shared captured text)
setWindowRole function (self, arg__1: Any) -> Any (shared captured text)
setWindowState function (self, state: Any) -> Any (shared captured text)
setWindowTitle function (self, a: Any) -> Any (shared captured text)
setWizardStyle function (self, style: Any) -> None
sharedPainter function (self) -> Any X.sharedPainter() -> PythonQt.QtGui.QPainter (shared captured text)
show function (self) -> Any (shared captured text)
showEvent function (self, arg__1: Any) -> Any (shared captured text)
showExtension function (self, a: Any) -> Any (shared captured text)
showFullScreen function (self) -> Any (shared captured text)
showMaximized function (self) -> Any (shared captured text)
showMinimized function (self) -> Any (shared captured text)
showNormal function (self) -> Any (shared captured text)
sideWidget function (self) -> Any X.sideWidget() -> PythonQt.QtGui.QWidget
signalsBlocked function (self) -> bool X.signalsBlocked() -> bool (shared captured text)
size attribute QSize (shared captured text)
sizeGripEnabled attribute Any (shared captured text)
sizeHint attribute QSize Reimplements: [QDialog::sizeHint](https://doc.qt.io/archives/qt-5.15/qdialog.html#sizeHint)() const.
sizeIncrement attribute QSize (shared captured text)
sizePolicy attribute QSizePolicy (shared captured text)
stackUnder function (self, arg__1: Any) -> Any (shared captured text)
startId attribute int This property holds the ID of the first page
startTimer function (self, interval: Any, timerType: Any) -> int X.startTimer(interval, timerType) -> int (shared captured text)
statusTip attribute Any (shared captured text)
style function (self) -> Any X.style() -> PythonQt.QtGui.QStyle (shared captured text)
styleSheet attribute Any (shared captured text)
subTitleFormat attribute Any This property holds the text format used by page subtitles
tabletEvent function (self, event: Any) -> Any (shared captured text)
tabletTracking attribute Any (shared captured text)
testAttribute function (self, arg__1: Any) -> bool X.testAttribute(arg__1) -> bool (shared captured text)
testOption function (self, option: Any) -> bool X.testOption(option) -> bool
thread function (self) -> Any (shared captured text)
timerEvent function (self, event: Any) -> Any (shared captured text)
titleFormat attribute Any This property holds the text format used by page titles
toolTip attribute Any (shared captured text)
toolTipDuration attribute Any (shared captured text)
tr function (self, text: Any, ambig: Any, n: Any) -> str X.tr(text, ambig, n) -> str (shared captured text)
underMouse function (self) -> bool X.underMouse() -> bool (shared captured text)
ungrabGesture function (self, type: Any) -> Any (shared captured text)
unsetCursor function (self) -> Any (shared captured text)
unsetLayoutDirection function (self) -> Any (shared captured text)
unsetLocale function (self) -> Any (shared captured text)
update function (self, x: Any, y: Any, w: Any, h: Any) -> Any X.update(x, y, w, h) (shared captured text)
updateGeometry function (self) -> Any (shared captured text)
updatesEnabled attribute Any (shared captured text)
validateCurrentPage function (self) -> bool X.validateCurrentPage() -> bool
visible attribute Any (shared captured text)
visibleRegion function (self) -> Any X.visibleRegion() -> PythonQt.QtGui.QRegion (shared captured text)
visitedPages function (self) -> tuple X.visitedPages() -> tuple
whatsThis attribute Any (shared captured text)
wheelEvent function (self, event: Any) -> Any (shared captured text)
width attribute Any (shared captured text)
widthMM function (self) -> int X.widthMM() -> int (shared captured text)
winId function (self) -> int X.winId() -> int (shared captured text)
window function (self) -> Any X.window() -> PythonQt.QtGui.QWidget (shared captured text)
windowFilePath attribute Any (shared captured text)
windowFlags function (self) -> Any (shared captured text)
windowHandle function (self) -> Any X.windowHandle() -> PythonQt.QtGui.QWindow (shared captured text)
windowIcon attribute QIcon (shared captured text)
windowIconChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.windowIconChanged; argument details are not documented.
windowIconText attribute Any (shared captured text)
windowIconTextChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.windowIconTextChanged; argument details are not documented.
windowModality attribute Any (shared captured text)
windowModified attribute Any (shared captured text)
windowOpacity attribute Any (shared captured text)
windowRole function (self) -> str X.windowRole() -> str (shared captured text)
windowState function (self) -> Any (shared captured text)
windowTitle attribute Any (shared captured text)
windowTitleChanged function (self, *args: Any, **kwargs: Any) -> Any Native PythonQt.QtGui.QWizard.windowTitleChanged; argument details are not documented.
windowType function (self) -> Any (shared captured text)
wizardStyle attribute Any This property holds the look and feel of the wizard
x attribute Any (shared captured text)
y attribute Any (shared captured text)