QWizard Class

Dokumentation zu den Mitgliedsfunktionen

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

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

Siehe auch parent() und windowFlags().

[virtual noexcept] QWizard::~QWizard()

Vernichtet den Wizard 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.

Es wird garantiert, dass die ID größer ist als jede andere ID in der „ QWizard “ bis zu diesem Zeitpunkt.

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

[slot] void QWizard::back()

Kehrt zur vorherigen Seite zurück.

Dies entspricht dem Klicken auf die Schaltfläche „ 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 mit ` setButtonText()` ein Text festgelegt wurde, wird dieser Text zurückgegeben.

Standardmäßig hängt der Text auf den Schaltflächen von der „ 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 zu bereinigen, kurz bevor der Benutzer sie durch Klicken auf Back verlässt (es sei denn, die Option QWizard::IndependentPages ist gesetzt).

Die Standardimplementierung ruft ` QWizardPage::cleanupPage()` auf der Seite `id` auf.

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

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

Dieses Signal wird ausgelöst, wenn sich die aktuelle Seite ändert, wobei die neue aktuelle Seite id lautet.

Siehe auch „ currentId()“ und „ currentPage()“.

QWizardPage *QWizard::currentPage() const

Gibt einen Zeiger auf die aktuelle Seite zurück oder „ nullptr “, falls keine aktuelle Seite vorhanden ist (z. B. bevor der Assistent angezeigt wird).

Dies entspricht dem Aufruf von page(currentId()).

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

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

Dieses Signal wird ausgelöst, 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 solche Schaltfläche anzuzeigen, und verwenden Sie ` setButtonText()` oder ` setButton()`, um sie zu konfigurieren.

Siehe auch helpRequested().

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

Implementiert: QDialog::done(int r).

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

Umsetzt: ` QWidget::event(QEvent *event)`.

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

