QDialogButtonBox#

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

Synopsis#

Properties#

centerButtons - Whether the buttons in the button box are centered
orientation - The orientation of the button box
standardButtons - Collection of standard buttons in the button box

Functions#

def addButton (button, role)
def addButton (button)
def addButton (text, role)
def button (which)
def buttonRole (button)
def buttons ()
def centerButtons ()
def clear ()
def orientation ()
def removeButton (button)
def setCenterButtons (center)
def setOrientation (orientation)
def setStandardButtons (buttons)
def standardButton (button)
def standardButtons ()

Signals#

def accepted ()
def clicked (button)
def helpRequested ()
def rejected ()

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

Detailed Description#

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.

findButton = QPushButton(tr("Find"))
findButton.setDefault(True)
moreButton = QPushButton(tr("More"))
moreButton.setCheckable(True)

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.Ok
                                 | QDialogButtonBox.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:

GnomeLayout Horizontal

Button box laid out in horizontal GnomeLayout

KdeLayout Horizontal

Button box laid out in horizontal KdeLayout

MacLayout Horizontal

Button box laid out in horizontal MacLayout

WinLayout Horizontal

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

GnomeLayout Vertical

KdeLayout Vertical

MacLayout Vertical

WinLayout 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

Screenshot of modeless horizontal MacLayout

modeless vertical MacLayout

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,

See also

QMessageBox QPushButton QDialog

class PySide6.QtWidgets.QDialogButtonBox(buttons[, parent=None])#

PySide6.QtWidgets.QDialogButtonBox(buttons, orientation[, parent=None])

PySide6.QtWidgets.QDialogButtonBox([parent=None])

PySide6.QtWidgets.QDialogButtonBox(orientation[, parent=None])

Parameters:

buttons – StandardButtons
orientation – Orientation
parent – PySide6.QtWidgets.QWidget

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

See also

orientation addButton()

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

See also

orientation addButton()

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

See also

orientation addButton()

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

See also

orientation addButton()

Note

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

property PᅟySide6.QtWidgets.QDialogButtonBox.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:

centerButtons ()
setCenterButtons (center)

property PᅟySide6.QtWidgets.QDialogButtonBox.orientation: 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 Horizontal and Vertical .

Access functions:

orientation ()
setOrientation (orientation)

property PᅟySide6.QtWidgets.QDialogButtonBox.standardButtons: StandardButtons#

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:

standardButtons ()
setStandardButtons (buttons)

PySide6.QtWidgets.QDialogButtonBox.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.InvalidRole

The button is invalid.

QDialogButtonBox.AcceptRole

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

QDialogButtonBox.RejectRole

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

QDialogButtonBox.DestructiveRole

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

QDialogButtonBox.ActionRole

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

QDialogButtonBox.HelpRole

The button can be clicked to request help.

QDialogButtonBox.YesRole

The button is a “Yes”-like button.

QDialogButtonBox.NoRole

The button is a “No”-like button.

QDialogButtonBox.ApplyRole

The button applies current changes.

QDialogButtonBox.ResetRole

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

See also

StandardButton

Constant	Description
QDialogButtonBox.InvalidRole	The button is invalid.
QDialogButtonBox.AcceptRole	Clicking the button causes the dialog to be accepted (e.g. OK).
QDialogButtonBox.RejectRole	Clicking the button causes the dialog to be rejected (e.g. Cancel).
QDialogButtonBox.DestructiveRole	Clicking the button causes a destructive change (e.g. for Discarding Changes) and closes the dialog.
QDialogButtonBox.ActionRole	Clicking the button causes changes to the elements within the dialog.
QDialogButtonBox.HelpRole	The button can be clicked to request help.
QDialogButtonBox.YesRole	The button is a “Yes”-like button.
QDialogButtonBox.NoRole	The button is a “No”-like button.
QDialogButtonBox.ApplyRole	The button applies current changes.
QDialogButtonBox.ResetRole	The button resets the dialog’s fields to default values.

