QWizard Class

Dokumentation der Mitgliedsfunktionen

[explicit] QWizard::QWizard(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Konstruiert einen Assistenten mit dem angegebenen parent und dem Fenster flags.

Siehe auch parent() und windowFlags().

[virtual noexcept] QWizard::~QWizard()

Zerstört den Assistenten und seine Seiten und gibt alle zugewiesenen Ressourcen frei.

int QWizard::addPage(QWizardPage *page)

Fügt die angegebene page zum Assistenten hinzu und gibt die ID der Seite zurück.

Die ID ist garantiert größer als jede andere ID in der QWizard bisher.

Siehe auch setPage(), page(), und pageAdded().

[slot] void QWizard::back()

Kehrt zur vorherigen Seite zurück.

Dies entspricht dem Drücken der Taste Back.

Siehe auch next(), accept(), reject(), und restart().

QAbstractButton *QWizard::button(QWizard::WizardButton which) const

Gibt die Schaltfläche zurück, die der Rolle which entspricht.

Siehe auch setButton() und setButtonText().

QString QWizard::buttonText(QWizard::WizardButton which) const

Gibt den Text der Schaltfläche which zurück.

Wenn ein Text mit setButtonText() festgelegt wurde, wird dieser Text zurückgegeben.

Standardmäßig hängt der Text auf den Schaltflächen vom wizardStyle ab. Unter macOS heißt die Schaltfläche Next beispielsweise Continue.

Siehe auch button(), setButton(), setButtonText(), QWizardPage::buttonText(), und QWizardPage::setButtonText().

[virtual protected] void QWizard::cleanupPage(int id)

Diese virtuelle Funktion wird von QWizard aufgerufen, um die Seite id aufzuräumen, kurz bevor der Benutzer sie durch Anklicken von Back verlässt (es sei denn, die Option QWizard::IndependentPages ist gesetzt).

Die Standardimplementierung ruft QWizardPage::cleanupPage() auf page(id) auf.

Siehe auch QWizardPage::cleanupPage() und initializePage().

[signal] void QWizard::currentIdChanged(int id)

Dieses Signal wird ausgegeben, wenn die aktuelle Seite wechselt, mit der neuen aktuellen id.

Siehe auch currentId() und currentPage().

QWizardPage *QWizard::currentPage() const

Gibt einen Zeiger auf die aktuelle Seite zurück, oder nullptr, wenn es keine aktuelle Seite gibt (z. B. bevor der Assistent angezeigt wird).

Dies ist gleichbedeutend mit dem Aufruf von page(currentId()).

Siehe auch page(), currentId(), und restart().

[signal] void QWizard::customButtonClicked(int which)

Dieses Signal wird ausgegeben, wenn der Benutzer auf eine benutzerdefinierte Schaltfläche klickt. which kann CustomButton1, CustomButton2 oder CustomButton3 sein.

Standardmäßig wird keine benutzerdefinierte Schaltfläche angezeigt. Rufen Sie setOption() mit HaveCustomButton1, HaveCustomButton2 oder HaveCustomButton3 auf, um eine zu haben, und verwenden Sie setButtonText() oder setButton(), um sie zu konfigurieren.

Siehe auch helpRequested().

[override virtual protected] void QWizard::done(int result)

Reimplements: QDialog::done(int r).

[override virtual protected] bool QWizard::event(QEvent *event)

Reimplements: QWidget::event(QEvent *Event).

QVariant QWizard::field(const QString &name) const

Gibt den Wert des Feldes mit dem Namen name zurück.

Diese Funktion kann für den Zugriff auf Felder auf jeder Seite des Assistenten verwendet werden.

Siehe auch QWizardPage::registerField(), QWizardPage::field(), und setField().

bool QWizard::hasVisitedPage(int id) const

Gibt true zurück, wenn der Seitenverlauf die Seite id enthält; andernfalls wird false zurückgegeben.

Durch Drücken von Back wird die aktuelle Seite wieder als "unbesucht" markiert.

Siehe auch visitedIds().

[signal] void QWizard::helpRequested()

Dieses Signal wird ausgegeben, wenn der Benutzer auf die Schaltfläche Help klickt.

Standardmäßig wird keine Schaltfläche Help angezeigt. Rufen Sie setOption(HaveHelpButton, true) auf, um eine zu erhalten.

Beispiel:

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);

}

