Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
QDialogButtonBox Class Reference

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:
+ Collaboration diagram for QDialogButtonBox:

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
}
 These enums describe flags for standard buttons. More...
 
enum  ButtonLayout {
  WinLayout , MacLayout , KdeLayout , GnomeLayout ,
  AndroidLayout
}
 This enum describes the layout policy to be used when arranging the buttons contained in the button box. More...
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- 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)
 This signal is emitted when a button inside the button box is clicked.
 
void accepted ()
 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.
 
void helpRequested ()
 This signal is emitted when a button inside the button box is clicked, as long as it was defined with the \l HelpRole.
 
void rejected ()
 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.
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 This signal is emitted when the window's title has changed, with the new title as an argument.
 
void windowIconChanged (const QIcon &icon)
 This signal is emitted when the window's icon has changed, with the new icon as an argument.
 
void windowIconTextChanged (const QString &iconText)
 This signal is emitted when the window's icon text has changed, with the new iconText as an argument.
 
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QDialogButtonBox (QWidget *parent=nullptr)
 Constructs an empty, horizontal button box with the given parent.
 
 QDialogButtonBox (Qt::Orientation orientation, QWidget *parent=nullptr)
 Constructs an empty button box with the given orientation and parent.
 
 QDialogButtonBox (StandardButtons buttons, QWidget *parent=nullptr)
 
 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.
 
 ~QDialogButtonBox ()
 Destroys the button box.
 
void setOrientation (Qt::Orientation orientation)
 
Qt::Orientation orientation () const
 
void addButton (QAbstractButton *button, ButtonRole role)
 Adds the given button to the button box with the specified role.
 
QPushButton * 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.
 
QPushButton * addButton (StandardButton button)
 Adds a standard button to the button box if it is valid to do so, and returns a push button.
 
void removeButton (QAbstractButton *button)
 Removes button from the button box without deleting it and sets its parent to zero.
 
void clear ()
 Clears the button box, deleting all buttons within it.
 
QList< QAbstractButton * > buttons () const
 Returns a list of all buttons that have been added to the button box.
 
ButtonRole buttonRole (QAbstractButton *button) const
 Returns the button role for the specified button.
 
void setStandardButtons (StandardButtons buttons)
 
StandardButtons standardButtons () const
 
StandardButton 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.
 
QPushButton * 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.
 
void setCenterButtons (bool center)
 
bool centerButtons () const
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a widget which is a child of parent, with widget flags set to f.
 
 ~QWidget ()
 Destroys the widget.
 
int devType () const override
 
WId winId () const
 Returns the window system identifier of the widget.
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStyle * style () const
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style.
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false.
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.
 
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)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, 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)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.
 
void setFixedSize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights.
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths.
 
QPointF mapToGlobal (const QPointF &) const
 Translates the widget coordinate pos to global screen coordinates.
 
QPoint mapToGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromGlobal (const QPointF &) const
 Translates the global screen coordinate pos to widget coordinates.
 
QPoint mapFromGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapToParent (const QPointF &) const
 Translates the widget coordinate pos to a coordinate in the parent widget.
 
QPoint mapToParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromParent (const QPointF &) const
 Translates the parent widget coordinate pos to widget coordinates.
 
QPoint mapFromParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapTo (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos to the coordinate system of parent.
 
QPoint mapTo (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QWidget * window () const
 Returns the window for this widget, i.e.
 
QWidget * nativeParentWidget () const
 
QWidget * topLevelWidget () const
 
const QPalette & palette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role.
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget.
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role.
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role.
 
const QFont & font () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font.
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font.
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false.
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.
 
void setMask (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.
 
QRegion mask () const
 Returns the mask currently set on a widget.
 
void clearMask ()
 Removes any mask set by setMask().
 
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))
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags.
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture 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 &)
 Sets the window's role to role.
 
QString windowRole () const
 Returns the window's role, or an empty string.
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
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 ()
 Sets the top-level widget containing this widget to be the active window.
 
void clearFocus ()
 Takes keyboard input focus from the widget.
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w.
 
QWidget * focusProxy () const
 Returns the focus proxy, or \nullptr if there is no focus proxy.
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 Grabs the mouse input.
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 Releases the mouse grab.
 
