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

#include <qdialogbuttonbox.h>

Inheritance diagram for QDialogButtonBox:

[legend]

Collaboration diagram for QDialogButtonBox:

[legend]

Public Types
enum	ButtonRole { InvalidRole = -1 , AcceptRole , RejectRole , DestructiveRole , ActionRole , HelpRole , YesRole , NoRole , ResetRole , ApplyRole , NRoles }

enum	StandardButton { NoButton = 0x00000000 , Ok = 0x00000400 , Save = 0x00000800 , SaveAll = 0x00001000 , Open = 0x00002000 , Yes = 0x00004000 , YesToAll = 0x00008000 , No = 0x00010000 , NoToAll = 0x00020000 , Abort = 0x00040000 , Retry = 0x00080000 , Ignore = 0x00100000 , Close = 0x00200000 , Cancel = 0x00400000 , Discard = 0x00800000 , Help = 0x01000000 , Apply = 0x02000000 , Reset = 0x04000000 , RestoreDefaults = 0x08000000 , FirstButton = Ok , LastButton = RestoreDefaults }

enum	ButtonLayout { WinLayout , MacLayout , KdeLayout , GnomeLayout , AndroidLayout }

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Signals
void	clicked (QAbstractButton *button)

void	accepted ()

void	helpRequested ()

void	rejected ()

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	customContextMenuRequested (const QPoint &pos)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Public Member Functions
	QDialogButtonBox (QWidget *parent=nullptr)

	QDialogButtonBox (Qt::Orientation orientation, QWidget *parent=nullptr)

	QDialogButtonBox (StandardButtons buttons, QWidget *parent=nullptr)

	QDialogButtonBox (StandardButtons buttons, Qt::Orientation orientation, QWidget *parent=nullptr)

	~QDialogButtonBox ()

void	setOrientation (Qt::Orientation orientation)

Qt::Orientation	orientation () const

void	addButton (QAbstractButton *button, ButtonRole role)

QPushButton *	addButton (const QString &text, ButtonRole role)

QPushButton *	addButton (StandardButton button)

void	removeButton (QAbstractButton *button)

void	clear ()

QList< QAbstractButton * >	buttons () const

ButtonRole	buttonRole (QAbstractButton *button) const

void	setStandardButtons (StandardButtons buttons)

StandardButtons	standardButtons () const

StandardButton	standardButton (QAbstractButton *button) const

QPushButton *	button (StandardButton which) const

void	setCenterButtons (bool center)

bool	centerButtons () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QWidget ()

int	devType () const override

WId	winId () const

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)

bool	isWindow () const

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setFixedSize (const QSize &)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFixedHeight (int h)

QPointF	mapToGlobal (const QPointF &) const

QPoint	mapToGlobal (const QPoint &) const

QPointF	mapFromGlobal (const QPointF &) const

QPoint	mapFromGlobal (const QPoint &) const

QPointF	mapToParent (const QPointF &) const

QPoint	mapToParent (const QPoint &) const

QPointF	mapFromParent (const QPointF &) const

QPoint	mapFromParent (const QPoint &) const

QPointF	mapTo (const QWidget *, const QPointF &) const

QPoint	mapTo (const QWidget *, const QPoint &) const

QPointF	mapFrom (const QWidget *, const QPointF &) const

QPoint	mapFrom (const QWidget *, const QPoint &) const

QWidget *	window () const

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)

QPalette::ColorRole	backgroundRole () const

void	setForegroundRole (QPalette::ColorRole)

QPalette::ColorRole	foregroundRole () const

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const

QFontInfo	fontInfo () const

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)

void	setMask (const QRegion &)

QRegion	mask () const

void	clearMask ()

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())

void	ungrabGesture (Qt::GestureType type)

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)

QString	windowRole () const

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

QString	accessibleName () const

void	setAccessibleName (const QString &name)

QString	accessibleDescription () const

void	setAccessibleDescription (const QString &description)

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()

void	clearFocus ()

void	setFocus (Qt::FocusReason reason)

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)

