QDialogButtonBox

The QDialogButtonBox class is a widget that presents buttons in a layout that is appropriate to the current widget style. More

Inheritance diagram of PySide2.QtWidgets.QDialogButtonBox

Synopsis

Functions

Signals

Detailed Description

Dialogs and message boxes typically present buttons in a layout that conforms to the interface guidelines for that platform. Invariably, different platforms have different layouts for their dialogs. QDialogButtonBox allows a developer to add buttons to it and will automatically use the appropriate layout for the user’s desktop environment.

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 QDialogButtonBox . One ways is to create the buttons (or button texts) yourself and add them to the button box, specifying their role.

findButton = QPushButton(self.tr("&Find"))
findButton.setDefault(True)

moreButton = QPushButton(self.tr("&More"))
moreButton.setCheckable(True)

moreButton.setAutoDefault(False)

buttonBox = QDialogButtonBox(Qt.Vertical)
buttonBox.addButton(findButton, QDialogButtonBox.ActionRole)
buttonBox.addButton(moreButton, QDialogButtonBox.ActionRole)

Alternatively, QDialogButtonBox provides several standard buttons (e.g. OK, Cancel, Save) that you can use. They exist as flags so you can OR them together in the constructor.

self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok

                             | QDialogButtonBox.Cancel)

self.buttonBox.accepted.connect(self.accept)
self.buttonBox.rejected.connect(self.reject)

You can mix and match normal buttons and standard buttons.

Currently the buttons are laid out in the following way if the button box is horizontal:

buttonbox-gnomelayout-horizontal1

Button box laid out in horizontal GnomeLayout

buttonbox-kdelayout-horizontal2

Button box laid out in horizontal KdeLayout

buttonbox-maclayout-horizontal3

Button box laid out in horizontal MacLayout

buttonbox-winlayout-horizontal4

Button box laid out in horizontal WinLayout

The buttons are laid out the following way if the button box is vertical:

GnomeLayout

KdeLayout

MacLayout

WinLayout

buttonbox-gnomelayout-vertical5

buttonbox-kdelayout-vertical6

buttonbox-maclayout-vertical7

buttonbox-winlayout-vertical8

Additionally, button boxes that contain only buttons with ActionRole or HelpRole can be considered modeless and have an alternate look on macOS :

modeless horizontal MacLayout

buttonbox-mac-modeless-horizontal9

modeless vertical MacLayout

buttonbox-mac-modeless-vertical10

When a button is clicked in the button box, the clicked() signal is emitted for the actual button is that is pressed. For convenience, if the button has an AcceptRole , RejectRole , or HelpRole , the accepted() , rejected() , or helpRequested() signals are emitted respectively.

If you want a specific button to be default you need to call setDefault() on it yourself. However, if there is no default button set and to preserve which button is the default button across platforms when using the autoDefault property, the first push button with the accept role is made the default button when the QDialogButtonBox is shown,

class QDialogButtonBox(buttons[, parent=None])

QDialogButtonBox(buttons, orientation[, parent=None])

QDialogButtonBox([parent=None])

QDialogButtonBox(orientation[, parent=None])

param parent

QWidget

param buttons

StandardButtons

param orientation

Orientation

Constructs a horizontal button box with the given parent , containing the standard buttons specified by buttons .

Constructs a button box with the given orientation and parent , containing the standard buttons specified by buttons .

Constructs an empty, horizontal button box with the given parent .

Constructs an empty button box with the given orientation and parent .

PySide2.QtWidgets.QDialogButtonBox.ButtonRole
PySide2.QtWidgets.QDialogButtonBox.StandardButton

These enums describe flags for standard buttons. Each button has a defined ButtonRole .

Constant

Description

QDialogButtonBox.Ok

An “OK” button defined with the AcceptRole .

QDialogButtonBox.Open

An “Open” button defined with the AcceptRole .

QDialogButtonBox.Save

A “Save” button defined with the AcceptRole .

QDialogButtonBox.Cancel

A “Cancel” button defined with the RejectRole .

QDialogButtonBox.Close

A “Close” button defined with the RejectRole .

QDialogButtonBox.Discard

A “Discard” or “Don’t Save” button, depending on the platform, defined with the DestructiveRole .

QDialogButtonBox.Apply

An “Apply” button defined with the ApplyRole .

QDialogButtonBox.Reset

A “Reset” button defined with the ResetRole .

QDialogButtonBox.RestoreDefaults

