QWizard Class

メンバ関数ドキュメント

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

与えられたparent とウィンドウflags を持つウィザードを構築します。

parent() およびwindowFlags()も参照して ください。

[virtual noexcept] QWizard::~QWizard()

ウィザードとそのページを破棄し、割り当てられたリソースを解放します。

int QWizard::addPage(QWizardPage *page)

与えられたpage をウィザードに追加し、そのページの ID を返します。

このIDは、これまでのQWizard のどのIDよりも大きいことが保証される。

setPage()、page()、pageAdded()も参照のこと 。

[slot] void QWizard::back()

前のページに戻る。

これはBack ボタンを押すのと同じことである。

next()、accept()、reject()、restart() も参照 。

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

ロールwhich に対応するボタンを返します。

setButton() およびsetButtonText() も参照 。

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

ボタンwhich のテキストを返します。

setButtonText() を使用してテキストが設定されている場合は、そのテキストが返されます。

デフォルトでは、ボタンのテキストはwizardStyle に依存します。例えば、macOS では、Next ボタンはContinue と呼ばれます。

button()、setButton()、setButtonText()、QWizardPage::buttonText()、QWizardPage::setButtonText()も参照のこと 。

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

この仮想関数は、Back （QWizard::IndependentPages オプションが設定されている場合を除く）をクリックしてユーザが離脱する直前に、QWizard によって呼び出され、id ページをクリーンアップします。

デフォルトの実装では、 page(id) でQWizardPage::cleanupPage() を呼び出します。

QWizardPage::cleanupPage() およびinitializePage()も参照してください 。

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

このシグナルは、現在のページが変更され、新しい現在のid 。

currentId() およびcurrentPage() も参照 。

QWizardPage *QWizard::currentPage() const

現在のページへのポインタを返し、現在のページがない場合（ウィザードが表示される前など）はnullptr を返します。

これは、 page(currentId()) を呼び出すのと同じです。

page()、currentId()、restart()も参照 。

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

このシグナルは、ユーザーがカスタム・ボタンをクリックしたときに発せられます。which には、CustomButton1 、CustomButton2 、CustomButton3 のいずれかを指定します。

デフォルトでは、カスタム・ボタンは表示されません。HaveCustomButton1 、HaveCustomButton2 、またはHaveCustomButton3 を指定してsetOption() を呼び出し、setButtonText() またはsetButton() を使用して設定します。

helpRequested()も参照 。

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

再実装：QDialog::done(int r)。

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

再実装：QWidget::event(QEvent *event)。

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

name と呼ばれるフィールドの値を返します。

この関数は、ウィザードのどのページのフィールドにもアクセスするために使用できます。

QWizardPage::registerField()、QWizardPage::field()、setField()も参照してください 。

bool QWizard::hasVisitedPage(int id) const

ページ履歴にid ページが含まれている場合はtrue を返し、そうでない場合はfalse を返します。

Back を押すと、現在のページを再び「未訪問」としてマークする。

visitedIds()も参照 。

[signal] void QWizard::helpRequested()

このシグナルは、ユーザーがHelp ボタンをクリックしたときに発せられる。

デフォルトでは、Help ボタンは表示されません。表示させるには、setOption(HaveHelpButton, true) を呼び出します。

例を示します：

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

}

customButtonClicked()も参照のこと 。

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

この仮想関数は、QWizard::restart() が呼び出された結果、またはユーザがNext をクリックした結果、id ページが表示される直前に、QWizard によって呼び出されて準備します (ただし、QWizard::IndependentPages オプションが設定されている場合、この関数が呼び出されるのは、ページが最初に表示されるときだけです)。

この関数を再実装することで、前のページのフィールドに基づいてページのフィールドが適切に初期化されるようにすることができます。

デフォルトの実装では、 page(id) でQWizardPage::initializePage() を呼び出します。

QWizardPage::initializePage() およびcleanupPage()も参照して ください。

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