QWidget *	focusProxy () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()

void	grabMouse (const QCursor &)

void	releaseMouse ()

void	grabKeyboard ()

void	releaseKeyboard ()

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)

void	releaseShortcut (int id)

void	setShortcutEnabled (int id, bool enable=true)

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)

void	update (const QRect &)

void	update (const QRegion &)

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &)

void	repaint (const QRegion &)

void	stackUnder (QWidget *)

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const

bool	isHidden () const

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const

void	setWindowState (Qt::WindowStates state)

void	overrideWindowState (Qt::WindowStates state)

virtual QSize	sizeHint () const

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

virtual int	heightForWidth (int) const

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)
	The setContentsMargins function sets the margins around the widget's contents. More...

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins. More...

QRect	contentsRect () const

QLayout *	layout () const

void	setLayout (QLayout *)

void	updateGeometry ()

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &)

QWidget *	focusWidget () const

QWidget *	nextInFocusChain () const

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain. More...

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	insertActions (QAction before, const QList< QAction > &actions)

void	insertAction (QAction before, QAction action)

void	removeAction (QAction *action)

QList< QAction * >	actions () const

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)

Qt::WindowType	windowType () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

void	setAttribute (Qt::WidgetAttribute, bool on=true)

bool	testAttribute (Qt::WidgetAttribute) const

QPaintEngine *	paintEngine () const override

void	ensurePolished () const

bool	isAncestorOf (const QWidget *child) const

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const

QScreen *	screen () const

void	setScreen (QScreen *)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
void	changeEvent (QEvent *event) override

bool	event (QEvent *event) override

Protected Member Functions inherited from QWidget
virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	actionEvent (QActionEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

int	metric (PaintDeviceMetric) const override

void	initPainter (QPainter *painter) const override

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)

virtual bool	focusNextPrevChild (bool next)

bool	focusNextChild ()

bool	focusPreviousChild ()

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

Properties
Qt::Orientation	orientation
	the orientation of the button box More...

StandardButtons	standardButtons
	collection of standard buttons in the button box More...

bool	centerButtons
	whether the buttons in the button box are centered More...

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget More...

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget More...

bool	enabled
	whether the widget is enabled More...

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame More...

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame More...

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More...

int	x
	the x coordinate of the widget relative to its parent including any window frame More...

int	y
	the y coordinate of the widget relative to its parent and including any window frame More...

QPoint	pos
	the position of the widget within its parent widget More...

QSize	frameSize
	the size of the widget including any window frame More...

QSize	size
	the size of the widget excluding any window frame More...

int	width
	the width of the widget excluding any window frame More...

int	height
	the height of the widget excluding any window frame More...

QRect	rect
	the internal geometry of the widget excluding any window frame More...

QRect	childrenRect
	the bounding rectangle of the widget's children More...

QRegion	childrenRegion
	the combined region occupied by the widget's children More...

QSizePolicy	sizePolicy
	the default layout behavior of the widget More...

QSize	minimumSize
	the widget's minimum size More...

QSize	maximumSize
	the widget's maximum size in pixels More...

int	minimumWidth
	the widget's minimum width in pixels More...

int	minimumHeight
	the widget's minimum height in pixels More...

int	maximumWidth
	the widget's maximum width in pixels More...

int	maximumHeight
	the widget's maximum height in pixels More...

QSize	sizeIncrement
	the size increment of the widget More...

QSize	baseSize
	the base size of the widget More...

QPalette	palette
	the widget's palette More...

QFont	font
	the font currently set for the widget More...

QCursor	cursor
	the cursor shape for this widget More...

bool	mouseTracking
	whether mouse tracking is enabled for the widget More...

bool	tabletTracking
	whether tablet tracking is enabled for the widget More...

bool	isActiveWindow
	whether this widget's window is the active window More...

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus More...

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus More...

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu More...

bool	updatesEnabled
	whether updates are enabled More...

bool	visible
	whether the widget is visible More...

bool	minimized
	whether this widget is minimized (iconified) More...

bool	maximized
	whether this widget is maximized More...

