Класс QWizardPage

Класс QWizardPage является базовым классом для страниц мастера. Подробнее...

Этот класс был представлен в Qt 4.3.

• Список всех членов, включая унаследованные члены

Свойства

• subTitle : QString
• title : QString

Открытые функции

Сигналы

Защищенные функции

Подробное описание

QWizard представляет собой мастера. Каждая страница — это QWizardPage. При создании собственных мастеров вы можете использовать QWizardPage напрямую или наследовать от него для большего контроля.

У страницы есть следующие атрибуты, которые отображаются QWizard: заголовок (title), подзаголовок (subTitle) и набор пиктограмм (set of pixmaps). Подробнее см. Элементы страницы мастера. После добавления страницы в мастер (с помощью QWizard::addPage() или QWizard::setPage()), wizard() возвращает указатель на связанный объект QWizard.

Страница предоставляет пять виртуальных функций, которые можно переопределить для предоставления настраиваемого поведения:

• initializePage() вызывается для инициализации содержимого страницы, когда пользователь нажимает кнопку «Далее» мастера. Если вы хотите вывести значение по умолчанию страницы из того, что ввёл пользователь на предыдущих страницах, следует переопределить эту функцию.
• cleanupPage() вызывается для сброса содержимого страницы, когда пользователь нажимает кнопку «Назад» мастера.
• validatePage() валидирует страницу, когда пользователь нажимает «Далее» или «Готово». Часто используется для отображения сообщения об ошибке, если пользователь ввёл неполную или недопустимую информацию.
• nextId() возвращает идентификатор следующей страницы. Это полезно при создании нелинейных мастеров, которые позволяют использовать различные пути навигации, основанные на введённой пользователем информации.
• isComplete() вызывается для определения того, следует ли активировать или деактивировать кнопку «Далее» и/или «Готово». Если вы переопределите isComplete(), убедитесь, что completeChanged() вызывается каждый раз, когда состояние «полноты» меняется.

Обычно кнопки «Далее» и «Готово» мастера взаимоисключающие. Если isFinalPage() возвращает true, доступна кнопка «Готово»; в противном случае доступна кнопка «Далее». По умолчанию isFinalPage() истинно только тогда, когда nextId() возвращает -1. Если вы хотите одновременно отображать кнопки «Далее» и «Готово» для страницы (позволяя пользователю выполнить «раннее завершение»), вызовите setFinalPage(true) для этой страницы. Для мастеров, поддерживающих раннее завершение, возможно, также стоит установить параметры HaveNextButtonOnLastPage и HaveFinishButtonOnEarlyPages для мастера.

Во многих мастерах содержимое страницы может влиять на значения по умолчанию полей на последующих страницах. Для упрощения взаимодействия между страницами QWizard поддерживает «механизм полей», позволяющий регистрировать поле (например, QLineEdit) на странице и получать доступ к его значению с любой страницы. Поля глобальны для всего мастера и упрощают доступ любой странице к информации, хранимой другой страницей, без необходимости размещения всей логики в QWizard или явного знания страниц друг о друге. Поля регистрируются с помощью registerField() и могут быть доступны в любое время с помощью field() и setField().

См. также QWizard, Пример класса мастера и Пример мастера лицензий.

Документация по членам-функциям

QWizardPage::QWizardPage(QWidget *parent = nullptr)

Конструирует страницу мастера с заданным parent.

При добавлении страницы в мастер с помощью QWizard::addPage() или QWizard::setPage(), родитель автоматически устанавливается в мастер.

См. также wizard().

void QWizardPage::completeChanged()

Этот сигнал испускается всякий раз, когда состояние завершения страницы (т.е., значение isComplete()) изменяется.

Если вы переопределяете isComplete(), убедитесь, что испускается completeChanged(), всякий раз, когда меняется значение isComplete(), чтобы гарантировать, что QWizard обновляет состояние кнопок.

См. также isComplete().

QWizardPage::~QWizardPage()

Деструктор.

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