PySide6.QtWidgets.QDialogButtonBox.StandardButton#

(inherits enum.Flag) 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

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.

PySide6.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.

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.

PySide6.QtWidgets.QDialogButtonBox.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 .

See also

rejected() clicked() helpRequested()

PySide6.QtWidgets.QDialogButtonBox.addButton(button, role)#

Parameters:

button – PySide6.QtWidgets.QAbstractButton
role – ButtonRole

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

PySide6.QtWidgets.QDialogButtonBox.addButton(button)

Parameters:: button – StandardButton
Return type:: PySide6.QtWidgets.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.

See also

removeButton() clear()

PySide6.QtWidgets.QDialogButtonBox.addButton(text, role)

Parameters:

text – str
role – ButtonRole

Return type:

PySide6.QtWidgets.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.

See also

removeButton() clear()

PySide6.QtWidgets.QDialogButtonBox.button(which)#

Parameters:: which – StandardButton
Return type:: PySide6.QtWidgets.QPushButton

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

See also

standardButton() standardButtons() buttons()

PySide6.QtWidgets.QDialogButtonBox.buttonRole(button)#

Parameters:: button – PySide6.QtWidgets.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.

See also

buttons() addButton()

PySide6.QtWidgets.QDialogButtonBox.buttons()#

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

See also

buttonRole() addButton() removeButton()

PySide6.QtWidgets.QDialogButtonBox.centerButtons()#

Return type:: bool

See also

setCenterButtons()

Getter of property centerButtons .

PySide6.QtWidgets.QDialogButtonBox.clear()#

Clears the button box, deleting all buttons within it.

See also

removeButton() addButton()

PySide6.QtWidgets.QDialogButtonBox.clicked(button)#

Parameters:: button – PySide6.QtWidgets.QAbstractButton

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

See also

accepted() rejected() helpRequested()

PySide6.QtWidgets.QDialogButtonBox.helpRequested()#

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

See also

accepted() rejected() clicked()

PySide6.QtWidgets.QDialogButtonBox.orientation()#

Return type:: Orientation

See also

setOrientation()

Getter of property orientation .

PySide6.QtWidgets.QDialogButtonBox.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 .

See also

accepted() helpRequested() clicked()

PySide6.QtWidgets.QDialogButtonBox.removeButton(button)#

Parameters:: button – PySide6.QtWidgets.QAbstractButton

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

See also

clear() buttons() addButton()

PySide6.QtWidgets.QDialogButtonBox.setCenterButtons(center)#

Parameters:: center – bool

See also

centerButtons()

Setter of property centerButtons .

PySide6.QtWidgets.QDialogButtonBox.setOrientation(orientation)#

Parameters:: orientation – Orientation

See also

orientation()

Setter of property orientation .

PySide6.QtWidgets.QDialogButtonBox.setStandardButtons(buttons)#

Parameters:: buttons – StandardButtons

See also

standardButtons()

Setter of property standardButtons .

PySide6.QtWidgets.QDialogButtonBox.standardButton(button)#

Parameters:: button – PySide6.QtWidgets.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.

See also

button() buttons() standardButtons()

PySide6.QtWidgets.QDialogButtonBox.standardButtons()#

Return type:: StandardButtons

See also

setStandardButtons()

Getter of property standardButtons .

`GnomeLayout` Horizontal	Button box laid out in horizontal `GnomeLayout`
`KdeLayout` Horizontal	Button box laid out in horizontal `KdeLayout`
`MacLayout` Horizontal	Button box laid out in horizontal `MacLayout`
`WinLayout` Horizontal	Button box laid out in horizontal `WinLayout`

`GnomeLayout`	`KdeLayout`	`MacLayout`	`WinLayout`
`GnomeLayout` Vertical	`KdeLayout` Vertical	`MacLayout` Vertical	`WinLayout` Vertical

modeless horizontal `MacLayout`	Screenshot of modeless horizontal `MacLayout`
modeless vertical `MacLayout`	Screenshot of modeless vertical `MacLayout`