bool	fullScreen
	whether the widget is shown in full screen mode More...

QSize	sizeHint
	the recommended size for the widget More...

QSize	minimumSizeHint
	the recommended minimum size for the widget More...

bool	acceptDrops
	whether drop events are enabled for this widget More...

QString	windowTitle
	the window title (caption) More...

QIcon	windowIcon
	the widget's icon More...

QString	windowIconText
	the text to be displayed on the icon of a minimized window More...

double	windowOpacity
	The level of opacity for the window. More...

bool	windowModified
	whether the document shown in the window has unsaved changes More...

QString	accessibleName
	the widget's name as seen by assistive technologies More...

QString	accessibleDescription
	the widget's description as seen by assistive technologies More...

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget. More...

bool	autoFillBackground
	whether the widget background is filled automatically More...

QString	styleSheet
	the widget's style sheet More...

QLocale	locale
	the widget's locale More...

QString	windowFilePath
	the file path associated with a widget More...

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()

void	update ()

void	repaint ()

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)

void	show ()

void	hide ()

void	showMinimized ()

void	showMaximized ()

void	showFullScreen ()

void	showNormal ()

bool	close ()

void	raise ()

void	lower ()

Public Slots inherited from QObject
void	deleteLater ()

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )

static QWidget *	mouseGrabber ()

static QWidget *	keyboardGrabber ()

static QWidget *	find (WId)

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Functions inherited from QWidget
	setupUi (QWidget *widget)

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

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

Since: 4.2

\inmodule QtWidgets

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:

\list

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

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. \uicontrol OK and \uicontrol 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.

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.

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: \table \row

\inlineimage buttonbox-gnomelayout-horizontal.png GnomeLayout Horizontal
Button box laid out in horizontal GnomeLayout \row
\inlineimage buttonbox-kdelayout-horizontal.png KdeLayout Horizontal
Button box laid out in horizontal KdeLayout \row
\inlineimage buttonbox-maclayout-horizontal.png MacLayout Horizontal
Button box laid out in horizontal MacLayout \row
\inlineimage buttonbox-winlayout-horizontal.png WinLayout Horizontal
Button box laid out in horizontal WinLayout \endtable

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

\table \row

GnomeLayout
KdeLayout
MacLayout
WinLayout \row
\inlineimage buttonbox-gnomelayout-vertical.png GnomeLayout Vertical
\inlineimage buttonbox-kdelayout-vertical.png KdeLayout Vertical
\inlineimage buttonbox-maclayout-vertical.png MacLayout Vertical
\inlineimage buttonbox-winlayout-vertical.png WinLayout Vertical \endtable

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

\table \row

modeless horizontal MacLayout
\inlineimage buttonbox-mac-modeless-horizontal.png Screenshot of modeless horizontal MacLayout \row
modeless vertical MacLayout
\inlineimage buttonbox-mac-modeless-vertical.png Screenshot of modeless vertical MacLayout \endtable

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 QPushButton::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 QPushButton::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

Definition at line 55 of file qdialogbuttonbox.h.

Member Enumeration Documentation

◆ ButtonLayout

enum QDialogButtonBox::ButtonLayout

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

\value WinLayout Use a policy appropriate for applications on Windows. \value MacLayout Use a policy appropriate for applications on \macos. \value KdeLayout Use a policy appropriate for applications on KDE. \value GnomeLayout Use a policy appropriate for applications on GNOME. \value 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 \l{style()}{current style}. However, on the X11 platform, it may be influenced by the desktop environment.

Enumerator
WinLayout
MacLayout
KdeLayout
GnomeLayout
AndroidLayout

Definition at line 110 of file qdialogbuttonbox.h.

◆ ButtonRole

enum QDialogButtonBox::ButtonRole

Enumerator
InvalidRole
AcceptRole
RejectRole
DestructiveRole
ActionRole
HelpRole
YesRole
NoRole
ResetRole
ApplyRole
NRoles

Definition at line 63 of file qdialogbuttonbox.h.

◆ StandardButton

