Skip to content

PythonQt.QtGui.QWizard · declarations 003

Back to PythonQt.QtGui.QWizard

setOption

setOption(option: Any, on: bool) -> None

X.setOption(option, on)

Supplemental documentation: Qt 5 reference:

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

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options, testOption(), and setWizardStyle().

Upstream PySide2 reference signatures (binding differences may apply):

setOption(self, option: PySide2.QtWidgets.QWizard.WizardOption, on: bool=...) -> None

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

setOptions

setOptions(options: Any) -> None

X.setOptions(options)

Upstream PySide2 reference signatures (binding differences may apply):

setOptions(self, options: PySide2.QtWidgets.QWizard.WizardOptions) -> None

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

setPage

setPage(id: int, page: Any) -> None

X.setPage(id, page)

Supplemental documentation: Qt 5 reference:

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

Adds the given page to the wizard with the given id.

Note: Adding a page may influence the value of the startId property in case it was not set explicitly.

See also addPage(), page(), and pageAdded().

Upstream PySide2 reference signatures (binding differences may apply):

setPage(self, id: int, page: PySide2.QtWidgets.QWizardPage) -> None

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

setPixmap

setPixmap(which: Any, pixmap: Any) -> None

X.setPixmap(which, pixmap)

Supplemental documentation: Qt 5 reference:

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

Sets the pixmap for role which to pixmap.

The pixmaps are used by QWizard when displaying a page. Which pixmaps are actually used depend on the wizard style.

Pixmaps can also be set for a specific page using QWizardPage::setPixmap().

See also pixmap(), QWizardPage::setPixmap(), and Elements of a Wizard Page.

Upstream PySide2 reference signatures (binding differences may apply):

setPixmap(self, which: PySide2.QtWidgets.QWizard.WizardPixmap, pixmap: PySide2.QtGui.QPixmap) -> None

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

setSideWidget

setSideWidget(widget: Any) -> None

X.setSideWidget(widget)

Supplemental documentation: Qt 5 reference:

void QWizard::setSideWidget(QWidget *widget)

Sets the given widget to be shown on the left side of the wizard. For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle) the side widget is displayed on top of the watermark, for other styles or when the watermark is not provided the side widget is displayed on the left side of the wizard.

Passing nullptr shows no side widget.

When the widget is not nullptr the wizard reparents it.

Any previous side widget is hidden.

You may call setSideWidget() with the same widget at different times.

All widgets set here will be deleted by the wizard when it is destroyed unless you separately reparent the widget after setting some other side widget (or nullptr).

By default, no side widget is present.

This function was introduced in Qt 4.7.

See also sideWidget().

Upstream PySide2 reference signatures (binding differences may apply):

setSideWidget(self, widget: PySide2.QtWidgets.QWidget) -> None

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

setStartId

setStartId(id: int) -> None

X.setStartId(id)

Upstream PySide2 reference signatures (binding differences may apply):

setStartId(self, id: int) -> None

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

setSubTitleFormat

setSubTitleFormat(format: Any) -> None

X.setSubTitleFormat(format)

Upstream PySide2 reference signatures (binding differences may apply):

setSubTitleFormat(self, format: PySide2.QtCore.Qt.TextFormat) -> None

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

setTitleFormat

setTitleFormat(format: Any) -> None

X.setTitleFormat(format)

Upstream PySide2 reference signatures (binding differences may apply):

setTitleFormat(self, format: PySide2.QtCore.Qt.TextFormat) -> None

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

setVisible

setVisible(visible: bool) -> None

X.setVisible(visible)

Supplemental documentation: Qt 5 reference:

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

Reimplements: QDialog::setVisible(bool visible).

Upstream PySide2 reference signatures (binding differences may apply):

setVisible(self, visible: bool) -> None

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

setWizardStyle

setWizardStyle(style: Any) -> None

X.setWizardStyle(style)

Upstream PySide2 reference signatures (binding differences may apply):

setWizardStyle(self, style: PySide2.QtWidgets.QWizard.WizardStyle) -> None

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

sideWidget

sideWidget() -> Any

X.sideWidget() -> PythonQt.QtGui.QWidget

Supplemental documentation: Qt 5 reference:

QWidget *QWizard::sideWidget() const

Returns the widget on the left side of the wizard or nullptr.

By default, no side widget is present.

This function was introduced in Qt 4.7.

See also setSideWidget().

Upstream PySide2 reference signatures (binding differences may apply):

sideWidget(self) -> PySide2.QtWidgets.QWidget

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

sizeHint instance-attribute

sizeHint: QSize

Qt 5 reference:

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

Reimplements: QDialog::sizeHint() const.

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

startId instance-attribute

startId: int

Qt 5 reference:

startId : int

This property holds the ID of the first page

If this property isn't explicitly set, this property defaults to the lowest page ID in this wizard, or -1 if no page has been inserted yet.

Access functions:

int startId() const
void setStartId(int id)

See also restart() and nextId().

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

subTitleFormat instance-attribute

subTitleFormat: Any

Qt 5 reference:

subTitleFormat : Qt::TextFormat

This property holds the text format used by page subtitles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat subTitleFormat() const
void setSubTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and titleFormat.

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

testOption

testOption(option: Any) -> bool

X.testOption(option) -> bool

Supplemental documentation: Qt 5 reference:

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

Returns true if the given option is enabled; otherwise, returns false.

See also options, setOption(), and setWizardStyle().

Upstream PySide2 reference signatures (binding differences may apply):

testOption(self, option: PySide2.QtWidgets.QWizard.WizardOption) -> bool

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

titleFormat instance-attribute

titleFormat: Any

Qt 5 reference:

titleFormat : Qt::TextFormat

This property holds the text format used by page titles

The default format is Qt::AutoText.

Access functions:

Qt::TextFormat titleFormat() const
void setTitleFormat(Qt::TextFormat format)

See also QWizardPage::title and subTitleFormat.

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

validateCurrentPage

validateCurrentPage() -> bool

X.validateCurrentPage() -> bool

Supplemental documentation: Qt 5 reference:

[virtual] bool QWizard::validateCurrentPage()

This virtual function is called by QWizard 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 calls QWizardPage::validatePage() on the currentPage().

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

See also QWizardPage::validatePage() and currentPage().

Upstream PySide2 reference signatures (binding differences may apply):

validateCurrentPage(self) -> bool

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

visitedPages

visitedPages() -> tuple

X.visitedPages() -> tuple

Upstream PySide2 reference signatures (binding differences may apply):

visitedPages(self) -> typing.List[int]

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

windowIconChanged

windowIconChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWizard.windowIconChanged; argument details are not documented.

windowIconTextChanged

windowIconTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWizard.windowIconTextChanged; argument details are not documented.

windowTitleChanged

windowTitleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWizard.windowTitleChanged; argument details are not documented.

wizardStyle instance-attribute

wizardStyle: Any

Qt 5 reference:

wizardStyle : WizardStyle

This property holds the look and feel of the wizard

By default, QWizard uses the AeroStyle on a Windows Vista system with alpha compositing enabled, regardless of the current widget style. If this is not the case, the default wizard style depends on the current widget style as follows: MacStyle is the default if the current widget style is QMacStyle, ModernStyle is the default if the current widget style is QWindowsStyle, and ClassicStyle is the default in all other cases.

Access functions:

QWizard::WizardStyle wizardStyle() const
void setWizardStyle(QWizard::WizardStyle style)

See also Wizard Look and Feel and options.

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