QWizard Class

Documentation des fonctions membres

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

Crée un assistant avec l'parent et la fenêtre flags indiquées.

Voir également parent() et windowFlags().

[virtual noexcept] QWizard::~QWizard()

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

int QWizard::addPage(QWizardPage *page)

Ajoute l'page ion indiquée à l'assistant et renvoie l'ID de la page.

L'ID est garanti d'être supérieur à tout autre ID de l'QWizard jusqu'à présent.

Voir également ` setPage()`, ` page()` et ` pageAdded()`.

[slot] void QWizard::back()

Permet de revenir à la page précédente.

Cela revient à cliquer sur le bouton « Back ».

Voir également next(), accept(), reject() et restart().

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

Renvoie le bouton correspondant au rôle « which ».

Voir également setButton() et setButtonText().

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

Renvoie le texte affiché sur le bouton « which ».

Si un texte a été défini à l’aide de la fonction setButtonText(), c’est ce texte qui est renvoyé.

Par défaut, le texte des boutons dépend de la valeur de ` wizardStyle`. Par exemple, sous macOS, le bouton « Next » s’appelle « 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 vider la page id juste avant que l'utilisateur ne la quitte en cliquant sur Back (à moins que l'option QWizard::IndependentPages ne soit activée).

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

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

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

Ce signal est émis lorsque la page active change, la nouvelle page active étant id.

Voir également currentId() et currentPage().

QWizardPage *QWizard::currentPage() const

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

Cela revient à appeler page(currentId()).

Voir également page(), currentId() et restart().

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

Ce signal est émis lorsque l'utilisateur clique sur un bouton personnalisé. which peut prendre les valeurs suivantes : CustomButton1, CustomButton2 ou CustomButton3.

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

Voir également 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 intitulé « name ».

Cette fonction permet d'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 l'id; sinon, renvoie false.

En appuyant sur Back, la page actuelle est à nouveau marquée 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 la fonction ` setOption(HaveHelpButton, true)` pour en afficher 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 l'id de la page juste avant son affichage, soit à la suite de l'appel de la fonction 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.

L'implémentation par défaut appelle la fonction ` 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 revient à cliquer 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 ` 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.

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

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

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

QWizardPage *QWizard::page(int id) const

Renvoie la page dont l'id est indiquée, ou nullptr si cette page n'existe pas.

Voir également addPage() et setPage().

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

Ce signal est émis chaque fois qu’une page est ajoutée à l’assistant. L’ id de la page est transmise en tant que paramètre.

Voir également 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 chaque fois qu'une page est supprimée de l'assistant. L'id de la page est transmise en tant que 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 carte de pixels définie pour le rôle « which ».

Par défaut, la seule image définie est « BackgroundPixmap » sous macOS.

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

void QWizard::removePage(int id)

Supprime la page dont l'id est indiquée. La fonction cleanupPage() sera appelée 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()

Relance l'assistant à partir de la page d'accueil. Cette fonction est appelée automatiquement lorsque l'assistant s'affiche.

Voir également startId().

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

Définit le bouton correspondant au rôle « which » sur « button ».

Pour ajouter des boutons supplémentaires à l'assistant (par exemple, un bouton « Print »), une solution consiste à appeler la méthode `setButton()` en remplaçant ` CustomButton1 ` par ` CustomButton3`, puis à rendre les boutons visibles à l'aide des options ` HaveCustomButton1 ` et ` 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 d'WizardButton.

La disposition 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é sur la disposition des boutons que ce qu’ options offre déjà.

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 » sur « text ».

Par défaut, le texte des boutons dépend de l'wizardStyle. Par exemple, sous macOS, le bouton « Next » s'appelle « Continue ».

Pour ajouter des boutons supplémentaires à l’assistant (par exemple, un bouton « Print »), une solution consiste à appeler la méthode setButtonText() avec les paramètres « CustomButton1 », « CustomButton2 » ou « CustomButton3 » pour définir leur texte, puis à rendre les boutons visibles à l’aide des options « HaveCustomButton1 », « HaveCustomButton2 » et/ou « HaveCustomButton3 ».

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

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

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

Définit currentId sur id, sans passer par les pages situées entre currentId et id.

Renvoie le résultat sans changement de page, si

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

Remarque : si des pages ont été sautées et que id est égal à 0, l'historique de navigation 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 ` sur ` property` et le signal de modification associé sur ` 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 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 ` ni un ` 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 « name » sur « 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)

Active l'option spécifiée si on est vrai ; dans le cas contraire, désactive l'option spécifiée.

Voir également options, testOption() et setWizardStyle().

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

Ajoute l'page on indiquée à l'assistant avec l'id on indiquée.

Voir également addPage(), page() et pageAdded().

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

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

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

Les images pixmap peuvent également être définies pour une page spécifique à l’aide de la fonction ` QWizardPage::setPixmap()`.

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

void QWizard::setSideWidget(QWidget *widget)

Définit l'widget on fournie comme élément à afficher sur le côté gauche de l'assistant. Pour les styles utilisant l'WatermarkPixmap (ClassicStyle et ModernStyle), le widget latéral s'affiche par-dessus le filigrane ; pour les autres styles ou lorsque le filigrane n'est pas fourni, le widget latéral s'affiche sur le côté gauche de l'assistant.

Si l’on transmet nullptr, aucun widget latéral n’est affiché.

Lorsque l'widget n'est pas de type nullptr, l'assistant le réaffecte à un parent.

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

Vous pouvez appeler setSideWidget() avec le même widget à différents moments.

Tous les widgets définis ici seront supprimés par l'assistant lors de sa destruction, à moins que vous ne redéfinissiez séparément le parent du 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 de l'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 l'option on indiquée est activée ; sinon, renvoie « false ».

Voir également options, setOption() et setWizardStyle().

[virtual] bool QWizard::validateCurrentPage()

Cette fonction virtuelle est appelée par ` QWizard ` 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 appelle la méthode ` QWizardPage::validatePage()` depuis la méthode ` currentPage()`.

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 ` 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 identifiants des pages consultées, dans l'ordre dans lequel elles ont été consultées.

Voir également hasVisitedPage().