enum QDialogButtonBox::StandardButton

\enum QDialogButtonBox::ButtonRole

! [buttonrole-enum] 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.

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

\omitvalue NRoles

See also: StandardButton ! [buttonrole-enum]

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

\value Ok An "OK" button defined with the \l AcceptRole. \value Open An "Open" button defined with the \l AcceptRole. \value Save A "Save" button defined with the \l AcceptRole. \value Cancel A "Cancel" button defined with the \l RejectRole. \value Close A "Close" button defined with the \l RejectRole. \value Discard A "Discard" or "Don't Save" button, depending on the platform, defined with the \l DestructiveRole. \value Apply An "Apply" button defined with the \l ApplyRole. \value Reset A "Reset" button defined with the \l ResetRole. \value RestoreDefaults A "Restore Defaults" button defined with the \l ResetRole. \value Help A "Help" button defined with the \l HelpRole. \value SaveAll A "Save All" button defined with the \l AcceptRole. \value Yes A "Yes" button defined with the \l YesRole. \value YesToAll A "Yes to All" button defined with the \l YesRole. \value No A "No" button defined with the \l NoRole. \value NoToAll A "No to All" button defined with the \l NoRole. \value Abort An "Abort" button defined with the \l RejectRole. \value Retry A "Retry" button defined with the \l AcceptRole. \value Ignore An "Ignore" button defined with the \l AcceptRole.

\value NoButton An invalid button.

\omitvalue FirstButton \omitvalue LastButton

See also: ButtonRole, standardButtons

Enumerator
NoButton
Ok
Save
SaveAll
Open
Yes
YesToAll
No
NoToAll
Abort
Retry
Ignore
Close
Cancel
Discard
Help
Apply
Reset
RestoreDefaults
FirstButton
LastButton

Definition at line 79 of file qdialogbuttonbox.h.

Constructor & Destructor Documentation

◆ QDialogButtonBox() [1/4]

QDialogButtonBox::QDialogButtonBox ( QWidget * parent = nullptr )

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

See also: orientation, addButton()

Definition at line 474 of file qdialogbuttonbox.cpp.

◆ QDialogButtonBox() [2/4]

QDialogButtonBox::QDialogButtonBox	(	Qt::Orientation	orientation,
		QWidget *	parent = `nullptr`
	)

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

See also: orientation, addButton()

Definition at line 484 of file qdialogbuttonbox.cpp.

◆ QDialogButtonBox() [3/4]

QDialogButtonBox::QDialogButtonBox	(	StandardButtons	buttons,
		QWidget *	parent = `nullptr`
	)

explicit

Since: 5.2

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

See also: orientation, addButton()

Definition at line 498 of file qdialogbuttonbox.cpp.

◆ QDialogButtonBox() [4/4]

QDialogButtonBox::QDialogButtonBox	(	StandardButtons	buttons,
		Qt::Orientation	orientation,
		QWidget *	parent = `nullptr`
	)

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

See also: orientation, addButton()

Definition at line 509 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ ~QDialogButtonBox()

QDialogButtonBox::~QDialogButtonBox ( )

Destroys the button box.

Definition at line 519 of file qdialogbuttonbox.cpp.

Member Function Documentation

◆ accepted

void QDialogButtonBox::accepted ( )

signal

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

See also: rejected(), clicked(), helpRequested()

Here is the caller graph for this function:

◆ addButton() [1/3]

QPushButton * QDialogButtonBox::addButton	(	const QString &	text,
		ButtonRole	role
	)

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

Definition at line 780 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ addButton() [2/3]

void QDialogButtonBox::addButton	(	QAbstractButton *	button,
		ButtonRole	role
	)

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

Definition at line 761 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addButton() [3/3]

QPushButton * QDialogButtonBox::addButton ( StandardButton button )

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

Definition at line 799 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ button()

QPushButton * QDialogButtonBox::button ( StandardButton which ) const

Returns the QPushButton corresponding to the standard button which, or \nullptr if the standard button doesn't exist in this button box.

See also: standardButton(), standardButtons(), buttons()

