DialogButtonBox QML Type

ダイアログで使用されるボタンボックス。詳細...

• 継承されたメンバーを含む、すべてのメンバーの一覧

プロパティ

• alignment : flags
• buttonLayout : enumeration (since QtQuick.Controls 2.5 (Qt 5.12))
• defaultButton : AbstractButton (since 6.11)
• defaultStandardButton : enumeration (since 6.11)
• delegate : Component
• position : enumeration
• standardButtons : enumeration

関連するプロパティ

• buttonBox : DialogButtonBox
• buttonRole : enumeration

信号

• accepted()
• applied() (since QtQuick.Controls 2.3 (Qt 5.10))
• clicked(AbstractButton button)
• discarded() (since QtQuick.Controls 2.3 (Qt 5.10))
• helpRequested()
• rejected()
• reset() (since QtQuick.Controls 2.3 (Qt 5.10))

方法

• AbstractButton standardButton(StandardButton button)

詳細説明

ダイアログやメッセージボックスでは、通常、そのプラットフォームのインターフェースガイドラインに準拠した順序でボタンが表示されます。当然ながら、プラットフォームによってダイアログボタンの順序は異なります。DialogButtonBox を使用すると、開発者はボタンを追加するだけで、ユーザーのプラットフォームに適した順序が自動的に適用されます。

ダイアログのボタンのほとんどは、特定の役割を担っています。そのような役割には、次のようなものがあります。

• ダイアログの承認または拒否。
• ヘルプを要求する。
• ダイアログ自体に対する操作の実行（フィールドのリセットや変更の適用など）。

また、ダイアログを閉じる別の方法が存在する場合もあり、それによって破壊的な結果を引き起こす可能性があります。

ほとんどのダイアログには、ほぼ標準と見なせるボタン（例：OK やCancel ボタン）があります。これらのボタンを標準的な方法で作成すると便利な場合があります。

DialogButtonBox を使用するにはいくつかの方法があります。1 つの方法は、標準的なボタン（例：OK 、Cancel 、Save ）を指定し、ボタンボックスにボタンの設定を行わせることです。

DialogButtonBox {
    standardButtons: DialogButtonBox.Ok | DialogButtonBox.Cancel

    onAccepted: console.log("Ok clicked")
    onRejected: console.log("Cancel clicked")
}

あるいは、ボタンとその役割を手動で指定することもできます：

DialogButtonBox {
    Button {
        text: qsTr("Save")
        DialogButtonBox.buttonRole: DialogButtonBox.AcceptRole
    }
    Button {
        text: qsTr("Close")
        DialogButtonBox.buttonRole: DialogButtonBox.DestructiveRole
    }
}

通常のボタンと標準ボタンを組み合わせて使用することも可能です。

ボタンボックス内のボタンがクリックされると、実際に押されたボタンに対して `clicked()` シグナルが発信されます。さらに、それぞれの役割を持つボタンが押されると、以下のシグナルが自動的に発信されます：

Dialogも参照してください 。

プロパティのドキュメント

alignment : flags

このプロパティは、ボタンの配置を指定します。

指定可能な値：

デフォルトでは、特定の配置は設定されていません。alignment プロパティを読み取ると、0 と同等となるデフォルトのフラグ値が返されます。このプロパティに `undefined ` を代入することで、この値にリセットできます。この場合、ボタンは利用可能なスペースを埋めるようにサイズが調整されます。

buttonLayout : enumeration [since QtQuick.Controls 2.5 (Qt 5.12)]

このプロパティは、ボタンボックスに含まれるボタンを配置する際に使用するボタンのレイアウトポリシーを指定します。デフォルト値はプラットフォームによって異なります。

使用可能な値：

このプロパティは、QtQuick.Controls 2.5 (Qt 5.12) で導入されました。

defaultButton : AbstractButton [since 6.11]

このプロパティは、デフォルトのボタンを指定します。

デフォルトのボタンは「highlighted 」となり、フォーカスがそのボタンに割り当てられます。

