PySide6.QtWidgets.QDialogButtonBox

class QDialogButtonBox

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

Details

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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.

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.

    buttonBox = QDialogButtonBox(QDialogButtonBox.StandardButton.Ok
//! [1] //! [3]
                                     | QDialogButtonBox.StandardButton.Cancel)
    buttonBox.accepted.connect(self.accept)
    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 GnomeLayout Horizontal

Button box laid out in horizontal GnomeLayout

buttonbox-kdelayout-horizontal2 KdeLayout Horizontal

Button box laid out in horizontal KdeLayout

buttonbox-maclayout-horizontal3 MacLayout Horizontal

Button box laid out in horizontal MacLayout

buttonbox-winlayout-horizontal4 WinLayout Horizontal

Button box laid out in horizontal WinLayout

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

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 Screenshot of modeless horizontal MacLayout

modeless vertical MacLayout

buttonbox-mac-modeless-vertical10 Screenshot of modeless vertical MacLayout

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,

Inheritance diagram of PySide6.QtWidgets.QDialogButtonBox

Synopsis

Properties

Methods

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class ButtonRole

This enum describes the roles that can be used to describe buttons in the button box. Combinations of these roles are as flags used to describe different aspects of their behavior.

Constant

Description

QDialogButtonBox.ButtonRole.InvalidRole

The button is invalid.

QDialogButtonBox.ButtonRole.AcceptRole

Clicking the button causes the dialog to be accepted (e.g. OK).

QDialogButtonBox.ButtonRole.RejectRole

Clicking the button causes the dialog to be rejected (e.g. Cancel).

QDialogButtonBox.ButtonRole.DestructiveRole

Clicking the button causes a destructive change (e.g. for Discarding Changes) and closes the dialog.

QDialogButtonBox.ButtonRole.ActionRole

Clicking the button causes changes to the elements within the dialog.

QDialogButtonBox.ButtonRole.HelpRole

The button can be clicked to request help.

QDialogButtonBox.ButtonRole.YesRole

The button is a “Yes”-like button.

QDialogButtonBox.ButtonRole.NoRole

The button is a “No”-like button.

QDialogButtonBox.ButtonRole.ApplyRole

The button applies current changes.

QDialogButtonBox.ButtonRole.ResetRole

The button resets the dialog’s fields to default values.

See also

StandardButton

class StandardButton

(inherits enum.Flag) These enums describe flags for standard buttons. Each button has a defined ButtonRole .

Constant

Description

QDialogButtonBox.StandardButton.Ok

An “OK” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.Open

An “Open” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.Save

A “Save” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.Cancel

A “Cancel” button defined with the RejectRole .

QDialogButtonBox.StandardButton.Close

A “Close” button defined with the RejectRole .

QDialogButtonBox.StandardButton.Discard

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

QDialogButtonBox.StandardButton.Apply

An “Apply” button defined with the ApplyRole .

QDialogButtonBox.StandardButton.Reset

A “Reset” button defined with the ResetRole .

QDialogButtonBox.StandardButton.RestoreDefaults

A “Restore Defaults” button defined with the ResetRole .

QDialogButtonBox.StandardButton.Help

A “Help” button defined with the HelpRole .

QDialogButtonBox.StandardButton.SaveAll

A “Save All” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.Yes

A “Yes” button defined with the YesRole .

QDialogButtonBox.StandardButton.YesToAll

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

QDialogButtonBox.StandardButton.No

A “No” button defined with the NoRole .

QDialogButtonBox.StandardButton.NoToAll

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

QDialogButtonBox.StandardButton.Abort

An “Abort” button defined with the RejectRole .

QDialogButtonBox.StandardButton.Retry

A “Retry” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.Ignore

An “Ignore” button defined with the AcceptRole .

QDialogButtonBox.StandardButton.NoButton

An invalid button.

See also

ButtonRole standardButtons

class ButtonLayout

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

Constant

Description

QDialogButtonBox.ButtonLayout.WinLayout

Use a policy appropriate for applications on Windows.

QDialogButtonBox.ButtonLayout.MacLayout

Use a policy appropriate for applications on macOS.

QDialogButtonBox.ButtonLayout.KdeLayout

Use a policy appropriate for applications on KDE.

QDialogButtonBox.ButtonLayout.GnomeLayout

Use a policy appropriate for applications on GNOME.

QDialogButtonBox.ButtonLayout.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.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property centerButtonsᅟ: bool

This property holds whether the buttons in the button box are centered.

By default, this property is false. This behavior is appropriate for most types of dialogs. A notable exception is message boxes on most platforms (e.g. Windows), where the button box is centered horizontally.

See also

QMessageBox

Access functions:
property orientationᅟ: Qt.Orientation

This property holds the orientation of the button box.

By default, the orientation is horizontal (i.e. the buttons are laid out side by side). The possible orientations are Qt::Horizontal and Qt::Vertical.

Access functions:
property standardButtonsᅟ: Combination of QDialogButtonBox.StandardButton

This property holds collection of standard buttons in the button box.

This property controls which standard buttons are used by the button box.

See also

addButton()

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

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

__init__(buttons[, parent=None])
Parameters:

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

__init__(orientation[, parent=None])
Parameters:

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

__init__(buttons, orientation[, parent=None])
Parameters:

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

accepted()

This signal is emitted when a button inside the button box is clicked, as long as it was defined with the AcceptRole or YesRole .

addButton(button)
Parameters:

button – StandardButton

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.

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.

See also

removeButton() clear()

addButton(text, role)
Parameters:
Return type:

QPushButton

Creates a push button with the given text, adds it to the button box for the specified role, and returns the corresponding push button. If role is invalid, no button is created, and zero is returned.

button(which)
Parameters:

which – StandardButton

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.

buttonRole(button)
Parameters:

button – QAbstractButton

Return type:

ButtonRole

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

buttons()
Return type:

.list of QAbstractButton

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

centerButtons()
Return type:

bool

See also

setCenterButtons()

Getter of property centerButtonsᅟ .

clear()

Clears the button box, deleting all buttons within it.

clicked(button)
Parameters:

button – QAbstractButton

This signal is emitted when a button inside the button box is clicked. The specific button that was pressed is specified by button.

helpRequested()

This signal is emitted when a button inside the button box is clicked, as long as it was defined with the HelpRole .

orientation()
Return type:

Orientation

See also

setOrientation()

Getter of property orientationᅟ .

rejected()

This signal is emitted when a button inside the button box is clicked, as long as it was defined with the RejectRole or NoRole .

removeButton(button)
Parameters:

button – QAbstractButton

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

setCenterButtons(center)
Parameters:

center – bool

See also

centerButtons()

Setter of property centerButtonsᅟ .

setOrientation(orientation)
Parameters:

orientation – Orientation

See also

orientation()

Setter of property orientationᅟ .

setStandardButtons(buttons)
Parameters:

buttons – Combination of StandardButton

See also

standardButtons()

Setter of property standardButtonsᅟ .

standardButton(button)
Parameters:

button – QAbstractButton

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.

standardButtons()
Return type:

Combination of StandardButton

See also

setStandardButtons()

Getter of property standardButtonsᅟ .