Gibt den Wert des Feldes „ name “ zurück.

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

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 ausgelöst, 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 solche Schaltfläche anzuzeigen.

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 als Ergebnis des Aufrufs von ` QWizard::restart()` oder als Folge eines Klicks des Benutzers auf ` Next` angezeigt wird. (Ist jedoch die Option ` QWizard::IndependentPages ` gesetzt, 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 aus vorherigen Seiten korrekt initialisiert werden.

Die Standardimplementierung ruft ` QWizardPage::initializePage()` auf der Seite `(id)` auf.

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

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

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

[slot] void QWizard::next()

Wechselt zur nächsten Seite.

Dies entspricht dem Klicken auf die Schaltfläche „ Next “ oder „ Commit “.

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

[virtual] int QWizard::nextId() const

Diese virtuelle Funktion wird von „ QWizard “ aufgerufen, um zu ermitteln, 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()“ innerhalb von „ currentPage()“ auf.

Durch die Neuimplementierung dieser Funktion können Sie eine dynamische Seitenreihenfolge festlegen.

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

QWizardPage *QWizard::page(int id) const

Gibt die Seite mit der angegebenen Adresse id zurück oder nullptr, falls keine solche Seite existiert.

Siehe auch addPage() und setPage().

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

Dieses Signal wird immer dann ausgelöst, wenn dem Assistenten eine Seite hinzugefügt wird. Die URL der Seite („ id “) 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 ausgelöst, sobald eine Seite aus dem Assistenten entfernt wird. Die URL der Seite ( id ) wird als Parameter übergeben.

Siehe auch „ removePage()“ und „ startId()“.

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

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

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

Gibt die für die Rolle „ which “ festgelegte Pixmap zurück.

Standardmäßig ist unter macOS nur das Pixmap „ BackgroundPixmap “ festgelegt.

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

void QWizard::removePage(int id)

Entfernt die Seite mit der angegebenen „ id “. Falls erforderlich, wird „ cleanupPage()“ aufgerufen.

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

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

Implementiert: ` 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 “ entspricht, auf „ button “.

Um dem Assistenten zusätzliche Schaltflächen hinzuzufügen (z. B. eine Schaltfläche „ Print “), können Sie unter anderem die Funktion `setButton()` mit den Werten ` CustomButton1 ` bis ` CustomButton3` aufrufen und die Schaltflächen mithilfe der 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 Schaltflächen angezeigt werden: „ layout “, wobei „ layout “ eine Liste von „ WizardButton“-Objekten ist.

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

Mit „ Stretch “ können Sie horizontale Abstände im Layout 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 auf der Schaltfläche „ which “ auf „ text “ fest.

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

Um dem Assistenten zusätzliche Schaltflächen hinzuzufügen (z. B. eine Schaltfläche „ Print “), können Sie unter anderem die Methode `setButtonText()` mit den Werten ` CustomButton1`, ` CustomButton2` oder ` CustomButton3 ` aufrufen, um deren Text festzulegen, und die Schaltflächen mithilfe der Optionen ` HaveCustomButton1`, ` HaveCustomButton2` und/oder ` HaveCustomButton3 ` sichtbar machen.

Schaltflächentexte können auch seitenweise mithilfe von ` QWizardPage::setButtonText()` festgelegt 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 “ aufzurufen.

Kehrt ohne Seitenwechsel zurück, wenn

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

Hinweis: Wenn Seiten übersprungen wurden und id den Wert 0 hat, wird der Seitenverlauf gelöscht

Siehe auch currentId().

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

Legt die Standardeigenschaft für „ className “ auf „ property “ und das zugehörige Änderungssignal auf „ changedSignal “ fest.

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

QWizard kennt die gängigsten Qt Widgets. Für diese (oder deren Unterklassen) müssen Sie weder ein ` property ` noch ein ` 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 „ 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 die angegebene „ option “ auf „enabled“, wenn „ on “ wahr ist; andernfalls wird die angegebene „ option “ zurückgesetzt.

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

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

Fügt die angegebene „ page “ dem Assistenten mit der angegebenen „ id “ hinzu.

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

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

Legt die Pixmap für die Rolle „ which “ auf „ pixmap “ fest.

Die Pixmaps werden von ` QWizard ` bei der Anzeige einer Seite verwendet. Welche Pixmaps tatsächlich verwendet werden, hängt von ` wizard style` ab.

Pixmaps können auch für eine bestimmte Seite mithilfe von ` QWizardPage::setPixmap()` festgelegt 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 wird. Bei Stilen, die das „ WatermarkPixmap “ verwenden (ClassicStyle und ModernStyle), wird das Seiten-Widget über dem Wasserzeichen angezeigt; bei anderen Stilen oder wenn kein Wasserzeichen vorhanden ist, wird das Seiten-Widget auf der linken Seite des Assistenten angezeigt.

Wird „ nullptr “ übergeben, wird kein Seiten-Widget angezeigt.

Wenn „ widget “ nicht „ nullptr “ ist, ordnet der Assistent das Seiten-Widget neu zu.

Ein eventuell zuvor vorhandenes Seiten-Widget wird ausgeblendet.

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

Alle hier festgelegten Widgets werden vom Assistenten beim Beenden gelöscht, es sei denn, Sie weisen dem Widget nach dem Festlegen eines anderen Seiten-Widgets (oder von ` nullptr`) separat eine neue übergeordnete Ebene zu.

Standardmäßig ist kein Seiten-Widget vorhanden.

Siehe auch ` sideWidget()`.

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

Implementiert: ` QDialog::setVisible` (bool visible).

QWidget *QWizard::sideWidget() const

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

Standardmäßig ist kein Seiten-Widget vorhanden.

Siehe auch setSideWidget().

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

Implementiert: ` 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 Validierung in letzter Minute durchzuführen. Wenn sie ` true` zurückgibt, wird die nächste Seite angezeigt (oder der Assistent wird beendet); andernfalls bleibt die aktuelle Seite geöffnet.

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

Wenn möglich, ist es in der Regel stilistisch 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 in der Reihenfolge zurück, in der die Seiten besucht wurden.

Siehe auch hasVisitedPage().