A “Restore Defaults” button defined with the ResetRole .

QDialogButtonBox.Help

A “Help” button defined with the HelpRole .

QDialogButtonBox.SaveAll

A “Save All” button defined with the AcceptRole .

QDialogButtonBox.Yes

A “Yes” button defined with the YesRole .

QDialogButtonBox.YesToAll

A “Yes to All” button defined with the YesRole .

QDialogButtonBox.No

A “No” button defined with the NoRole .

QDialogButtonBox.NoToAll

A “No to All” button defined with the NoRole .

QDialogButtonBox.Abort

An “Abort” button defined with the RejectRole .

QDialogButtonBox.Retry

A “Retry” button defined with the AcceptRole .

QDialogButtonBox.Ignore

An “Ignore” button defined with the AcceptRole .

QDialogButtonBox.NoButton

An invalid button.

See also

ButtonRole standardButtons

PySide2.QtWidgets.QDialogButtonBox.ButtonLayout

This enum describes the layout policy to be used when arranging the buttons contained in the button box.

Constant

Description

QDialogButtonBox.WinLayout

Use a policy appropriate for applications on Windows.

QDialogButtonBox.MacLayout

Use a policy appropriate for applications on macOS .

QDialogButtonBox.KdeLayout

Use a policy appropriate for applications on KDE.

QDialogButtonBox.GnomeLayout

Use a policy appropriate for applications on GNOME.

QDialogButtonBox.AndroidLayout

Use a policy appropriate for applications on Android. This enum value was added in Qt 5.10.

The button layout is specified by the current style . However, on the X11 platform, it may be influenced by the desktop environment.

PySide2.QtWidgets.QDialogButtonBox.accepted()
PySide2.QtWidgets.QDialogButtonBox.addButton(button, role)
Parameters

Adds the given button to the button box with the specified role . If the role is invalid, the button is not added.

If the button has already been added, it is removed and added again with the new role.

Note

The button box takes ownership of the button.

PySide2.QtWidgets.QDialogButtonBox.addButton(button)
Parameters

buttonStandardButton

Return type

QPushButton

Adds a standard button to the button box if it is valid to do so, and returns a push button. If button is invalid, it is not added to the button box, and zero is returned.

PySide2.QtWidgets.QDialogButtonBox.addButton(text, role)
Parameters
Return type

QPushButton

PySide2.QtWidgets.QDialogButtonBox.button(which)
Parameters

whichStandardButton

Return type

QPushButton

Returns the QPushButton corresponding to the standard button which , or None if the standard button doesn’t exist in this button box.

PySide2.QtWidgets.QDialogButtonBox.buttonRole(button)
Parameters

buttonQAbstractButton

Return type

ButtonRole

Returns the button role for the specified button . This function returns InvalidRole if button is 0 or has not been added to the button box.

PySide2.QtWidgets.QDialogButtonBox.buttons()
Return type

Returns a list of all the buttons that have been added to the button box.

PySide2.QtWidgets.QDialogButtonBox.centerButtons()
Return type

bool

PySide2.QtWidgets.QDialogButtonBox.clear()

Clears the button box, deleting all buttons within it.

PySide2.QtWidgets.QDialogButtonBox.clicked(button)
Parameters

buttonQAbstractButton

PySide2.QtWidgets.QDialogButtonBox.helpRequested()
PySide2.QtWidgets.QDialogButtonBox.orientation()
Return type

Orientation

See also

setOrientation()

PySide2.QtWidgets.QDialogButtonBox.rejected()
PySide2.QtWidgets.QDialogButtonBox.removeButton(button)
Parameters

buttonQAbstractButton

Removes button from the button box without deleting it and sets its parent to zero.

PySide2.QtWidgets.QDialogButtonBox.setCenterButtons(center)
Parameters

centerbool

See also

centerButtons()

PySide2.QtWidgets.QDialogButtonBox.setOrientation(orientation)
Parameters

orientationOrientation

See also

orientation()

PySide2.QtWidgets.QDialogButtonBox.setStandardButtons(buttons)
Parameters

buttonsStandardButtons

PySide2.QtWidgets.QDialogButtonBox.standardButton(button)
Parameters

buttonQAbstractButton

Return type

StandardButton

Returns the standard button enum value corresponding to the given button , or NoButton if the given button isn’t a standard button.

PySide2.QtWidgets.QDialogButtonBox.standardButtons()
Return type

StandardButtons