Возвращает текст на кнопке which на этой странице.

Если текст был задан с помощью setButtonText(), возвращается этот текст. В противном случае, если текст был задан с помощью QWizard::setButtonText(), возвращается этот текст.

По умолчанию текст на кнопках зависит от стиля QWizard::wizardStyle. Например, на macOS кнопка Next называется Continue.

См. также setButtonText(), QWizard::buttonText() и QWizard::setButtonText().

void QWizardPage::cleanupPage()

Эта виртуальная функция вызывается QWizard::cleanupPage() при переходе пользователя на другую страницу нажатием кнопки Назад (если опция QWizard::IndependentPages не установлена).

Реализация по умолчанию сбрасывает поля страницы до их первоначальных значений (значений, которые у них были до вызова initializePage()).

См. также QWizard::cleanupPage(), initializePage() и QWizard::IndependentPages.

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

Возвращает значение поля с именем name.

Эта функция может использоваться для доступа к полям на любой странице мастера. Она эквивалентна вызову wizard()->field(name).

Пример:

См. также QWizard::field(), setField() и registerField().

void QWizardPage::initializePage()

Эта виртуальная функция вызывается QWizard::initializePage() для подготовки страницы перед её отображением, либо в результате вызова QWizard::restart(), либо в результате нажатия пользователем кнопки Далее. (Однако, если опция QWizard::IndependentPages установлена, эта функция вызывается только при первом отображении страницы.)

Переопределяя эту функцию, вы можете убедиться, что поля страницы инициализируются должным образом на основе полей предыдущих страниц. Например:

Реализация по умолчанию ничего не делает.

См. также QWizard::initializePage(), cleanupPage() и QWizard::IndependentPages.

bool QWizardPage::isCommitPage() const

Возвращает true, если эта страница является страницей подтверждения; в противном случае возвращает false.

См. также setCommitPage().

bool QWizardPage::isComplete() const

Эта виртуальная функция вызывается QWizard для определения, следует ли включать или отключать кнопку Далее или Завершить.

Реализация по умолчанию возвращает true, если все обязательные поля заполнены; в противном случае возвращает false.

Если вы переопределяете эту функцию, убедитесь, что испускается completeChanged(), из остальной части вашей реализации, всякий раз, когда меняется значение isComplete(). Это гарантирует, что QWizard обновляет состояние своих кнопок. Пример переопределения можно найти здесь.

См. также completeChanged() и isFinalPage().

bool QWizardPage::isFinalPage() const

Эта функция вызывается QWizard для определения, следует ли отображать кнопку Завершить на этой странице или нет.

По умолчанию она возвращает true, если нет следующей страницы (т.е., nextId() возвращает -1); в противном случае возвращает false.

Явно вызвав setFinalPage(true), вы можете позволить пользователю выполнить «раннее завершение».

См. также isComplete() и QWizard::HaveFinishButtonOnEarlyPages.

int QWizardPage::nextId() const

Эта виртуальная функция вызывается QWizard::nextId() для определения, какая страница должна быть отображена при нажатии пользователем кнопки Далее.

Возвращаемое значение — ID следующей страницы или -1, если за ней нет страницы.

По умолчанию эта функция возвращает наименьший ID, больший, чем ID текущей страницы, или -1, если такого ID нет.

Переопределяя эту функцию, вы можете указать динамический порядок страниц. Например:

См. также QWizard::nextId().

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

Возвращает пиктограмму, установленную для роли which.

Пиктограммы также могут быть установлены для всего мастера с помощью QWizard::setPixmap(), в этом случае они применяются ко всем страницам, не задающим свою пиктограмму.

См. также setPixmap(), QWizard::pixmap() и Элементы страницы мастера.

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

Создаёт поле с именем name, связанное с заданным property заданного widget. После этого это свойство становится доступным с помощью field() и setField().

Поля глобальны для всего мастера и облегчают доступ любой странице к информации, хранящейся на другой странице, без необходимости размещения всей логики в QWizard или явного знания страниц друг о друге.