ボタンボックス内のボタンは、1つだけデフォルトに設定できます。このプロパティは、defaultStandardButton プロパティと併用することはできません。

このプロパティは Qt 6.11 で導入されました。

「 standardButtons 」および「defaultStandardButton 」も参照してください 。

defaultStandardButton : enumeration [since 6.11]

このプロパティには、デフォルトの標準ボタンが格納されます。

デフォルトの標準ボタンは「highlighted 」となり、フォーカスが当たります。

ボタンボックス内のボタンは、1つだけデフォルトに設定できます。このプロパティは、defaultButton プロパティと併用することはできません。

このプロパティは Qt 6.11 で導入されました。

「 standardButtons 」および「defaultButton 」も参照してください 。

delegate : Component

このプロパティは、標準のボタンを作成するためのデリゲートを保持します。

DialogButtonBox このプロパティは、デリゲートの所有権を取得しません。

「standardButtons」も参照してください 。

position : enumeration

このプロパティは、ボタンボックスの位置を指定します。

指定可能な値：

デフォルト値は `Footer` です。

「 Dialog::header 」および「Dialog::footer 」も参照してください 。

standardButtons : enumeration

このプロパティには、ボタンボックスで使用される標準ボタンの組み合わせが格納されています。

DialogButtonBox {
    standardButtons: DialogButtonBox.Ok | DialogButtonBox.Cancel

    onAccepted: console.log("Ok clicked")
    onRejected: console.log("Cancel clicked")
}

ボタンは、ユーザーのプラットフォームに応じて適切な順序で配置されます。

使用可能なフラグ：

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

添付プロパティのドキュメント

DialogButtonBox.buttonBox : DialogButtonBox [read-only attached]

この添付プロパティには、このボタンを管理するボタンボックス、あるいはボタンがボタンボックスに含まれていない場合はnull が格納されます。

DialogButtonBox.buttonRole : enumeration [attached]

この関連プロパティは、ボタンボックス内の各ボタンの役割を保持します。

DialogButtonBox {
    Button {
        text: qsTr("Save")
        DialogButtonBox.buttonRole: DialogButtonBox.AcceptRole
    }
    Button {
        text: qsTr("Close")
        DialogButtonBox.buttonRole: DialogButtonBox.DestructiveRole
    }
}

利用可能な値：

シグナルのドキュメント

accepted()

このシグナルは、AcceptRole またはYesRole で定義されたボタンがクリックされたときに発火します。

関連項目： rejected()、clicked()、およびhelpRequested()。

[since QtQuick.Controls 2.3 (Qt 5.10)] applied()

このシグナルは、ApplyRole で定義されたボタンがクリックされたときに発生します。

このシグナルは、QtQuick.Controls 2.3 (Qt 5.10) で導入されました。

discarded() およびreset()も参照してください 。

clicked(AbstractButton button)

このシグナルは、ボタンボックス内のbutton がクリックされたときに発生します。

関連項目： accepted()、rejected()、およびhelpRequested()。

[since QtQuick.Controls 2.3 (Qt 5.10)] discarded()

このシグナルは、DiscardRole で定義されたボタンがクリックされたときに発生します。

このシグナルは、QtQuick.Controls 2.3 (Qt 5.10) で導入されました。

reset() およびapplied()も参照してください 。

helpRequested()

このシグナルは、HelpRole で定義されたボタンがクリックされたときに発生します。

関連項目： accepted()、rejected()、clicked()も参照してください 。

rejected()

このシグナルは、RejectRole またはNoRole で定義されたボタンがクリックされたときに発生します。

関連項目： accepted()、helpRequested()、およびclicked()も参照してください 。

[since QtQuick.Controls 2.3 (Qt 5.10)] reset()

このシグナルは、ResetRole で定義されたボタンがクリックされたときに発生します。

このシグナルは、QtQuick.Controls 2.3 (Qt 5.10) で導入されました。

discarded() およびapplied()も参照してください 。

メソッドのドキュメント

AbstractButton standardButton(StandardButton button)

指定された標準button を返します。存在しない場合はnull を返します。

「standardButtons」も参照してください 。