QWizard Class

Documentation des fonctions membres

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

Construit un assistant avec les données parent et la fenêtre flags.

Voir aussi parent() et windowFlags().

[virtual noexcept] QWizard::~QWizard()

Détruit l'assistant et ses pages, en libérant toutes les ressources allouées.

int QWizard::addPage(QWizardPage *page)

Ajoute la page page à l'assistant et renvoie l'ID de la page.

Il est garanti que l'ID est plus grand que n'importe quel autre ID dans le site QWizard jusqu'à présent.

Voir aussi setPage(), page(), et pageAdded().

[slot] void QWizard::back()

Retourne à la page précédente.

Cela équivaut à appuyer sur le bouton Back.

Voir aussi next(), accept(), reject() et restart().

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

Renvoie le bouton correspondant au rôle which.

Voir aussi setButton() et setButtonText().

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

Renvoie le texte du bouton which.

Si un texte a été défini à l'aide de setButtonText(), ce texte est renvoyé.

Par défaut, le texte des boutons dépend du bouton wizardStyle. Par exemple, sous macOS, le bouton Next est appelé Continue.

Voir également button(), setButton(), setButtonText(), QWizardPage::buttonText() et QWizardPage::setButtonText().

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

Cette fonction virtuelle est appelée par QWizard pour nettoyer la page id juste avant que l'utilisateur ne la quitte en cliquant sur Back (sauf si l'option QWizard::IndependentPages est activée).

L'implémentation par défaut appelle QWizardPage::cleanupPage() sur la page(id).

Voir aussi QWizardPage::cleanupPage() et initializePage().

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

Ce signal est émis lorsque la page en cours change, avec la nouvelle page en cours id.

Voir également currentId() et currentPage().

QWizardPage *QWizard::currentPage() const

Renvoie un pointeur sur la page en cours, ou nullptr s'il n'y a pas de page en cours (par exemple, avant l'affichage de l'assistant).

Cela équivaut à appeler page(currentId()).

Voir aussi page(), currentId(), et restart().

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

Ce signal est émis lorsque l'utilisateur clique sur un bouton personnalisé. which peut être CustomButton1, CustomButton2, ou CustomButton3.

Par défaut, aucun bouton personnalisé n'est affiché. Appelez setOption() avec HaveCustomButton1, HaveCustomButton2, ou HaveCustomButton3 pour en avoir un, et utilisez setButtonText() ou setButton() pour le configurer.

Voir aussi helpRequested().

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

Réimplémente : QDialog::done(int r).

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

Réimplémente : QWidget::event(QEvent *event).

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

Renvoie la valeur du champ appelé name.

Cette fonction peut être utilisée pour accéder aux champs de n'importe quelle page de l'assistant.

Voir également QWizardPage::registerField(), QWizardPage::field() et setField().

bool QWizard::hasVisitedPage(int id) const

Renvoie true si l'historique de la page contient la page id; sinon, renvoie false.

L'appui sur Back marque à nouveau la page actuelle comme "non visitée".

Voir aussi visitedIds().

[signal] void QWizard::helpRequested()

Ce signal est émis lorsque l'utilisateur clique sur le bouton Help.

Par défaut, aucun bouton Help n'est affiché. Appelez setOption(HaveHelpButton, true) pour en avoir un.

Exemple :

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

}

Voir aussi customButtonClicked().

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

Cette fonction virtuelle est appelée par QWizard pour préparer la page id juste avant qu'elle ne soit affichée, soit à la suite de l'appel de QWizard::restart(), soit à la suite d'un clic de l'utilisateur sur Next(toutefois, si l'option QWizard::IndependentPages est activée, cette fonction n'est appelée que la première fois que la page est affichée).

En réimplémentant cette fonction, vous pouvez vous assurer que les champs de la page sont correctement initialisés en fonction des champs des pages précédentes.

L'implémentation par défaut appelle QWizardPage::initializePage() sur la page(id).

Voir également QWizardPage::initializePage() et cleanupPage().

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