再実装：QWidget::nativeEvent(const QByteArray &eventType, void *message, qintptr *result)を再実装します。

[slot] void QWizard::next()

次のページに進みます。

これは、Next またはCommit ボタンを押すことに相当する。

nextId()、back()、accept()、reject()、restart()も参照のこと 。

[virtual] int QWizard::nextId() const

この仮想関数は、QWizard によって呼び出され、ユーザーがNext ボタンをクリックしたときにどのページを表示するかを調べます。

戻り値は次のページのIDであり、次のページがない場合は-1である。

デフォルトの実装では、currentPage （）でQWizardPage::nextId （）を呼び出している。

この関数を再実装することで、動的なページ順序を指定できます。

QWizardPage::nextId() およびcurrentPage()も参照 。

QWizardPage *QWizard::page(int id) const

与えられたid を持つページ、またはそのようなページがない場合はnullptr を返します。

addPage() およびsetPage()も参照 。

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

このシグナルは、ウィザードにページが追加されるたびに発行されます。ページのid がパラメータとして渡される。

addPage()、setPage()、startId() も参照して ください。

QList<int> QWizard::pageIds() const

ページIDのリストを返す。

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

このシグナルは、ページがウィザードから削除されるたびに発行されます。ページのid がパラメータとして渡されます。

removePage() およびstartId()も参照してください 。

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

再実装：QWidget::paintEvent(QPaintEvent *event)。

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

ロールwhich に設定された pixmap を返します。

デフォルトでは、設定されている pixmap は macOS のBackgroundPixmap のみです。

setPixmap()、QWizardPage::pixmap()、Elements of a Wizard Pageも参照してください 。

void QWizard::removePage(int id)

指定されたid のページを削除します。 必要に応じてcleanupPage() が呼び出されます。

addPage()、setPage()、pageRemoved()、startId()も参照してください 。

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

再実装：QDialog::resizeEvent(QResizeEvent *)。

[slot] void QWizard::restart()

ウィザードを開始ページで再起動します。この関数は、ウィザードが表示されると自動的に呼び出されます。

startId()も参照してください 。

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

ロールwhich に対応するボタンをbutton に設定します。

ウィザードに追加ボタン（例えば、Print ボタン）を追加するには、CustomButton1 からCustomButton3 を指定して setButton() を呼び出し、HaveCustomButton1 からHaveCustomButton3 オプションを使用してボタンを表示する方法があります。

button()、setButtonText()、setButtonLayout()、optionsも参照 。

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

ボタンの表示順序をlayout に設定します。layout はWizardButtonのリストです。

デフ ォル ト の レ イ ア ウ ト は、 設定 さ れてい る オプシ ョ ン （HelpButtonOnRight かど う か等） に よ っ て異な り ます。options がすでに提供している以上のボタンレイアウトの制御が必要な場合、この関数を呼び出すことができます。

Stretch を使って、レイアウトの水平方向の伸縮を指定することができます。

例

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

setButton()、setButtonText()、setOptions()も参照してください 。

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

ボタンwhich のテキストをtext に設定します。

デフォルトでは、ボタンのテキストはwizardStyle に依存します。例えば、macOS では、Next ボタンはContinue と呼ばれます。

ウィザードに追加ボタン（例えば、Print ボタン）を追加するには、CustomButton1 、CustomButton2 、CustomButton3 で setButtonText() を呼び出してテキストを設定し、HaveCustomButton1 、HaveCustomButton2 、HaveCustomButton3 オプションを使用してボタンを表示させる方法があります。

ボタン・テキストは、QWizardPage::setButtonText （）を使用して、ページごとに設定することもできます。

buttonText()、setButton()、button()、setButtonLayout()、setOptions()、QWizardPage::setButtonText()も参照のこと 。

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

currentId とid の間のページを訪問せずに、currentId をid に設定する。

を設定する。

