PythonQt.QtGui.QWizard · declarations 002
Back to PythonQt.QtGui.QWizard
WizardPixmap
instance-attribute
WizardPixmap: type
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.
int('0b100', base=0) 4
WizardStyle
instance-attribute
WizardStyle: type
int([x]) -> integer int(x, base=10) -> integer
Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.
If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.
int('0b100', base=0) 4
accepted
accepted(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.accepted; argument details are not documented.
addPage
addPage(page: Any) -> int
X.addPage(page) -> int
Supplemental documentation: Qt 5 reference:
int QWizard::addPage(QWizardPage *page)
Adds the given page to the wizard, and returns the page's ID.
The ID is guaranteed to be larger than any other ID in the QWizard so far.
See also setPage(), page(), and pageAdded().
Upstream PySide2 reference signatures (binding differences may apply):
addPage(self, page: PySide2.QtWidgets.QWizardPage) -> int
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#addPage
back
back() -> None
X.back()
Supplemental documentation: Qt 5 reference:
[slot] void QWizard::back()
Goes back to the previous page.
This is equivalent to pressing the Back button.
See also next(), accept(), reject(), and restart().
Upstream PySide2 reference signatures (binding differences may apply):
back(self) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#back
button
button(which: Any) -> Any
X.button(which) -> PythonQt.QtGui.QAbstractButton
Supplemental documentation: Qt 5 reference:
QAbstractButton *QWizard::button(QWizard::WizardButton which) const
Returns the button corresponding to role which.
See also setButton() and setButtonText().
Upstream PySide2 reference signatures (binding differences may apply):
button(self, which: PySide2.QtWidgets.QWizard.WizardButton) -> PySide2.QtWidgets.QAbstractButton
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#button
buttonText
buttonText(which: Any) -> str
X.buttonText(which) -> str
Supplemental documentation: Qt 5 reference:
QString QWizard::buttonText(QWizard::WizardButton which) const
Returns the text on button which.
If a text has ben 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 button(), setButton(), setButtonText(), QWizardPage::buttonText(), and QWizardPage::setButtonText().
Upstream PySide2 reference signatures (binding differences may apply):
buttonText(self, which: PySide2.QtWidgets.QWizard.WizardButton) -> str
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#buttonText
cleanupPage
cleanupPage(id: int) -> None
X.cleanupPage(id)
Supplemental documentation: Qt 5 reference:
[virtual protected] void QWizard::cleanupPage(int id)
This virtual function is called by QWizard to clean up page id just before the user leaves it by clicking Back (unless the QWizard::IndependentPages option is set).
The default implementation calls QWizardPage::cleanupPage() on page(id).
See also QWizardPage::cleanupPage() and initializePage().
Upstream PySide2 reference signatures (binding differences may apply):
cleanupPage(self, id: int) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#cleanupPage
currentId
instance-attribute
currentId: int
Qt 5 reference:
currentId : const int
This property holds the ID of the current page
This property cannot be set directly. To change the current page, call next(), back(), or restart().
By default, this property has a value of -1, indicating that no page is currently shown.
Access functions:
| int | currentId() const |
|---|---|
Notifier signal:
| void | currentIdChanged(int id) |
|---|---|
See also currentPage().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#currentId
currentIdChanged
currentIdChanged(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.currentIdChanged; argument details are not documented.
Supplemental documentation: Qt 5 reference:
[signal] void QWizard::currentIdChanged(int id)
This signal is emitted when the current page changes, with the new current id.
Note: Notifier signal for property currentId.
See also currentId() and currentPage().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#currentIdChanged
currentPage
currentPage() -> Any
X.currentPage() -> PythonQt.QtGui.QWizardPage
Supplemental documentation: Qt 5 reference:
QWizardPage *QWizard::currentPage() const
Returns a pointer to the current page, or nullptr if there is no current page (e.g.,
before the wizard is shown).
This is equivalent to calling page(currentId()).
See also page(), currentId(), and restart().
Upstream PySide2 reference signatures (binding differences may apply):
currentPage(self) -> PySide2.QtWidgets.QWizardPage
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#currentPage
customButtonClicked
customButtonClicked(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.customButtonClicked; argument details are not documented.
Supplemental documentation: Qt 5 reference:
[signal] void QWizard::customButtonClicked(int which)
This signal is emitted when the user clicks a custom button. which can be CustomButton1, CustomButton2, or CustomButton3.
By default, no custom button is shown. Call setOption() with HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 to have one, and use setButtonText() or setButton() to configure it.
See also helpRequested().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#customButtonClicked
customContextMenuRequested
customContextMenuRequested(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.customContextMenuRequested; argument details are not documented.
destroyed
destroyed(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.destroyed; argument details are not documented.
done
done(result: int) -> None
X.done(result)
Supplemental documentation: Qt 5 reference:
[override virtual protected] void QWizard::done(int result)
Reimplements: QDialog::done(int r).
Upstream PySide2 reference signatures (binding differences may apply):
done(self, result: int) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#done
event
event(event: Any) -> bool
X.event(event) -> bool
Supplemental documentation: Qt 5 reference:
[override virtual protected] bool QWizard::event(QEvent *event)
Reimplements: QWidget::event(QEvent *event).
Upstream PySide2 reference signatures (binding differences may apply):
event(self, event: PySide2.QtCore.QEvent) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#event
field
field(name: str) -> Any
X.field(name) -> object
Supplemental documentation: Qt 5 reference:
QVariant QWizard::field(const QString \&name) const
Returns the value of the field called name.
This function can be used to access fields on any page of the wizard.
See also QWizardPage::registerField(), QWizardPage::field(), and setField().
Upstream PySide2 reference signatures (binding differences may apply):
field(self, name: str) -> typing.Any
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#field
finished
finished(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.finished; argument details are not documented.
hasVisitedPage
hasVisitedPage(id: int) -> bool
X.hasVisitedPage(id) -> bool
Supplemental documentation: Qt 5 reference:
bool QWizard::hasVisitedPage(int id) const
Returns true if the page history contains page id; otherwise, returns false.
Pressing Back marks the current page as "unvisited" again.
See also visitedPages().
Upstream PySide2 reference signatures (binding differences may apply):
hasVisitedPage(self, id: int) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#hasVisitedPage
helpRequested
helpRequested(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.helpRequested; argument details are not documented.
Supplemental documentation: Qt 5 reference:
[signal] void QWizard::helpRequested()
This signal is emitted when the user clicks the Help button.
By default, no Help button is shown. Call setOption(HaveHelpButton, true) to have one.
Example:
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);
}
See also customButtonClicked().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#helpRequested
initializePage
initializePage(id: int) -> None
X.initializePage(id)
Supplemental documentation: Qt 5 reference:
[virtual protected] void QWizard::initializePage(int id)
This virtual function is called by QWizard to prepare page id 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.
The default implementation calls QWizardPage::initializePage() on page(id).
See also QWizardPage::initializePage() and cleanupPage().
Upstream PySide2 reference signatures (binding differences may apply):
initializePage(self, id: int) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#initializePage
nativeEvent
nativeEvent(eventType: Any, message: Any, result: Any) -> bool
X.nativeEvent(eventType, message, result) -> bool
Supplemental documentation: Qt 5 reference:
[override virtual protected] bool QWizard::nativeEvent(const QByteArray \&eventType, void *message, long *result)
Reimplements: QWidget::nativeEvent(const QByteArray \&eventType, void *message, long *result).
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#nativeEvent
next
next() -> None
X.next()
Supplemental documentation: Qt 5 reference:
[slot] void QWizard::next()
Advances to the next page.
This is equivalent to pressing the Next or Commit button.
See also nextId(), back(), accept(), reject(), and restart().
Upstream PySide2 reference signatures (binding differences may apply):
next(self) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#next
nextId
nextId() -> int
X.nextId() -> int
Supplemental documentation: Qt 5 reference:
[virtual] int QWizard::nextId() const
This virtual function is called by QWizard 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.
The default implementation calls QWizardPage::nextId() on the currentPage().
By reimplementing this function, you can specify a dynamic page order.
See also QWizardPage::nextId() and currentPage().
Upstream PySide2 reference signatures (binding differences may apply):
nextId(self) -> int
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#nextId
objectNameChanged
objectNameChanged(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.objectNameChanged; argument details are not documented.
options
instance-attribute
options: Any
Qt 5 reference:
options : WizardOptions
This property holds the various options that affect the look and feel of the wizard
By default, the following options are set (depending on the platform):
- Windows: HelpButtonOnRight.
- macOS: NoDefaultButton and NoCancelButton.
- X11 and QWS (Qt for Embedded Linux): none.
Access functions:
| QWizard::WizardOptions | options() const |
|---|---|
| void | setOptions(QWizard::WizardOptions options) |
See also wizardStyle.
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#options
page
page(id: int) -> Any
X.page(id) -> PythonQt.QtGui.QWizardPage
Supplemental documentation: Qt 5 reference:
QWizardPage *QWizard::page(int id) const
Returns the page with the given id, or nullptr if there is no such page.
See also addPage() and setPage().
Upstream PySide2 reference signatures (binding differences may apply):
page(self, id: int) -> PySide2.QtWidgets.QWizardPage
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#page
pageAdded
pageAdded(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.pageAdded; argument details are not documented.
Supplemental documentation: Qt 5 reference:
[signal] void QWizard::pageAdded(int id)
This signal is emitted whenever a page is added to the wizard. The page's id is passed as parameter.
This function was introduced in Qt 4.7.
See also addPage(), setPage(), and startId().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#pageAdded
pageIds
pageIds() -> tuple
X.pageIds() -> tuple
Supplemental documentation: Qt 5 reference:
QList\<int> QWizard::pageIds() const
Returns the list of page IDs.
This function was introduced in Qt 4.5.
Upstream PySide2 reference signatures (binding differences may apply):
pageIds(self) -> typing.List[int]
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#pageIds
pageRemoved
pageRemoved(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.pageRemoved; argument details are not documented.
Supplemental documentation: Qt 5 reference:
[signal] void QWizard::pageRemoved(int id)
This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.
This function was introduced in Qt 4.7.
See also removePage() and startId().
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#pageRemoved
paintEvent
paintEvent(event: Any) -> None
X.paintEvent(event)
Supplemental documentation: Qt 5 reference:
[override virtual protected] void QWizard::paintEvent(QPaintEvent *event)
Reimplements: QWidget::paintEvent(QPaintEvent *event).
Upstream PySide2 reference signatures (binding differences may apply):
paintEvent(self, event: PySide2.QtGui.QPaintEvent) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#paintEvent
pixmap
pixmap(which: Any) -> Any
X.pixmap(which) -> PythonQt.QtGui.QPixmap
Supplemental documentation: Qt 5 reference:
QPixmap QWizard::pixmap(QWizard::WizardPixmap which) const
Returns the pixmap set for role which.
By default, the only pixmap that is set is the BackgroundPixmap on macOS version 10.13 and earlier.
See also setPixmap(), QWizardPage::pixmap(), and Elements of a Wizard Page.
Upstream PySide2 reference signatures (binding differences may apply):
pixmap(self, which: PySide2.QtWidgets.QWizard.WizardPixmap) -> PySide2.QtGui.QPixmap
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#pixmap
rejected
rejected(*args: Any, **kwargs: Any) -> Any
Native PythonQt.QtGui.QWizard.rejected; argument details are not documented.
removePage
removePage(id: int) -> None
X.removePage(id)
Supplemental documentation: Qt 5 reference:
void QWizard::removePage(int id)
Removes the page with the given id. cleanupPage() will be called if necessary.
Note: Removing a page may influence the value of the startId property.
This function was introduced in Qt 4.5.
See also addPage(), setPage(), pageRemoved(), and startId().
Upstream PySide2 reference signatures (binding differences may apply):
removePage(self, id: int) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#removePage
resizeEvent
resizeEvent(event: Any) -> None
X.resizeEvent(event)
Supplemental documentation: Qt 5 reference:
[override virtual protected] void QWizard::resizeEvent(QResizeEvent *event)
Reimplements: QDialog::resizeEvent(QResizeEvent *).
Upstream PySide2 reference signatures (binding differences may apply):
resizeEvent(self, event: PySide2.QtGui.QResizeEvent) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#resizeEvent
restart
restart() -> None
X.restart()
Supplemental documentation: Qt 5 reference:
[slot] void QWizard::restart()
Restarts the wizard at the start page. This function is called automatically when the wizard is shown.
See also startId().
Upstream PySide2 reference signatures (binding differences may apply):
restart(self) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#restart
setButton
setButton(which: Any, button: Any) -> None
X.setButton(which, button)
Supplemental documentation: Qt 5 reference:
void QWizard::setButton(QWizard::WizardButton which, QAbstractButton *button)
Sets the button corresponding to role which to button.
To add extra buttons to the wizard (e.g., a Print button), one way is to call setButton() with CustomButton1 to CustomButton3, and make the buttons visible using the HaveCustomButton1 to HaveCustomButton3 options.
See also button(), setButtonText(), setButtonLayout(), and options.
Upstream PySide2 reference signatures (binding differences may apply):
setButton(self, which: PySide2.QtWidgets.QWizard.WizardButton, button: PySide2.QtWidgets.QAbstractButton) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#setButton
setButtonLayout
setButtonLayout(layout: Any) -> None
X.setButtonLayout(layout)
Supplemental documentation: Qt 5 reference:
void QWizard::setButtonLayout(const QList\<QWizard::WizardButton> \&layout)
Sets the order in which buttons are displayed to layout, where layout is a list of WizardButtons.
The default layout depends on the options (e.g., whether HelpButtonOnRight) that are set. You can call this function if you need more control over the buttons' layout than what options already provides.
You can specify horizontal stretches in the layout using Stretch.
Example:
MyWizard::MyWizard(QWidget *parent)
: QWizard(parent)
{
...
QList<QWizard::WizardButton> layout;
layout << QWizard::Stretch << QWizard::BackButton << QWizard::CancelButton
<< QWizard::NextButton << QWizard::FinishButton;
setButtonLayout(layout);
...
}
See also setButton(), setButtonText(), and setOptions().
Upstream PySide2 reference signatures (binding differences may apply):
setButtonLayout(self, layout: typing.Sequence[PySide2.QtWidgets.QWizard.WizardButton]) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#setButtonLayout
setButtonText
setButtonText(which: Any, text: str) -> None
X.setButtonText(which, text)
Supplemental documentation: Qt 5 reference:
void QWizard::setButtonText(QWizard::WizardButton which, const QString \&text)
Sets the text on button which to be text.
By default, the text on buttons depends on the wizardStyle. For example, on macOS, the Next button is called Continue.
To add extra buttons to the wizard (e.g., a Print button), one way is to call setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set their text, and make the buttons visible using the HaveCustomButton1, HaveCustomButton2, and/or HaveCustomButton3 options.
Button texts may also be set on a per-page basis using QWizardPage::setButtonText().
See also buttonText(), setButton(), button(), setButtonLayout(), setOptions(), and QWizardPage::setButtonText().
Upstream PySide2 reference signatures (binding differences may apply):
setButtonText(self, which: PySide2.QtWidgets.QWizard.WizardButton, text: str) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#setButtonText
setField
setField(name: str, value: Any) -> None
X.setField(name, value)
Supplemental documentation: Qt 5 reference:
void QWizard::setField(const QString \&name, const QVariant \&value)
Sets the value of the field called name to value.
This function can be used to set fields on any page of the wizard.
See also QWizardPage::registerField(), QWizardPage::setField(), and field().
Upstream PySide2 reference signatures (binding differences may apply):
setField(self, name: str, value: typing.Any) -> None
Source: https://doc.qt.io/archives/qt-5.15/qwizard.html#setField