Siehe auch customButtonClicked().

[virtual protected] void QWizard::initializePage(int id)

Diese virtuelle Funktion wird von QWizard aufgerufen, um die Seite id vorzubereiten, kurz bevor sie entweder durch den Aufruf von QWizard::restart() oder durch das Anklicken von Next angezeigt wird. (Wenn jedoch die Option QWizard::IndependentPages gesetzt ist, wird diese Funktion nur beim ersten Anzeigen der Seite aufgerufen).

Durch die Neuimplementierung dieser Funktion können Sie sicherstellen, dass die Felder der Seite auf der Grundlage der Felder früherer Seiten richtig initialisiert werden.

Die Standardimplementierung ruft QWizardPage::initializePage() auf page(id) auf.

Siehe auch QWizardPage::initializePage() und cleanupPage().

[override virtual protected] bool QWizard::nativeEvent(const QByteArray &eventType, void *message, qintptr *result)

Reimplements: QWidget::nativeEvent(const QByteArray &eventType, void *message, qintptr *result).

[slot] void QWizard::next()

Wechselt zur nächsten Seite.

Dies entspricht dem Drücken der Taste Next oder Commit.

Siehe auch nextId(), back(), accept(), reject(), und restart().

[virtual] int QWizard::nextId() const

Diese virtuelle Funktion wird von QWizard aufgerufen, um herauszufinden, welche Seite angezeigt werden soll, wenn der Benutzer auf die Schaltfläche Next klickt.

Der Rückgabewert ist die ID der nächsten Seite, oder -1, wenn keine Seite folgt.

Die Standardimplementierung ruft QWizardPage::nextId() auf currentPage() auf.

Wenn Sie diese Funktion neu implementieren, können Sie eine dynamische Seitenreihenfolge festlegen.

Siehe auch QWizardPage::nextId() und currentPage().

QWizardPage *QWizard::page(int id) const

Gibt die Seite mit dem angegebenen id zurück, oder nullptr, wenn es keine solche Seite gibt.

Siehe auch addPage() und setPage().

[signal] void QWizard::pageAdded(int id)

Dieses Signal wird ausgegeben, wenn eine Seite zum Assistenten hinzugefügt wird. Die id der Seite wird als Parameter übergeben.

Siehe auch addPage(), setPage(), und startId().

QList<int> QWizard::pageIds() const

Gibt die Liste der Seiten-IDs zurück.

[signal] void QWizard::pageRemoved(int id)

Dieses Signal wird ausgegeben, wenn eine Seite aus dem Assistenten entfernt wird. Die id der Seite wird als Parameter übergeben.

Siehe auch removePage() und startId().

[override virtual protected] void QWizard::paintEvent(QPaintEvent *event)

Reimplements: QWidget::paintEvent(QPaintEvent *event).

QPixmap QWizard::pixmap(QWizard::WizardPixmap which) const

Gibt die für die Rolle which eingestellte Pixmap zurück.

Standardmäßig ist die einzige Pixmap, die eingestellt ist, die BackgroundPixmap unter macOS.

Siehe auch setPixmap(), QWizardPage::pixmap(), und Elements of a Wizard Page.

void QWizard::removePage(int id)

Entfernt die Seite mit der angegebenen id. cleanupPage() wird bei Bedarf aufgerufen.

Siehe auch addPage(), setPage(), pageRemoved(), und startId().

[override virtual protected] void QWizard::resizeEvent(QResizeEvent *event)