• wizardがページを保持していない
• 現在のページが無効
• 指定されたページがcurrentId() と等しい
• 与えられたページが範囲外

注: ページが前方にスキップされ、id が 0 の場合、ページ訪問履歴は削除されます。

currentId()も参照 。

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

className のデフォルト・プロパティをproperty に、関連する変更シグナルをchangedSignal に設定します。

デフォルト・プロパティは、className （またはそのサブクラスの 1 つ）のインスタンスがQWizardPage::registerField() に渡され、プロパティが指定されていない場合に使用されます。

QWizard は、最も一般的な Qt ウィジェットを知っています。これら（またはそのサブクラス）については、 や を指定する必要はありません。以下の表に、これらのウィジェットを示します：property changedSignal

QWizardPage::registerField()も参照 。

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

name というフィールドの値をvalue に設定します。

この関数は、ウィザードのどのページでもフィールドを設定するために使用できます。

QWizardPage::registerField()、QWizardPage::setField() およびfield() も参照して ください。

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

on が真の場合、指定されたoption を有効に設定します。そうでない場合、指定されたoption をクリアします。

options 、testOption()、setWizardStyle()も参照 。

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

与えられたid で、与えられたpage をウィザードに追加します。

addPage()、page()、pageAdded()も参照して ください。

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

ロールwhich のpixmapをpixmap に設定します。

pixmapは、ページを表示するときにQWizard 。どの pixmap が実際に使用されるかは、wizard style に依存します。

ピクスマップは、QWizardPage::setPixmap() を使用して、特定のページに設定することもできる。

pixmap()、QWizardPage::setPixmap()、Elements of a Wizard Pageも参照のこと 。

void QWizard::setSideWidget(QWidget *widget)

指定されたwidget をウィザードの左側に表示するように設定します。WatermarkPixmap (ClassicStyle とModernStyle) を使用するスタイルでは、サイド・ウィジェットは透かしの上に表示され、その他のスタイルまたは透かしが提供されない場合、サイド・ウィジェットはウィザードの左側に表示されます。

nullptr を渡すと、サイド・ウィジェットは表示されません。

widget がnullptr でない場合、ウィザードはそれを再表示します。

以前のサイド・ウィジェットは非表示になります。

同じウィジェットでsetSideWidget()を異なる時間に呼び出すことができます。

他のサイド・ウィジェット（またはnullptr ）を設定した後に別途ウィジェットを再保護しない限り、ここで設定されたすべてのウィジェットは、ウィザードが破棄されるときにウィザードによって削除されます。

デフォルトでは、サイド・ウィジェットは存在しません。

sideWidget()も参照してください 。

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

再インプリメント：QDialog::setVisible(bool visible).

QWidget *QWizard::sideWidget() const

ウィザードの左側にあるウィジェットかnullptr を返します。

デフォルトでは、サイド・ウィジェットは存在しません。

setSideWidget() も参照して ください。

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

再インプリメント：QDialog::sizeHint() const.

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

与えられたoption が有効であればtrue を返し、そうでなければ false を返す。

options 、setOption()、setWizardStyle()も参照 。

[virtual] bool QWizard::validateCurrentPage()

この仮想関数は、ユーザがNext またはFinish をクリックして最後の検証を行うときにQWizard によって呼び出されます。これがtrue を返すと、次のページが表示されます（またはウィザードが終了します）。

デフォルトの実装では、currentPage （）上でQWizardPage::validatePage （）を呼び出します。

可能な場合、validateCurrentPage()を再実装するよりも、Next またはFinish ボタンを無効にする（mandatory fields を指定するか、QWizardPage::isComplete()を再実装する）方が、通常は良いスタイルです。

QWizardPage::validatePage() およびcurrentPage()も参照 。

QList<int> QWizard::visitedIds() const

訪問したページの ID のリストを、訪問した順番に返します。

hasVisitedPage()も参照して ください。