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)

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

デフォルトの実装では、ページ (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 によって呼び出され、QWizard::restart() の呼び出し結果として、あるいはユーザーがNext をクリックした結果として、ページid が表示される直前に、そのページの準備を行います。（ただし、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

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

戻り値は次のページの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 」に設定されているピクマップを返します。

デフォルトでは、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 ボタン）を追加するには、setButton() を呼び出してCustomButton1 をCustomButton3 に設定し、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 ボタン）を追加するには、setButtonText()をCustomButton1 、CustomButton2 、またはCustomButton3 で呼び出してテキストを設定し、HaveCustomButton1 、HaveCustomButton2 、および/またはHaveCustomButton3 オプションを使用してボタンを表示させるという方法があります。

また、QWizardPage::setButtonText() を使用することで、ページごとにボタンのテキストを設定することも可能です。

buttonText()、setButton()、button()、setButtonLayout()、setOptions()、およびQWizardPage::setButtonText()も参照してください 。

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

currentId からid までのページを経由せずに、currentId をid に設定します。

ページ変更なしで戻ります（ただし、

• ウィザードにページが含まれていない場合
• 現在のページが無効である場合
• 指定されたページがcurrentId() と等しい場合
• 指定されたページが範囲外の場合

注：ページが先へスキップされ、id が 0 の場合、ページ閲覧履歴は削除されます

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

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

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

このデフォルトプロパティは、className （またはそのサブクラスのいずれか）のインスタンスが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 がtrueの場合、指定されたoption を有効に設定します。そうでない場合は、指定されたoption をクリアします。

options 、testOption()、およびsetWizardStyle()も参照してください 。

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

指定されたpage を、指定されたid を持つウィザードに追加します。

関連項目： addPage()、page()、およびpageAdded()。

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

ロール「which 」のピクマップを「pixmap 」に設定します。

ピクマップは、QWizard がページを表示する際に使用されます。実際にどのピクマップが使用されるかは、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()`を再実装するよりも、`mandatory fields `を指定するか、`QWizardPage::isComplete()`を再実装して、`Next `または`Finish `ボタンを無効にする方が、通常は良いコーディングスタイルです。

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

QList<int> QWizard::visitedIds() const

アクセスしたページのIDのリストを、ページにアクセスした順序で返します。

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