Definition at line 841 of file qdialogbuttonbox.cpp.

Here is the caller graph for this function:

◆ buttonRole()

QDialogButtonBox::ButtonRole QDialogButtonBox::buttonRole ( QAbstractButton * button ) const

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

See also: buttons(), addButton()

Definition at line 706 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buttons()

QList< QAbstractButton * > QDialogButtonBox::buttons ( ) const

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

See also: buttonRole(), addButton(), removeButton()

Definition at line 688 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ centerButtons()

bool QDialogButtonBox::centerButtons ( ) const

Definition at line 922 of file qdialogbuttonbox.cpp.

◆ changeEvent()

void QDialogButtonBox::changeEvent ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 931 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ clear()

void QDialogButtonBox::clear ( )

Clears the button box, deleting all buttons within it.

See also: removeButton(), addButton()

Definition at line 667 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ clicked

void QDialogButtonBox::clicked ( QAbstractButton * button )

signal

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

Here is the caller graph for this function:

◆ event()

bool QDialogButtonBox::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 960 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

◆ helpRequested

void QDialogButtonBox::helpRequested ( )

signal

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

See also: accepted(), rejected(), clicked()

◆ orientation()

Qt::Orientation QDialogButtonBox::orientation ( ) const

Definition at line 647 of file qdialogbuttonbox.cpp.

◆ rejected

void QDialogButtonBox::rejected ( )

signal

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

See also: accepted(), helpRequested(), clicked()

Here is the caller graph for this function:

◆ removeButton()

void QDialogButtonBox::removeButton ( QAbstractButton * button )

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

See also: clear(), buttons(), addButton()

Definition at line 724 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCenterButtons()

void QDialogButtonBox::setCenterButtons ( bool center )

Definition at line 913 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOrientation()

void QDialogButtonBox::setOrientation ( Qt::Orientation orientation )

Definition at line 652 of file qdialogbuttonbox.cpp.

Here is the caller graph for this function:

◆ setStandardButtons()

void QDialogButtonBox::setStandardButtons ( StandardButtons buttons )

Definition at line 813 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ standardButton()

QDialogButtonBox::StandardButton QDialogButtonBox::standardButton ( QAbstractButton * button ) const

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

Definition at line 853 of file qdialogbuttonbox.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ standardButtons()

QDialogButtonBox::StandardButtons QDialogButtonBox::standardButtons ( ) const

Definition at line 823 of file qdialogbuttonbox.cpp.

Property Documentation

◆ centerButtons

QDialogButtonBox::centerButtons

readwrite

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

Definition at line 165 of file qdialogbuttonbox.h.

◆ orientation

QDialogButtonBox::orientation

readwrite

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.

Definition at line 165 of file qdialogbuttonbox.h.

◆ standardButtons

QDialogButtonBox::standardButtons

readwrite

collection of standard buttons in the button box

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

See also: addButton()

Definition at line 165 of file qdialogbuttonbox.h.

The documentation for this class was generated from the following files:

src/widgets/widgets/qdialogbuttonbox.h
src/widgets/widgets/qdialogbuttonbox.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ButtonLayout

◆ ButtonRole

◆ StandardButton

Constructor & Destructor Documentation

◆ QDialogButtonBox() [1/4]

◆ QDialogButtonBox() [2/4]

◆ QDialogButtonBox() [3/4]

◆ QDialogButtonBox() [4/4]

◆ ~QDialogButtonBox()

Member Function Documentation

◆ accepted

◆ addButton() [1/3]

◆ addButton() [2/3]

◆ addButton() [3/3]

◆ button()

◆ buttonRole()

◆ buttons()

◆ centerButtons()

◆ changeEvent()

◆ clear()

◆ clicked

◆ event()

◆ helpRequested

◆ orientation()

◆ rejected

◆ removeButton()

◆ setCenterButtons()

◆ setOrientation()

◆ setStandardButtons()

◆ standardButton()

◆ standardButtons()

Property Documentation

◆ centerButtons

◆ orientation

◆ standardButtons