QWizardPage Class

Documentation des fonctions membres

[explicit] QWizardPage::QWizardPage(QWidget *parent = nullptr)

Crée une page d'assistant à partir de l'parent fournie.

Lorsque la page est insérée dans un assistant à l’aide de QWizard::addPage() ou QWizard::setPage(), l’élément parent est automatiquement défini comme étant l’assistant.

Voir également wizard().

[virtual noexcept] QWizardPage::~QWizardPage()

Destructeur.

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

Renvoie le texte du bouton which sur cette page.

Si un texte a été défini à l'aide de la méthode setButtonText(), c'est ce texte qui est renvoyé. Sinon, si un texte a été défini à l'aide de la méthode QWizard::setButtonText(), c'est ce texte qui est renvoyé.

Par défaut, le texte des boutons dépend de la méthode QWizard::wizardStyle. Par exemple, sous macOS, le bouton Next s’appelle Continue.

Voir également setButtonText(), QWizard::buttonText() et QWizard::setButtonText().

[virtual] void QWizardPage::cleanupPage()

Cette fonction virtuelle est appelée par ` QWizard::cleanupPage()` lorsque l'utilisateur quitte la page en cliquant sur ` Back ` (à moins que l'option ` QWizard::IndependentPages ` ne soit activée).

L'implémentation par défaut réinitialise les champs de la page à leurs valeurs d'origine (celles qu'ils avaient avant l'appel de initializePage()).

Voir également QWizard::cleanupPage(), initializePage() et QWizard::IndependentPages.

[signal] void QWizardPage::completeChanged()

Ce signal est émis chaque fois que l'état « complete » de la page (c'est-à-dire la valeur de ` isComplete()`) change.

Si vous réimplémentez la méthode isComplete(), veillez à émettre completeChanged() chaque fois que la valeur de isComplete() change, afin de garantir que QWizard mette à jour l’état activé ou désactivé de ses boutons.

Voir également isComplete().

[protected] QVariant QWizardPage::field(const QString &name) const

Renvoie la valeur du champ nommé « name ».

Cette fonction permet d'accéder aux champs de n'importe quelle page de l'assistant. Elle équivaut à appeler wizard()->field(name).

Exemple :

        const QString emailAddress = field("details.email").toString();
        licenseText = tr("<u>First-Time License Agreement:</u> "
                         "You can use this software subject to the license "
                         "you will receive by email sent to %1.").arg(emailAddress);

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

[virtual] void QWizardPage::initializePage()

Cette fonction virtuelle est appelée par ` QWizard::initializePage()` afin de préparer la page juste avant son affichage, soit à la suite de l'appel de ` QWizard::restart()`, soit lorsque l'utilisateur clique sur ` Next`. (Toutefois, si l'option ` QWizard::IndependentPages ` est activée, cette fonction n'est appelée que lors du premier affichage de la page.)

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. Par exemple :

void ConclusionPage::initializePage()
{
    QString licenseText;

    if (wizard()->hasVisitedPage(LicenseWizard::Page_Evaluate)) {
        licenseText = tr("<u>Evaluation License Agreement:</u> "
                         "You can use this software for 30 days and make one "
                         "backup, but you are not allowed to distribute it.");
    } else if (wizard()->hasVisitedPage(LicenseWizard::Page_Details)) {
        const QString emailAddress = field("details.email").toString();
        licenseText = tr("<u>First-Time License Agreement:</u> "
                         "You can use this software subject to the license "
                         "you will receive by email sent to %1.").arg(emailAddress);
    } else {
        licenseText = tr("<u>Upgrade License Agreement:</u> "
                         "This software is licensed under the terms of your "
                         "current license.");
    }
    bottomLabel->setText(licenseText);
}

L’implémentation par défaut ne fait rien.

Voir également QWizard::initializePage(), cleanupPage() et QWizard::IndependentPages.

bool QWizardPage::isCommitPage() const

Renvoie « true » si cette page est une page de validation ; sinon, renvoie « false ».

Voir aussi setCommitPage().

[virtual] bool QWizardPage::isComplete() const

Cette fonction virtuelle est appelée par ` QWizard ` afin de déterminer si le bouton ` Next ` ou ` Finish ` doit être activé ou désactivé.

L'implémentation par défaut renvoie « true » si tous les champs mandatory fields sont renseignés ; dans le cas contraire, elle renvoie « false ».

Si vous réimplémentez cette fonction, veillez à émettre completeChanged() depuis le reste de votre implémentation chaque fois que la valeur de isComplete() change. Cela garantit que QWizard met à jour l’état d’activation ou de désactivation de ses boutons. Un exemple de réimplémentation est disponible ici.

Voir également completeChanged() et isFinalPage().

bool QWizardPage::isFinalPage() const

Cette fonction est appelée par QWizard afin de déterminer si le bouton « Finish » doit s'afficher ou non sur cette page.

