QDialog Class Reference
^{[QtGui module]}

Code Examples

A modal dialog:

    void EditorWindow::countWords()
    {
        WordCountDialog dialog(this);
        dialog.setWordCount(document().wordCount());
        dialog.exec();
    }

A modeless dialog:

    void EditorWindow::find()
    {
        if (!findDialog) {
            findDialog = new FindDialog(this);
            connect(findDialog, SIGNAL(findNext()), this, SLOT(findNext()));
        }

        findDialog->show();
        findDialog->raise();
        findDialog->activateWindow();
    }

See also QTabDialog, QWidget, QProgressDialog, and GUI Design Handbook: Dialogs, Standard.

Member Type Documentation

enum QDialog::DialogCode

The value returned by a modal dialog.

Property Documentation

modal : bool

This property holds whether show() should pop up the dialog as modal or modeless.

By default, this property is false and show() pops up the dialog as modeless. Setting his property to true is equivalent to setting QWidget::windowModality to Qt::ApplicationModal.

exec() ignores the value of this property and always pops up the dialog as modal.

Access functions:

• bool isModal () const
• void setModal ( bool modal )

See also QWidget::windowModality, show(), and exec().

sizeGripEnabled : bool

This property holds whether the size grip is enabled.

A QSizeGrip is placed in the bottom-right corner of the dialog when this property is enabled. By default, the size grip is disabled.

Access functions:

• bool isSizeGripEnabled () const
• void setSizeGripEnabled ( bool )

Member Function Documentation

QDialog::QDialog ( QWidget * parent = 0, Qt::WFlags f = 0 )

Constructs a dialog with parent parent.

A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent. It will also share the parent's taskbar entry.

The widget flags f are passed on to the QWidget constructor. If, for example, you don't want a What's This button in the title bar of the dialog, pass Qt::WindowTitleHint | Qt::WindowSystemMenuHint in f.

See also QWidget::setWindowFlags().

QDialog::~QDialog ()

Destroys the QDialog, deleting all its children.

void QDialog::accept ()   [virtual slot]

Hides the modal dialog and sets the result code to Accepted.

See also reject() and done().

void QDialog::accepted ()   [signal]

This signal is emitted when the dialog has been accepted either by the user or by calling accept() or done() with the QDialog::Accepted argument.

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also finished() and rejected().

void QDialog::done ( int r )   [virtual slot]

Closes the dialog and sets its result code to r. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return r.

As with QWidget::close(), done() deletes the dialog if the Qt::WA_DeleteOnClose flag is set. If the dialog is the application's main widget, the application terminates. If the dialog is the last window closed, the QApplication::lastWindowClosed() signal is emitted.

See also accept(), reject(), QApplication::activeWindow(), and QApplication::quit().

int QDialog::exec ()   [slot]

Shows the dialog as a modal dialog, blocking until the user closes it. The function returns a DialogCode result.

Users cannot interact with any other window in the same application until they close the dialog.

See also show() and result().

QWidget * QDialog::extension () const

Returns the dialog's extension or 0 if no extension has been defined.

See also setExtension().

void QDialog::finished ( int result )   [signal]

This signal is emitted when the dialog's result code has been set, either by the user or by calling done(), accept(), or reject().

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also accepted() and rejected().

Qt::Orientation QDialog::orientation () const

Returns the dialog's extension orientation.

See also setOrientation().

void QDialog::reject ()   [virtual slot]

Hides the modal dialog and sets the result code to Rejected.

See also accept() and done().

void QDialog::rejected ()   [signal]

This signal is emitted when the dialog has been rejected either by the user or by calling reject() or done() with the QDialog::Rejected argument.

Note that this signal is not emitted when hiding the dialog with hide() or setVisible(false). This includes deleting the dialog while it is visible.

This function was introduced in Qt 4.1.

See also finished() and accepted().

int QDialog::result () const

Returns the modal dialog's result code, Accepted or Rejected.

Do not call this function if the dialog was constructed with the Qt::WA_DeleteOnClose attribute.

See also setResult().

void QDialog::setExtension ( QWidget * extension )

Sets the widget, extension, to be the dialog's extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if 0 is passed any existing extension will be deleted.

This function must only be called while the dialog is hidden.

See also showExtension(), setOrientation(), and extension().

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

If orientation is Qt::Horizontal, the extension will be displayed to the right of the dialog's main area. If orientation is Qt::Vertical, the extension will be displayed below the dialog's main area.

See also orientation() and setExtension().

void QDialog::setResult ( int i )

Sets the modal dialog's result code to i.

See also result().

void QDialog::showExtension ( bool showIt )   [slot]

If showIt is true, the dialog's extension is shown; otherwise the extension is hidden.

This slot is usually connected to the QPushButton::toggled() signal of a QPushButton.

A dialog with a visible extension is not resizeable.

See also show(), setExtension(), and setOrientation().