Contents

• Public Types
• Properties
• Public Functions
• Signals
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

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

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

Most buttons for a dialog follow certain roles. Such roles include:

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

There can also be alternate ways of dismissing the dialog which may cause destructive results.

Most dialogs have buttons that can almost be considered standard (e.g.OK andCancel buttons). It is sometimes convenient to create these buttons in a standard way.

There are a couple ways of usingQDialogButtonBox. One ways is to create the buttons (or button texts) yourself and add them to the button box, specifying their role.

    findButton=newQPushButton(tr("&Find"));    findButton->setDefault(true);    moreButton=newQPushButton(tr("&More"));    moreButton->setCheckable(true);    moreButton->setAutoDefault(false);    buttonBox=newQDialogButtonBox(Qt::Vertical);    buttonBox->addButton(findButton,QDialogButtonBox::ActionRole);    buttonBox->addButton(moreButton,QDialogButtonBox::ActionRole);

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

    buttonBox=newQDialogButtonBox(QDialogButtonBox::Ok|QDialogButtonBox::Cancel);    connect(buttonBox, SIGNAL(accepted()),this, SLOT(accept()));    connect(buttonBox, SIGNAL(rejected()),this, SLOT(reject()));

You can mix and match normal buttons and standard buttons.

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

	Button box laid out in horizontalGnomeLayout
	Button box laid out in horizontalKdeLayout
	Button box laid out in horizontalMacLayout
	Button box laid out in horizontalWinLayout

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

GnomeLayout	KdeLayout	MacLayout	WinLayout

Additionally, button boxes that contain only buttons withActionRole orHelpRole can be considered modeless and have an alternate look on Mac OS X:

modeless horizontalMacLayout

When a button is clicked in the button box, theclicked() signal is emitted for the actual button is that is pressed. For convenience, if the button has anAcceptRole,RejectRole, orHelpRole, theaccepted(),rejected(), orhelpRequested() signals are emitted respectively.

If you want a specific button to be default you need to callQPushButton::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 theQPushButton::autoDefault property, the first push button with the accept role is made the default button when theQDialogButtonBox is shown,

Member Type Documentation

enum QDialogButtonBox::ButtonLayout

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

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

enum QDialogButtonBox::ButtonRole

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

See alsoStandardButton.

enum QDialogButtonBox::StandardButton
flags QDialogButtonBox::StandardButtons

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

The StandardButtons type is a typedef forQFlags<StandardButton>. It stores an OR combination of StandardButton values.

See alsoButtonRole andstandardButtons.

Property Documentation

centerButtons :bool

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

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

Access functions:

See alsoQMessageBox.

orientation :Qt::Orientation

This property holds the orientation of the button box.

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

Access functions:

standardButtons :StandardButtons

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

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

Access functions:

See alsoaddButton().

Member Function Documentation

QDialogButtonBox::QDialogButtonBox(QWidget * parent = 0)

Constructs an empty, horizontal button box with the givenparent.

See alsoorientation andaddButton().

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

Constructs an empty button box with the givenorientation andparent.

See alsoorientation andaddButton().

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

Constructs a button box with the givenorientation andparent, containing the standard buttons specified bybuttons.

See alsoorientation andaddButton().

QDialogButtonBox::~QDialogButtonBox()

Destroys the button box.

[signal]void QDialogButtonBox::accepted()

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

See alsorejected(),clicked(), andhelpRequested().

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

Adds the givenbutton to the button box with the specifiedrole. 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 alsoremoveButton() andclear().

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

Creates a push button with the giventext, adds it to the button box for the specifiedrole, and returns the corresponding push button. Ifrole is invalid, no button is created, and zero is returned.

See alsoremoveButton() andclear().

QPushButton * QDialogButtonBox::addButton(StandardButton button)

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

See alsoremoveButton() andclear().

QPushButton * QDialogButtonBox::button(StandardButton which) const

Returns theQPushButton corresponding to the standard buttonwhich, or 0 if the standard button doesn't exist in this button box.

See alsostandardButton(),standardButtons(), andbuttons().

ButtonRole QDialogButtonBox::buttonRole(QAbstractButton * button) const

Returns the button role for the specifiedbutton. This function returnsInvalidRole ifbutton is 0 or has not been added to the button box.

See alsobuttons() andaddButton().

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

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

See alsobuttonRole(),addButton(), andremoveButton().

[virtual protected]void QDialogButtonBox::changeEvent(QEvent * event)

Reimplemented fromQWidget::changeEvent().

void QDialogButtonBox::clear()

Clears the button box, deleting all buttons within it.

See alsoremoveButton() andaddButton().

[signal]void QDialogButtonBox::clicked(QAbstractButton * button)

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

See alsoaccepted(),rejected(), andhelpRequested().

[virtual protected]bool QDialogButtonBox::event(QEvent * event)

Reimplemented fromQObject::event().

[signal]void QDialogButtonBox::helpRequested()

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

See alsoaccepted(),rejected(), andclicked().

[signal]void QDialogButtonBox::rejected()

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

See alsoaccepted(),helpRequested(), andclicked().

void QDialogButtonBox::removeButton(QAbstractButton * button)

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

See alsoclear(),buttons(), andaddButton().

StandardButton QDialogButtonBox::standardButton(QAbstractButton * button) const

Returns the standard button enum value corresponding to the givenbutton, orNoButton if the givenbutton isn't a standard button.

See alsobutton(),buttons(), andstandardButtons().