Par défaut, elle renvoie « true » s'il n'y a pas de page suivante (c'est-à-dire que nextId() renvoie -1) ; dans le cas contraire, elle renvoie « false ».

En appelant explicitement setFinalPage(true), vous pouvez permettre à l’utilisateur de « terminer plus tôt ».

Voir également isComplete() et QWizard::HaveFinishButtonOnEarlyPages.

[virtual] int QWizardPage::nextId() const

Cette fonction virtuelle est appelée par ` QWizard::nextId()` afin de déterminer quelle page afficher lorsque l'utilisateur clique sur le bouton « Next ».

La valeur renvoyée est l'ID de la page suivante, ou -1 s'il n'y a pas de page suivante.

Par défaut, cette fonction renvoie l'ID le plus bas supérieur à celui de la page actuelle, ou -1 s'il n'existe pas.

En réimplémentant cette fonction, vous pouvez définir un ordre dynamique des pages. Par exemple :

int IntroPage::nextId() const
{
    if (evaluateRadioButton->isChecked()) {
        return LicenseWizard::Page_Evaluate;
    } else {
        return LicenseWizard::Page_Register;
    }
}

Voir également ` QWizard::nextId()`.

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

Renvoie la carte de pixels définie pour le rôle « which ».

Il est également possible de définir des pixmaps pour l'ensemble de l'assistant à l'aide de la fonction QWizard::setPixmap(), auquel cas celles-ci s'appliquent à toutes les pages qui ne spécifient pas de pixmap.

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

[protected] void QWizardPage::registerField(const QString &name, QWidget *widget, const char *property = nullptr, const char *changedSignal = nullptr)

Crée un champ nommé « name » associé à l'property spécifiée de l'widget indiquée. Dès lors, cette propriété devient accessible via les méthodes field() et setField().

Les champs sont globaux à l’ensemble de l’assistant et permettent à n’importe quelle page d’accéder facilement aux informations stockées par une autre page, sans avoir à placer toute la logique dans QWizard ni à ce que les pages aient connaissance explicitement les unes des autres.

Si name se termine par un astérisque (*), le champ est obligatoire. Lorsqu’une page comporte des champs obligatoires, les boutons « Next » et/ou « Finish » ne sont activés que lorsque tous les champs obligatoires sont renseignés. Cela nécessite de spécifier un changedSignal, afin d’indiquer à QWizard de revérifier la valeur stockée par le champ obligatoire.

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

Vous pouvez utiliser QWizard::setDefaultProperty() pour ajouter des entrées à cette table ou pour remplacer des entrées existantes.

Pour considérer qu’un champ est « renseigné », la méthode ` QWizard ` vérifie simplement que sa valeur actuelle n’est pas égale à sa valeur d’origine (celle qu’il avait avant l’appel de ` initializePage()`). Pour ` QLineEdit`, elle vérifie également que la méthode ` hasAcceptableInput()` renvoie `true`, afin de respecter tout validateur ou masque.

QWizardLe mécanisme de champs obligatoires de `xml-ph-0002` est fourni à titre de commodité. Il peut être contourné en réimplémentant ` QWizardPage::isComplete()`.

Voir également field(), setField() et QWizard::setDefaultProperty().

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

Définit le texte du bouton « which » sur « text » sur cette page.

Par défaut, le texte des boutons dépend de l'QWizard::wizardStyle, mais peut être redéfini pour l'assistant dans son ensemble à l'aide de QWizard::setButtonText().

Voir également buttonText(), QWizard::setButtonText() et QWizard::buttonText().

void QWizardPage::setCommitPage(bool commitPage)

Définit cette page comme une page de validation si la valeur de commitPage est « true » ; dans le cas contraire, la définit comme une page normale.

Une page de validation est une page qui représente une action qui ne peut pas être annulée en cliquant sur « Back » ou « Cancel ».

Sur une page de validation, le bouton « Commit » remplace le bouton « Next ». Cliquer sur ce bouton appelle simplement la fonction QWizard::next(), tout comme le fait de cliquer sur « Next ».

Le bouton « Back » est désactivé sur une page accessible directement depuis une page de validation.

Voir également isCommitPage().

[protected] void QWizardPage::setField(const QString &name, const QVariant &value)

Définit la valeur du champ « name » sur « value ».

Cette fonction peut être utilisée pour définir des champs sur n'importe quelle page de l'assistant. Elle équivaut à appeler wizard()->setField(name, value).

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

void QWizardPage::setFinalPage(bool finalPage)

Définit explicitement cette page comme finale si la valeur de ` finalPage ` est `true`.

Après avoir appelé setFinalPage(true), la méthode isFinalPage() renvoie true et le bouton « Finish » est visible (et activé si la méthode isComplete() renvoie true).

Après avoir appelé setFinalPage(false), la méthode isFinalPage() renvoie true si la méthode nextId() renvoie -1 ; sinon, elle renvoie false.

Voir également isFinalPage(), isComplete() et QWizard::HaveFinishButtonOnEarlyPages.

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

Définit la carte de pixels du rôle « which » sur « pixmap ».

Les images pixmap sont utilisées par ` QWizard ` lors de l'affichage d'une page. Les images pixmap effectivement utilisées dépendent de ` wizard style`.

Les images pixmap peuvent également être définies pour l’ensemble de l’assistant à l’aide de la fonction ` QWizard::setPixmap()`, auquel cas elles s’appliquent à toutes les pages qui ne spécifient pas d’image pixmap.

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

[virtual] bool QWizardPage::validatePage()

Cette fonction virtuelle est appelée par ` QWizard::validateCurrentPage()` lorsque l'utilisateur clique sur Next ou Finish afin d'effectuer une validation de dernière minute. Si elle renvoie ` true`, la page suivante s'affiche (ou l'assistant se termine) ; dans le cas contraire, la page actuelle reste affichée.

L'implémentation par défaut renvoie true.

Dans la mesure du 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 ` isComplete()`) plutôt que de réimplémenter `validatePage()`.

Voir également QWizard::validateCurrentPage() et isComplete().

[protected] QWizard *QWizardPage::wizard() const

Renvoie l'assistant associé à cette page, ou nullptr si cette page n'a pas encore été insérée dans un QWizard.

Voir aussi QWizard::addPage() et QWizard::setPage().