Réimplémente : QWidget::nativeEvent(const QByteArray &eventType, void *message, qintptr *result).

[slot] void QWizard::next()

Passe à la page suivante.

Cela équivaut à appuyer sur le bouton Next ou Commit.

Voir également nextId(), back(), accept(), reject() et restart().

[virtual] int QWizard::nextId() const

Cette fonction virtuelle est appelée par QWizard pour savoir quelle page afficher lorsque l'utilisateur clique sur le bouton Next.

La valeur de retour est l'ID de la page suivante, ou -1 si aucune page ne suit.

L'implémentation par défaut appelle QWizardPage::nextId() sur currentPage().

En réimplémentant cette fonction, vous pouvez spécifier un ordre dynamique des pages.

Voir aussi QWizardPage::nextId() et currentPage().

QWizardPage *QWizard::page(int id) const

Renvoie la page avec l'adresse id, ou nullptr s'il n'y en a pas.

Voir aussi addPage() et setPage().

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

Ce signal est émis lorsqu'une page est ajoutée à l'assistant. L'adresse id de la page est passée en paramètre.

Voir aussi addPage(), setPage() et startId().

QList<int> QWizard::pageIds() const

Renvoie la liste des identifiants de page.

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

Ce signal est émis lorsqu'une page est supprimée de l'assistant. L'adresse id de la page est passée en paramètre.

Voir également removePage() et startId().

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

Réimplémente : QWidget::paintEvent(QPaintEvent *event).

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

Renvoie la pixmap définie pour le rôle which.

Par défaut, la seule pixmap définie est la BackgroundPixmap sur macOS.

Voir aussi setPixmap(), QWizardPage::pixmap(), et Elements of a Wizard Page.

void QWizard::removePage(int id)

Supprime la page correspondant à la propriété id. cleanupPage() sera appelé si nécessaire.

Voir également addPage(), setPage(), pageRemoved() et startId().

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

Réimplémente : QDialog::resizeEvent(QResizeEvent *).

[slot] void QWizard::restart()

Redémarre l'assistant à la page d'accueil. Cette fonction est appelée automatiquement lorsque l'assistant est affiché.

Voir aussi startId().

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

Définit le bouton correspondant au rôle which à button.

Pour ajouter des boutons supplémentaires à l'assistant (par exemple, un bouton Print ), il est possible d'appeler setButton() avec CustomButton1 à CustomButton3, et de rendre les boutons visibles à l'aide des options HaveCustomButton1 à HaveCustomButton3.

Voir également button(), setButtonText(), setButtonLayout() et options.

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

Définit l'ordre d'affichage des boutons sur layout, où layout est une liste de WizardButton.

La présentation par défaut dépend des options définies (par exemple, si HelpButtonOnRight). Vous pouvez appeler cette fonction si vous avez besoin d'un contrôle plus poussé de la disposition des boutons que celui déjà fourni par options.

Vous pouvez spécifier des étirements horizontaux dans la mise en page à l'aide de Stretch.

Exemple :

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

Voir également setButton(), setButtonText() et setOptions().

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

Définit le texte du bouton which comme étant text.

Par défaut, le texte des boutons dépend de wizardStyle. Par exemple, sur macOS, le bouton Next est appelé Continue.

Pour ajouter des boutons supplémentaires à l'assistant (par exemple, un bouton Print ), il est possible d'appeler setButtonText() avec CustomButton1, CustomButton2, ou CustomButton3 pour définir leur texte, et de rendre les boutons visibles à l'aide des options HaveCustomButton1, HaveCustomButton2, et/ou HaveCustomButton3.

Le texte des boutons peut également être défini par page à l'aide de QWizardPage::setButtonText().

Voir également buttonText(), setButton(), button(), setButtonLayout(), setOptions() et QWizardPage::setButtonText().

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

Définit currentId à id, sans visiter les pages entre currentId et id.

Retourne sans changement de page, si