void grabKeyboard ()
 Grabs the keyboard input.
 
void releaseKeyboard ()
 Releases the keyboard grab.
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system.
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.
 
void update (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.
 
void update (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void repaint (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.
 
void repaint (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.
 
void repaint (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack.
 
void move (int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).
 
void move (const QPoint &)
 
void resize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents.
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false.
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false.
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 Returns the current window state.
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState.
 
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)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w.
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur.
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.
 
void setContentsMargins (const QMargins &margins)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins.
 
QRect contentsRect () const
 Returns the area inside the widget's margins.
 
QLayout * layout () const
 Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout.
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry.
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags.
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward.
 
void scroll (int dx, int dy, const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.
 
QWidget * focusWidget () const
 Returns the last child of this widget that setFocus had been called on.
 
QWidget * nextInFocusChain () const
 Returns the next widget in this widget's focus chain.
 
QWidget * previousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain.
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions.
 
void addActions (const QList< QAction * > &actions)
 Appends the actions actions to this widget's list of actions.
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 Inserts the actions actions to this widget's list of actions, before the action before.
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before.
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions.
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions.
 
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
 Returns the parent of this widget, or \nullptr if it does not have any parent widget.
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e.g.
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system.
 
Qt::WindowType windowType () const
 Returns the window type of this widget.
 
QWidget * childAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.
 
QWidget * childAt (const QPoint &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false.
 
QPaintEngine * paintEngine () const override
 Returns the widget's paint engine.
 
void ensurePolished () const
 Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStore * backingStore () const
 
QWindow * windowHandle () const
 If this is a native widget, return the associated QWindow.
 
QScreen * screen () const
 Returns the screen the widget is on.
 
void setScreen (QScreen *)
 Sets the screen on which the widget should be shown to screen.
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery) const
 This method is only relevant for input widgets.
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
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
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- 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
 \reimp
 
bool event (QEvent *event) override
 \reimp
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 This is the main event handler; it handles event event.
 
virtual void mousePressEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.
 
virtual void mouseMoveEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.
 
virtual void keyPressEvent (QKeyEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive key press events for the widget.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.
 
virtual void focusInEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.
 
virtual void focusOutEvent (QFocusEvent *event)
 This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.
 
virtual void enterEvent (QEnterEvent *event)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.
 
virtual void leaveEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.
 
virtual void paintEvent (QPaintEvent *event)
 This event handler can be reimplemented in a subclass to receive paint events passed in event.
 
virtual void moveEvent (QMoveEvent *event)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.
 
virtual void resizeEvent (QResizeEvent *event)
 This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter.
 
virtual void closeEvent (QCloseEvent *event)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events.
 
virtual void actionEvent (QActionEvent *event)
 This event handler is called with the given event whenever the widget's actions are changed.
 
virtual void showEvent (QShowEvent *event)
 This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.
 
virtual void hideEvent (QHideEvent *event)
 This event handler can be reimplemented in a subclass to receive widget hide events.
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.
 
int metric (PaintDeviceMetric) const override
 Internal implementation of the virtual QPaintDevice::metric() function.
 
void initPainter (QPainter *painter) const override
 Initializes the painter pen, background and font to the same as the given widget's.
 
QPaintDevice * redirected (QPoint *offset) const override
 
QPainter * sharedPainter () const override
 
virtual void inputMethodEvent (QInputMethodEvent *)
 This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window.
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources.
 
virtual bool focusNextPrevChild (bool next)
 Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
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
 
StandardButtons standardButtons
 collection of standard buttons in the button box
 
bool centerButtons
 whether the buttons in the button box are centered
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget
 
bool enabled
 whether the widget is enabled
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget
 
int x
 the x coordinate of the widget relative to its parent including any window frame
 
int y
 the y coordinate of the widget relative to its parent and including any window frame
 
QPoint pos
 the position of the widget within its parent widget
 
QSize frameSize
 the size of the widget including any window frame
 
QSize size
 the size of the widget excluding any window frame
 
int width
 the width of the widget excluding any window frame
 
int height
 the height of the widget excluding any window frame
 
QRect rect
 the internal geometry of the widget excluding any window frame
 
QRect childrenRect
 the bounding rectangle of the widget's children
 
QRegion childrenRegion
 the combined region occupied by the widget's children
 
QSizePolicy sizePolicy
 the default layout behavior of the widget
 
QSize minimumSize
 the widget's minimum size
 
QSize maximumSize
 the widget's maximum size in pixels
 
int minimumWidth
 the widget's minimum width in pixels
 
int minimumHeight
 the widget's minimum height in pixels
 
int maximumWidth
 the widget's maximum width in pixels
 
int maximumHeight
 the widget's maximum height in pixels
 
QSize sizeIncrement
 the size increment of the widget
 
QSize baseSize
 the base size of the widget
 
QPalette palette
 the widget's palette
 
QFont font
 the font currently set for the widget
 
QCursor cursor
 the cursor shape for this widget
 
bool mouseTracking
 whether mouse tracking is enabled for the widget
 
bool tabletTracking
 whether tablet tracking is enabled for the widget
 
bool isActiveWindow
 whether this widget's window is the active window
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu
 
bool updatesEnabled
 whether updates are enabled
 
bool visible
 whether the widget is visible
 
bool minimized
 whether this widget is minimized (iconified)
 
bool maximized
 whether this widget is maximized
 
bool fullScreen
 whether the widget is shown in full screen mode
 
QSize sizeHint
 the recommended size for the widget
 
QSize minimumSizeHint
 the recommended minimum size for the widget
 
bool acceptDrops
 whether drop events are enabled for this widget
 
QString windowTitle
 the window title (caption)
 
QIcon windowIcon
 the widget's icon
 
QString windowIconText
 the text to be displayed on the icon of a minimized window
 
double windowOpacity
 The level of opacity for the window.
 
bool windowModified
 whether the document shown in the window has unsaved changes
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget.
 
bool autoFillBackground
 whether the widget background is filled automatically
 
QString styleSheet
 the widget's style sheet
 
QLocale locale
 the widget's locale
 
QString windowFilePath
 the file path associated with a widget
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events.
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden.
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.
 
virtual void setVisible (bool visible)
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden).
 
void show ()
 Shows the widget and its child widgets.
 
void hide ()
 Hides the widget.
 
void showMinimized ()
 Shows the widget minimized, as an icon.
 
void showMaximized ()
 Shows the widget maximized.
 
void showFullScreen ()
 Shows the widget in full-screen mode.
 
void showNormal ()
 Restores the widget after it has been maximized or minimized.
 
bool close ()
 Closes this widget.
 
void raise ()
 Raises this widget to the top of the parent widget's stack.
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order.
 
static void setTabOrder (std::initializer_list< QWidget * > widgets)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static QWidget * mouseGrabber ()
 Returns the widget that is currently grabbing the mouse input.
 
static QWidget * keyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input.
 
static QWidget * find (WId)
 Returns a pointer to the widget with window identifier/handle id.
 
static QWidget * createWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Creates a QWidget that makes it possible to embed window into a QWidget-based application.
 
- 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)
 \threadsafe
 
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::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a 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)
 Updates the widget's micro focus and informs input methods that the state specified by query has changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 
- Related Symbols inherited from QWidget
 \macro QWIDGETSIZE_MAX
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

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.

QDialogButtonBox *buttonBox = new 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.

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 19 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 74 of file qdialogbuttonbox.h.

◆ ButtonRole

enum QDialogButtonBox::ButtonRole
Enumerator
InvalidRole 
AcceptRole 
RejectRole 
DestructiveRole 
ActionRole 
HelpRole 
YesRole 
NoRole 
ResetRole 
ApplyRole 
NRoles 

Definition at line 27 of file qdialogbuttonbox.h.

◆ StandardButton

enum QDialogButtonBox::StandardButton

These enums describe flags for standard buttons. 

\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]

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 43 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 441 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 451 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 465 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 476 of file qdialogbuttonbox.cpp.

References buttons().

+ Here is the call graph for this function:

◆ ~QDialogButtonBox()

QDialogButtonBox::~QDialogButtonBox ( )

Destroys the button box.

Definition at line 486 of file qdialogbuttonbox.cpp.

References d.

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

Referenced by QFileDialogPrivate::createWidgets(), QInputDialogPrivate::ensureLayout(), and QFontDialogPrivate::init().

+ 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 784 of file qdialogbuttonbox.cpp.

References button, d, NRoles, Q_UNLIKELY, QPushButton, qWarning, and text.

◆ 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 765 of file qdialogbuttonbox.cpp.

References button, d, NRoles, Q_UNLIKELY, qWarning, removeButton(), and QWidget::setParent().

Referenced by extension(), QPrintDialogPrivate::init(), and QFontDialogPrivate::init().

+ 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 803 of file qdialogbuttonbox.cpp.

References button, and d.

◆ 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 845 of file qdialogbuttonbox.cpp.

References d.

Referenced by QPrintPropertiesDialog::QPrintPropertiesDialog(), QInputDialogPrivate::currentRowChanged(), QMessageBoxPrivate::detectEscapeButton(), QInputDialogPrivate::ensureEnabledConnection(), QMessageBoxPrivate::helperPrepareShow(), QPrintDialogPrivate::init(), and QInputDialogPrivate::setInputWidget().

+ 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 692 of file qdialogbuttonbox.cpp.

References QList< T >::at(), button, d, i, InvalidRole, j, list, NRoles, and QList< T >::size().

Referenced by QMessageBoxPrivate::detectEscapeButton(), QMessageBoxPrivate::helperPrepareShow(), and showNewMessageBox().

+ 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 buttons that have been added to the button box.

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

Definition at line 664 of file qdialogbuttonbox.cpp.

References d.

Referenced by QDialogButtonBox(), QMessageBoxPrivate::canBeNativeDialog(), QMessageBoxPrivate::detectEscapeButton(), and setStandardButtons().

+ Here is the caller graph for this function:

◆ centerButtons()

bool QDialogButtonBox::centerButtons ( ) const

Definition at line 957 of file qdialogbuttonbox.cpp.

References d.

◆ changeEvent()

void QDialogButtonBox::changeEvent ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 966 of file qdialogbuttonbox.cpp.

References QSet< T >::begin(), QWidget::changeEvent(), d, it, QEvent::MacSizeChange, Q_FALLTHROUGH, QWidget::style(), and QEvent::StyleChange.

+ 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 642 of file qdialogbuttonbox.cpp.

References button, QList< T >::clear(), d, QObject::destroyed(), QObjectPrivate::disconnect(), QDialogButtonBoxPrivate::handleButtonDestroyed(), i, list, and NRoles.

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

Referenced by QMessageBoxPrivate::init().

+ Here is the caller graph for this function:

◆ event()

bool QDialogButtonBox::event ( QEvent * event)
overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1051 of file qdialogbuttonbox.cpp.

References d, QWidget::event(), QEvent::LanguageChange, and QEvent::Show.

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

Referenced by QFileDialogPrivate::createWidgets(), QInputDialogPrivate::ensureLayout(), and QFontDialogPrivate::init().

+ 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 710 of file qdialogbuttonbox.cpp.

References button, d, and QDialogButtonBoxPrivate::ManualRemove.

Referenced by addButton().

+ Here is the caller graph for this function:

◆ setCenterButtons()

void QDialogButtonBox::setCenterButtons ( bool center)

Definition at line 948 of file qdialogbuttonbox.cpp.

References d.

Referenced by QMessageBoxPrivate::init().

+ Here is the caller graph for this function:

◆ setOrientation()

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

Definition at line 627 of file qdialogbuttonbox.cpp.

References d, and orientation.

◆ setStandardButtons()

void QDialogButtonBox::setStandardButtons ( StandardButtons buttons)

Definition at line 817 of file qdialogbuttonbox.cpp.

References buttons(), d, and qDeleteAll().

+ Here is the call 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 857 of file qdialogbuttonbox.cpp.

References button, and d.

Referenced by QMessageBoxPrivate::execReturnCode().

+ Here is the caller graph for this function:

◆ standardButtons()

QDialogButtonBox::StandardButtons QDialogButtonBox::standardButtons ( ) const

Definition at line 827 of file qdialogbuttonbox.cpp.

References QSet< T >::constBegin(), QSet< T >::constEnd(), d, it, NoButton, and standardButtons.

+ Here is the call graph for this function:

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 24 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 22 of file qdialogbuttonbox.h.

Referenced by setOrientation().

◆ 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 23 of file qdialogbuttonbox.h.

Referenced by standardButtons().

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