QWizard Class

Documentación de las funciones miembro

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

Construye un asistente con la dirección parent y la ventana flags.

Véase también parent() y windowFlags().

[virtual noexcept] QWizard::~QWizard()

Destruye el asistente y sus páginas, liberando los recursos asignados.

int QWizard::addPage(QWizardPage *page)

Añade la página page al asistente y devuelve el ID de la página.

Se garantiza que el ID sea mayor que cualquier otro ID de QWizard hasta el momento.

Véase también setPage(), page() y pageAdded().

[slot] void QWizard::back()

Vuelve a la página anterior.

Equivale a pulsar el botón Back.

Véase también next(), accept(), reject() y restart().

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

Devuelve el botón correspondiente al rol which.

Véase también setButton() y setButtonText().

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

Devuelve el texto del botón which.

Si se ha establecido un texto mediante setButtonText(), se devuelve dicho texto.

Por defecto, el texto de los botones depende de wizardStyle. Por ejemplo, en macOS, el botón Next se llama Continue.

Véase también button(), setButton(), setButtonText(), QWizardPage::buttonText() y QWizardPage::setButtonText().

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

Esta función virtual es llamada por QWizard para limpiar la página id justo antes de que el usuario la abandone haciendo clic en Back (a menos que la opción QWizard::IndependentPages esté activada).

La implementación por defecto llama a QWizardPage::cleanupPage() en page(id).

Véase también QWizardPage::cleanupPage() y initializePage().

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

Esta señal se emite cuando cambia la página actual, con la nueva corriente id.

Véase también currentId() y currentPage().

QWizardPage *QWizard::currentPage() const

Devuelve un puntero a la página actual, o nullptr si no hay página actual (por ejemplo, antes de que se muestre el asistente).

Esto es equivalente a llamar a page(currentId()).

Véase también page(), currentId() y restart().

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

Esta señal se emite cuando el usuario pulsa un botón personalizado. which puede ser CustomButton1, CustomButton2, o CustomButton3.

Por defecto, no se muestra ningún botón personalizado. Llame a setOption() con HaveCustomButton1, HaveCustomButton2, o HaveCustomButton3 para tener uno, y utilice setButtonText() o setButton() para configurarlo.

Véase también helpRequested().

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

Reimplementa: QDialog::done(int r).

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

Reimplementa: QWidget::event(QEvent *event).

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

Devuelve el valor del campo llamado name.

Esta función puede utilizarse para acceder a campos de cualquier página del asistente.

Véase también QWizardPage::registerField(), QWizardPage::field() y setField().

bool QWizard::hasVisitedPage(int id) const

Devuelve true si el historial de páginas contiene la página id; en caso contrario, devuelve false.

Al pulsar Back se vuelve a marcar la página actual como "no visitada".

Véase también visitedIds().

[signal] void QWizard::helpRequested()

Esta señal se emite cuando el usuario pulsa el botón Help.

Por defecto, no se muestra ningún botón Help. Llame a setOption(HaveHelpButton, true) para tener uno.

Ejemplo:

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

}

Véase también customButtonClicked().

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

Esta función virtual es llamada por QWizard para preparar la página id justo antes de que se muestre, ya sea como resultado de la llamada a QWizard::restart(), o como resultado de que el usuario haga clic en Next. (Sin embargo, si se establece la opción QWizard::IndependentPages, esta función sólo se llama la primera vez que se muestra la página).

Al reimplementar esta función, puede asegurarse de que los campos de la página se inicializan correctamente basándose en los campos de páginas anteriores.

La implementación por defecto llama a QWizardPage::initializePage() en page(id).

Véase también QWizardPage::initializePage() y cleanupPage().

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

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

[slot] void QWizard::next()

Avanza a la página siguiente.

Equivale a pulsar el botón Next o Commit.

Véase también nextId(), back(), accept(), reject() y restart().

[virtual] int QWizard::nextId() const

Esta función virtual es llamada por QWizard para averiguar qué página mostrar cuando el usuario pulsa el botón Next.

El valor de retorno es el ID de la página siguiente, o -1 si no hay ninguna página a continuación.

La implementación por defecto llama a QWizardPage::nextId() en currentPage().

Si reimplementa esta función, puede especificar un orden de páginas dinámico.

Véase también QWizardPage::nextId() y currentPage().

QWizardPage *QWizard::page(int id) const

Devuelve la página con el nombre id, o nullptr si no existe.

Véase también addPage() y setPage().

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

Esta señal se emite cada vez que se añade una página al asistente. La página id se pasa como parámetro.

Véase también addPage(), setPage() y startId().

QList<int> QWizard::pageIds() const

Devuelve la lista de identificadores de página.

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

Esta señal se emite cada vez que se elimina una página del asistente. La página id se pasa como parámetro.

Véase también removePage() y startId().

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

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

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

Devuelve el mapa de píxeles establecido para el rol which.

Por defecto, el único pixmap que se establece es el BackgroundPixmap en macOS.

Véase también setPixmap(), QWizardPage::pixmap(), y Elements of a Wizard Page.

void QWizard::removePage(int id)

Elimina la página con la propiedad id. Si es necesario, se llamará a cleanupPage().

Véase también addPage(), setPage(), pageRemoved() y startId().

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

Reimplementa: QDialog::resizeEvent(QResizeEvent *).

[slot] void QWizard::restart()

