DialogButtonBox QML Type

A button box used in dialogs. More...

• List of all members, including inherited members

Properties

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

Attached Properties

• buttonBox : DialogButtonBox
• buttonRole : enumeration

Signals

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

Methods

• AbstractButton standardButton(StandardButton button)

Detailed Description

Dialogs and message boxes typically present buttons in an order that conforms to the interface guidelines for that platform. Invariably, different platforms have their dialog buttons in different orders. DialogButtonBox allows a developer to add buttons to it and will automatically use the appropriate order for the user's platform.

Most buttons for a dialog follow certain roles. Such roles include:

• Accepting or rejecting the dialog.
• Asking for help.
• Performing actions on the dialog itself (such as resetting fields or applying changes).

There can also be alternate ways of dismissing the dialog which may cause destructive results.

Most dialogs have buttons that can almost be considered standard (e.g. OK and Cancel buttons). It is sometimes convenient to create these buttons in a standard way.

There are a couple ways of using DialogButtonBox. One way is to specify the standard buttons (e.g. OK, Cancel, Save) and let the button box setup the buttons.

 DialogButtonBox {
     standardButtons: DialogButtonBox.Ok | DialogButtonBox.Cancel

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

Alternatively, buttons and their roles can be specified by hand:

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

You can also mix and match normal buttons and standard buttons.

When a button is clicked in the button box, the clicked() signal is emitted for the actual button that is pressed. In addition, the following signals are automatically emitted when a button with the respective role(s) is pressed:

See also Dialog.

Property Documentation

 DialogButtonBox {
     standardButtons: DialogButtonBox.Ok | DialogButtonBox.Cancel

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

Attached Property Documentation

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

Signal Documentation

Method Documentation