Reimplements: QDialog::resizeEvent(QResizeEvent *).

[slot] void QWizard::restart()

Startet den Assistenten auf der Startseite neu. Diese Funktion wird automatisch aufgerufen, wenn der Assistent angezeigt wird.

Siehe auch startId().

void QWizard::setButton(QWizard::WizardButton which, QAbstractButton *button)

Setzt die Schaltfläche, die der Rolle which bis button entspricht.

Um dem Assistenten weitere Schaltflächen hinzuzufügen (z. B. eine Schaltfläche Print ), kann man setButton() mit CustomButton1 bis CustomButton3 aufrufen und die Schaltflächen mit den Optionen HaveCustomButton1 bis HaveCustomButton3 sichtbar machen.

Siehe auch button(), setButtonText(), setButtonLayout(), und options.

void QWizard::setButtonLayout(const QList<QWizard::WizardButton> &layout)

Legt die Reihenfolge fest, in der die Schaltflächen auf layout angezeigt werden, wobei layout eine Liste von WizardButtonist.

Das Standardlayout hängt von den eingestellten Optionen ab (z. B. ob HelpButtonOnRight). Sie können diese Funktion aufrufen, wenn Sie mehr Kontrolle über das Layout der Schaltflächen benötigen, als es options bereits bietet.

Sie können horizontale Ausdehnungen im Layout mit Stretch festlegen.

Beispiel:

MyWizard::MyWizard(QWidget *parent)
    : QWizard(parent)
{
    ...
    QList<QWizard::WizardButton> layout;
    layout << QWizard::Stretch << QWizard::BackButton << QWizard::CancelButton
           << QWizard::NextButton << QWizard::FinishButton;
    setButtonLayout(layout);
    ...
}

Siehe auch setButton(), setButtonText(), und setOptions().

void QWizard::setButtonText(QWizard::WizardButton which, const QString &text)

Legt den Text der Schaltfläche which auf text fest.

Standardmäßig hängt der Text der Schaltflächen vom wizardStyle ab. Unter macOS heißt die Schaltfläche Next beispielsweise Continue.

Um dem Assistenten weitere Schaltflächen hinzuzufügen (z. B. eine Schaltfläche Print ), besteht eine Möglichkeit darin, setButtonText() mit CustomButton1, CustomButton2 oder CustomButton3 aufzurufen, um deren Text festzulegen, und die Schaltflächen mit den Optionen HaveCustomButton1, HaveCustomButton2 und/oder HaveCustomButton3 sichtbar zu machen.

Schaltflächentexte können auch mit QWizardPage::setButtonText() seitenweise gesetzt werden.

Siehe auch buttonText(), setButton(), button(), setButtonLayout(), setOptions(), und QWizardPage::setButtonText().

[slot] void QWizard::setCurrentId(int id)

Setzt currentId auf id, ohne die Seiten zwischen currentId und id zu besuchen.

Kehrt ohne Seitenwechsel zurück, wenn

• der Assistent keine Seiten enthält
• die aktuelle Seite ungültig ist
• die angegebene Seite ist gleich currentId()
• die angegebene Seite liegt außerhalb des Bereichs

Hinweis: Wenn Seiten vorwärts übersprungen wurden und id gleich 0 ist, wird der Verlauf der Seitenbesuche gelöscht

Siehe auch currentId().

void QWizard::setDefaultProperty(const char *className, const char *property, const char *changedSignal)

Setzt die Standardeigenschaft für className auf property und das zugehörige Änderungssignal auf changedSignal.

Die Standardeigenschaft wird verwendet, wenn eine Instanz von className (oder einer ihrer Unterklassen) an QWizardPage::registerField() übergeben wird und keine Eigenschaft angegeben ist.

QWizard kennt die gebräuchlichsten Qt Widgets. Für diese (oder ihre Unterklassen) müssen Sie keine property oder changedSignal angeben. Die folgende Tabelle listet diese Widgets auf:

Siehe auch QWizardPage::registerField().

void QWizard::setField(const QString &name, const QVariant &value)

Setzt den Wert des Feldes mit der Bezeichnung name auf value.

Diese Funktion kann verwendet werden, um Felder auf jeder Seite des Assistenten zu setzen.

Siehe auch QWizardPage::registerField(), QWizardPage::setField(), und field().

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

Setzt das angegebene option auf aktiv, wenn on wahr ist; andernfalls wird das angegebene option gelöscht.

Siehe auch options, testOption(), und setWizardStyle().

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

Fügt die angegebene page zum Assistenten mit der angegebenen id hinzu.

Siehe auch addPage(), page(), und pageAdded().

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

Setzt die Pixmap für die Rolle which auf pixmap.

Die Pixmaps werden von QWizard verwendet, wenn eine Seite angezeigt wird. Welche Pixmaps tatsächlich verwendet werden, hängt von der wizard style ab.

Pixmaps können auch für eine bestimmte Seite mit QWizardPage::setPixmap() gesetzt werden.

Siehe auch pixmap(), QWizardPage::setPixmap(), und Elements of a Wizard Page.

void QWizard::setSideWidget(QWidget *widget)

Legt fest, dass das angegebene widget auf der linken Seite des Assistenten angezeigt werden soll. Bei Stilen, die das WatermarkPixmap verwenden (ClassicStyle und ModernStyle), wird das Seiten-Widget über dem Wasserzeichen angezeigt, bei anderen Stilen oder wenn das Wasserzeichen nicht vorhanden ist, wird das Seiten-Widget auf der linken Seite des Assistenten angezeigt.

Bei der Angabe nullptr wird kein Seiten-Widget angezeigt.

Wenn widget nicht nullptr ist, wird es vom Assistenten repariert.

Alle vorherigen Seiten-Widgets werden ausgeblendet.

Sie können setSideWidget() mit demselben Widget zu verschiedenen Zeitpunkten aufrufen.

Alle hier gesetzten Widgets werden vom Assistenten gelöscht, wenn er zerstört wird, es sei denn, Sie reparieren das Widget separat, nachdem Sie ein anderes Seiten-Widget gesetzt haben (oder nullptr).

Standardmäßig ist kein Seiten-Widget vorhanden.

Siehe auch sideWidget().

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

Reimplements: QDialog::setVisible(bool visible).

QWidget *QWizard::sideWidget() const

Gibt das Widget auf der linken Seite des Assistenten oder nullptr zurück.

Standardmäßig ist kein Seiten-Widget vorhanden.

Siehe auch setSideWidget().

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

Reimplements: QDialog::sizeHint() const.

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

Gibt true zurück, wenn die angegebene option aktiviert ist; andernfalls wird false zurückgegeben.

Siehe auch options, setOption(), und setWizardStyle().

[virtual] bool QWizard::validateCurrentPage()

Diese virtuelle Funktion wird von QWizard aufgerufen, wenn der Benutzer auf Next oder Finish klickt, um eine Überprüfung in letzter Minute vorzunehmen. Wenn sie true zurückgibt, wird die nächste Seite angezeigt (oder der Assistent beendet); andernfalls bleibt die aktuelle Seite bestehen.

Die Standardimplementierung ruft QWizardPage::validatePage() auf currentPage() auf.

Wenn möglich, ist es normalerweise besser, die Schaltfläche Next oder Finish zu deaktivieren (durch Angabe von mandatory fields oder durch Neuimplementierung von QWizardPage::isComplete()), als validateCurrentPage() neu zu implementieren.

Siehe auch QWizardPage::validatePage() und currentPage().

QList<int> QWizard::visitedIds() const

Gibt die Liste der IDs der besuchten Seiten zurück, und zwar in der Reihenfolge, in der die Seiten besucht wurden.

Siehe auch hasVisitedPage().