Reinicia el asistente en la página de inicio. Esta función se llama automáticamente cuando se muestra el asistente.

Véase también startId().

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

Establece el botón correspondiente al rol which a button.

Para añadir botones adicionales al asistente (por ejemplo, un botón Print ), una forma es llamar a setButton() con CustomButton1 a CustomButton3, y hacer visibles los botones utilizando las opciones HaveCustomButton1 a HaveCustomButton3.

Véase también button(), setButtonText(), setButtonLayout(), y options.

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

Establece el orden en que se muestran los botones en layout, donde layout es una lista de WizardButtons.

La disposición por defecto depende de las opciones (por ejemplo, si HelpButtonOnRight) que se establezcan. Puede llamar a esta función si necesita más control sobre la disposición de los botones que el que ya proporciona options.

Puede especificar tramos horizontales en la disposición utilizando Stretch.

Ejemplo:

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

Véase también setButton(), setButtonText(), y setOptions().

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

Establece que el texto del botón which sea text.

Por defecto, el texto de los botones depende de wizardStyle. Por ejemplo, en macOS, el botón Next se llama Continue.

Para añadir botones adicionales al asistente (por ejemplo, un botón Print ), una forma es llamar a setButtonText() con CustomButton1, CustomButton2, o CustomButton3 para establecer su texto, y hacer visibles los botones utilizando las opciones HaveCustomButton1, HaveCustomButton2, y/o HaveCustomButton3.

Los textos de los botones también pueden establecerse para cada página utilizando QWizardPage::setButtonText().

Véase también buttonText(), setButton(), button(), setButtonLayout(), setOptions() y QWizardPage::setButtonText().

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

Establece currentId en id, sin visitar las páginas entre currentId y id.

Vuelve sin cambiar de página, si

• el asistente no tiene páginas
• la página actual no es válida
• la página dada es igual a currentId()
• la página dada está fuera de rango

Nota: Si se han saltado páginas hacia delante y id es 0, se borrará el historial de visitas a páginas

Véase también currentId().

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

Establece la propiedad por defecto para className en property, y la señal de cambio asociada en changedSignal.

La propiedad por defecto se utiliza cuando se pasa una instancia de className (o de una de sus subclases) a QWizardPage::registerField() y no se especifica ninguna propiedad.

QWizard conoce los widgets Qt más comunes. Para estos (o sus subclases), no es necesario especificar un property o un changedSignal. La siguiente tabla enumera estos widgets:

Véase también QWizardPage::registerField().

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

Establece el valor del campo llamado name a value.

Esta función se puede utilizar para establecer campos en cualquier página del asistente.

Véase también QWizardPage::registerField(), QWizardPage::setField() y field().

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

Establece el option dado para que esté habilitado si on es verdadero; de lo contrario, borra el option dado.

Véase también options, testOption(), y setWizardStyle().

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

Añade la página page al asistente con la propiedad id.

Véase también addPage(), page(), y pageAdded().

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

Establece el mapa de píxeles del rol which en pixmap.

Los pixmaps son utilizados por QWizard cuando se muestra una página. Los mapas de píxeles que se utilicen dependerán de wizard style.

Los mapas de píxeles también pueden establecerse para una página específica utilizando QWizardPage::setPixmap().

Véase también pixmap(), QWizardPage::setPixmap(), y Elements of a Wizard Page.

void QWizard::setSideWidget(QWidget *widget)

Establece el widget dado para que se muestre en el lado izquierdo del asistente. Para los estilos que utilizan WatermarkPixmap (ClassicStyle y ModernStyle) el widget lateral se muestra encima de la marca de agua, para otros estilos o cuando no se proporciona la marca de agua el widget lateral se muestra en el lado izquierdo del asistente.

Si se pasa nullptr no se muestra el widget lateral.

Cuando el widget no es nullptr el asistente lo reparte.

Cualquier widget lateral anterior se oculta.

Puede llamar a setSideWidget() con el mismo widget en diferentes ocasiones.

Todos los widgets establecidos aquí serán eliminados por el asistente cuando se destruya, a menos que se reparente el widget por separado después de establecer algún otro widget lateral (o nullptr).

Por defecto, ningún widget lateral está presente.

Véase también sideWidget().

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

Reimplementa: QDialog::setVisible(bool visible).

QWidget *QWizard::sideWidget() const

Devuelve el widget del lado izquierdo del asistente o nullptr.

Por defecto, no hay widget lateral.

Véase también setSideWidget().

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

Reimplementa: QDialog::sizeHint() const.

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

Devuelve true si el option dado está habilitado; en caso contrario, devuelve false.

Véase también options, setOption(), y setWizardStyle().

[virtual] bool QWizard::validateCurrentPage()

Esta función virtual es llamada por QWizard cuando el usuario pulsa Next o Finish para realizar alguna validación de última hora. Si devuelve true, se muestra la página siguiente (o finaliza el asistente); en caso contrario, se mantiene la página actual.

La implementación por defecto llama a QWizardPage::validatePage() en currentPage().

Cuando sea posible, suele ser mejor estilo desactivar el botón Next o Finish (especificando mandatory fields o reimplementando QWizardPage::isComplete()) que reimplementar validateCurrentPage().

Véase también QWizardPage::validatePage() y currentPage().

QList<int> QWizard::visitedIds() const

Devuelve la lista de IDs de las páginas visitadas, en el orden en que fueron visitadas.

Véase también hasVisitedPage().