Если name заканчивается звездочкой (*), поле является обязательным. Когда на странице есть обязательные поля, кнопки Далее и/или Готово активируются только при заполнении всех обязательных полей. Для этого необходимо указать changedSignal, чтобы сообщить QWizard о необходимости повторной проверки значения, хранящегося в обязательном поле.

QWizard знает большинство распространённых виджетов Qt. Для них (или их подклассов) не нужно указывать property или changedSignal. В таблице ниже перечислены эти виджеты:

Вы можете использовать QWizard::setDefaultProperty() для добавления записей в эту таблицу или для переопределения существующих записей.

Чтобы считать поле «заполненным», QWizard просто проверяет, что его текущее значение не равно его исходному значению (значению, которое оно имело до вызова initializePage()). Для QLineEdit также проверяется, что hasAcceptableInput() возвращает true, чтобы учесть любой валидатор или маску.

QWizard's механизм обязательных полей предоставлен для удобства. Его можно обойти, переопределив QWizardPage::isComplete().

См. также field(), setField(), и QWizard::setDefaultProperty().

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

Устанавливает текст на кнопке which на значение text на этой странице.

По умолчанию, текст на кнопках зависит от QWizard::wizardStyle, но может быть переопределен для всего мастера с помощью QWizard::setButtonText().

См. также buttonText(), QWizard::setButtonText(), и QWizard::buttonText().

void QWizardPage::setCommitPage(bool commitPage)

Устанавливает эту страницу как страницу подтверждения, если commitPage имеет значение true; в противном случае устанавливает её как обычную страницу.

Страница подтверждения — это страница, представляющая действие, которое нельзя отменить, нажав Назад или Отмена.

На странице подтверждения кнопка Далее заменяется кнопкой Подтвердить. Нажатие этой кнопки просто вызывает QWizard::next(), как при нажатии кнопки Далее.

На странице, в которую перешли напрямую со страницы подтверждения, кнопка Назад будет отключена.

См. также isCommitPage().

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

Устанавливает значение поля с именем name на значение value.

Эта функция может использоваться для установки полей на любой странице мастера. Она эквивалентна вызову wizard()->setField(name, value).

См. также QWizard::setField(), field(), и registerField().

void QWizardPage::setFinalPage(bool finalPage)

Явно устанавливает эту страницу как конечную, если finalPage имеет значение true.

После вызова setFinalPage(true), isFinalPage() возвращает true и кнопка Готово отображается (и активируется, если isComplete() возвращает true).

После вызова setFinalPage(false), isFinalPage() возвращает true если nextId() возвращает -1; в противном случае возвращает false.

См. также isFinalPage(), isComplete(), и QWizard::HaveFinishButtonOnEarlyPages.

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

Устанавливает растровое изображение для роли which на pixmap.

Растровые изображения используются QWizard при отображении страницы. Какие растровые изображения фактически используются, зависит от стиля мастера.

Растровые изображения также могут быть установлены для всего мастера с помощью QWizard::setPixmap(), в этом случае они применяются ко всем страницам, которые не задают собственное растровое изображение.

См. также pixmap(), QWizard::setPixmap(), и Элементы страницы мастера.

[virtual] bool QWizardPage::validatePage()

Эта виртуальная функция вызывается QWizard::validateCurrentPage() при нажатии пользователем на Далее или Готово для выполнения некоторой последней валидации. Если она возвращает true, отображается следующая страница (или мастер завершается); в противном случае текущая страница остается.

По умолчанию возвращает true.

В случае возможности, обычно предпочтительнее отключать кнопку Далее или Готово (указав обязательные поля или переопределив isComplete()) вместо переопределения validatePage().

См. также QWizard::validateCurrentPage() и isComplete().

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

Возвращает связанный с этой страницей мастер, или nullptr если эта страница ещё не вставлена в QWizard.

См. также QWizard::addPage() и QWizard::setPage().