• l'assistant ne contient aucune page
• la page actuelle n'est pas valide
• la page donnée est égale à currentId()
• la page donnée est hors de portée

Remarque : si des pages ont été sautées et que id est égal à 0, l'historique des pages visitées sera supprimé.

Voir aussi currentId().

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

Définit la propriété par défaut de className comme étant property, et le signal de changement associé comme étant changedSignal.

La propriété par défaut est utilisée lorsqu'une instance de className (ou de l'une de ses sous-classes) est transmise à QWizardPage::registerField() et qu'aucune propriété n'est spécifiée.

QWizard connaît les widgets Qt Widgets les plus courants. Pour ceux-ci (ou leurs sous-classes), vous n'avez pas besoin de spécifier une propriété property ou changedSignal. Le tableau ci-dessous répertorie ces widgets :

Voir aussi QWizardPage::registerField().

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

Définit la valeur du champ appelé name à value.

Cette fonction peut être utilisée pour définir des champs sur n'importe quelle page de l'assistant.

Voir également QWizardPage::registerField(), QWizardPage::setField() et field().

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

Définit l'option option comme étant activée si on est vrai ; sinon, efface l'option option.

Voir aussi options, testOption(), et setWizardStyle().

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

Ajoute la page page à l'assistant avec la page id.

Voir aussi addPage(), page() et pageAdded().

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

Définit la pixmap pour le rôle which à pixmap.

Les pixmaps sont utilisés par QWizard lors de l'affichage d'une page. Les pixmaps réellement utilisés dépendent de la page wizard style.

Les pixmaps peuvent également être définies pour une page spécifique à l'aide de QWizardPage::setPixmap().

Voir également pixmap(), QWizardPage::setPixmap() et Elements of a Wizard Page.

void QWizard::setSideWidget(QWidget *widget)

Définit le site widget comme étant affiché sur le côté gauche de l'assistant. Pour les styles qui utilisent WatermarkPixmap (ClassicStyle et ModernStyle), le widget latéral est affiché au-dessus du filigrane, pour les autres styles ou lorsque le filigrane n'est pas fourni, le widget latéral est affiché sur le côté gauche de l'assistant.

Si vous passez nullptr, aucun widget latéral n'est affiché.

Lorsque widget n'est pas nullptr, l'assistant le reporte.

Tout widget latéral précédent est masqué.

Vous pouvez appeler setSideWidget() avec le même widget à plusieurs reprises.

Tous les widgets définis ici seront supprimés par l'assistant lorsqu'il sera détruit, à moins que vous ne répartissiez séparément le widget après avoir défini un autre widget latéral (ou nullptr).

Par défaut, aucun widget latéral n'est présent.

Voir également sideWidget().

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

Réimplémente : QDialog::setVisible(bool visible).

QWidget *QWizard::sideWidget() const

Renvoie le widget situé à gauche de l'assistant ou nullptr.

Par défaut, aucun widget latéral n'est présent.

Voir également setSideWidget().

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

Réimplémente : QDialog::sizeHint() const.

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

Renvoie true si le site option est activé ; sinon, renvoie false.

Voir aussi options, setOption(), et setWizardStyle().

[virtual] bool QWizard::validateCurrentPage()

Cette fonction virtuelle est appelée par QWizard lorsque l'utilisateur clique sur Next ou Finish pour effectuer une validation de dernière minute. Si elle renvoie true, la page suivante est affichée (ou l'assistant se termine) ; sinon, la page actuelle reste affichée.

L'implémentation par défaut appelle QWizardPage::validatePage() sur currentPage().

Lorsque cela est possible, il est généralement préférable de désactiver le bouton Next ou Finish (en spécifiant mandatory fields ou en réimplémentant QWizardPage::isComplete()) plutôt que de réimplémenter validateCurrentPage().

Voir également QWizardPage::validatePage() et currentPage().

QList<int> QWizard::visitedIds() const

Renvoie la liste des ID des pages visitées, dans l'ordre dans lequel les pages ont été visitées.

Voir aussi hasVisitedPage().