QDialog

The QDialog class is the base class of dialog windows. More…

Inherited by: QAbstractPrintDialog, QPageSetupDialog, QPrintDialog, QPrintPreviewDialog, QColorDialog, QErrorMessage, QFileDialog, QFontDialog, QInputDialog, QMessageBox, QProgressDialog, QWizard

Synopsis

Functions

• def adjustPosition (arg__1)

• def extension ()

• def isSizeGripEnabled ()

• def orientation ()

• def result ()

• def setExtension (extension)

• def setModal (modal)

• def setOrientation (orientation)

• def setResult (r)

• def setSizeGripEnabled (arg__1)

Virtual functions

• def accept ()

• def done (arg__1)

• def exec_ ()

• def open ()

• def reject ()

Slots

• def showExtension (arg__1)

Signals

• def accepted ()

• def finished (result)

• def rejected ()

Detailed Description

A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user. QDialogs may be modal or modeless. QDialogs can provide a return value , and they can have default buttons . QDialogs can also have a QSizeGrip in their lower-right corner, using setSizeGripEnabled() .

Note that QDialog (and any other widget that has type Qt::Dialog ) uses the parent widget slightly differently from other classes in Qt. A dialog is always a top-level widget, but if it has a parent, its default location is centered on top of the parent’s top-level widget (if it is not top-level itself). It will also share the parent’s taskbar entry.

Use the overload of the setParent() function to change the ownership of a QDialog widget. This function allows you to explicitly set the window flags of the reparented widget; using the overloaded function will clear the window flags specifying the window-system properties for the widget (in particular it will reset the Dialog flag).

Note

The parent relationship of the dialog does not imply that the dialog will always be stacked on top of the parent window. To ensure that the dialog is always on top, make the dialog modal. This also applies for child windows of the dialog itself. To ensure that child windows of the dialog stay on top of the dialog, make the child windows modal as well.

Modal Dialogs

A modal dialog is a dialog that blocks input to other visible windows in the same application. Dialogs that are used to request a file name from the user or that are used to set application preferences are usually modal. Dialogs can be application modal (the default) or window modal .

When an application modal dialog is opened, the user must finish interacting with the dialog and close it before they can access any other window in the application. Window modal dialogs only block access to the window associated with the dialog, allowing the user to continue to use other windows in an application.

The most common way to display a modal dialog is to call its exec() function. When the user closes the dialog, exec() will provide a useful return value . To close the dialog and return the appropriate value, you must connect a default button, e.g. an OK button to the accept() slot and a Cancel button to the reject() slot. Alternatively, you can call the done() slot with Accepted or Rejected .

An alternative is to call setModal (true) or setWindowModality() , then show() . Unlike exec() , show() returns control to the caller immediately. Calling setModal (true) is especially useful for progress dialogs, where the user must have the ability to interact with the dialog, e.g. to cancel a long running operation. If you use show() and setModal (true) together to perform a long operation, you must call processEvents() periodically during processing to enable the user to interact with the dialog. (See QProgressDialog .)

Modeless Dialogs

A modeless dialog is a dialog that operates independently of other windows in the same application. Find and replace dialogs in word-processors are often modeless to allow the user to interact with both the application’s main window and with the dialog.

Modeless dialogs are displayed using show() , which returns control to the caller immediately.

If you invoke the show() function after hiding a dialog, the dialog will be displayed in its original position. This is because the window manager decides the position for windows that have not been explicitly placed by the programmer. To preserve the position of a dialog that has been moved by the user, save its position in your closeEvent() handler and then move the dialog to that position, before showing it again.

Default Button

A dialog’s default button is the button that’s pressed when the user presses Enter (Return). This button is used to signify that the user accepts the dialog’s settings and wants to close the dialog. Use setDefault() , isDefault() and autoDefault() to set and control the dialog’s default button.

Escape Key

If the user presses the Esc key in a dialog, reject() will be called. This will cause the window to close: The close event cannot be ignored .

Extensibility

Extensibility is the ability to show the dialog in two ways: a partial dialog that shows the most commonly used options, and a full dialog that shows all the options. Typically an extensible dialog will initially appear as a partial dialog, but with a More toggle button. If the user presses the More button down, the dialog is expanded. The Extension Example shows how to achieve extensible dialogs using Qt.

Return Value (Modal Dialogs)

Modal dialogs are often used in situations where a return value is required, e.g. to indicate whether the user pressed OK or Cancel. A dialog can be closed by calling the accept() or the reject() slots, and exec() will return Accepted or Rejected as appropriate. The exec() call returns the result of the dialog. The result is also available from result() if the dialog has not been destroyed.

In order to modify your dialog’s close behavior, you can reimplement the functions accept() , reject() or done() . The closeEvent() function should only be reimplemented to preserve the dialog’s position or to override the standard close or reject behavior.

Code Examples

A modal dialog:

def countWords(self):
    dialog = WordCountDialog(self)
    dialog.setWordCount(document().wordCount())
    dialog.exec_()

A modeless dialog:

def find(self):
    if not self.findDialog:
        self.findDialog = FindDialog(self)
        self.findDialog.findNext.connect(self.findNext)

    self.findDialog.show()
    self.findDialog.raise()
    self.findDialog.activateWindow()

See also

QDialogButtonBox QTabWidget QWidget QProgressDialog GUI Design Handbook: Dialogs, Standard Extension Example Standard Dialogs Example

class PySide2.QtWidgets.QDialog([parent=None[, f=Qt.WindowFlags()]])

param f:

WindowFlags

param parent:

PySide2.QtWidgets.QWidget

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 WindowTitleHint | WindowSystemMenuHint in f .

See also

setWindowFlags()

PySide2.QtWidgets.QDialog.DialogCode

The value returned by a modal dialog.

Constant	Description
QDialog.Accepted
QDialog.Rejected

PySide2.QtWidgets.QDialog.accept()

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

See also

reject() done()

PySide2.QtWidgets.QDialog.accepted()

PySide2.QtWidgets.QDialog.adjustPosition(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QWidget

PySide2.QtWidgets.QDialog.done(arg__1)

Parameters:

arg__1 – int

Closes the dialog and sets its result code to r . The finished() signal will emit r ; if r is Accepted or Rejected , the accepted() or the rejected() signals will also be emitted, respectively.

If this dialog is shown with exec() , also causes the local event loop to finish, and exec() to return r .

As with close() , deletes the dialog if the 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 lastWindowClosed() signal is emitted.

See also

accept() reject() activeWindow() quit()

PySide2.QtWidgets.QDialog.exec_()

Return type:

int

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

If the dialog is application modal , users cannot interact with any other window in the same application until they close the dialog. If the dialog is window modal , only interaction with the parent window is blocked while the dialog is open. By default, the dialog is application modal.

Note

Avoid using this function; instead, use open() . Unlike , open() is asynchronous, and does not spin an additional event loop. This prevents a series of dangerous bugs from happening (e.g. deleting the dialog’s parent while the dialog is open via ). When using open() you can connect to the finished() signal of QDialog to be notified when the dialog is closed.

See also

open() show() result() setWindowModality()

PySide2.QtWidgets.QDialog.extension()

Return type:

PySide2.QtWidgets.QWidget

Note

This function is deprecated.

Returns the dialog’s extension or None if no extension has been defined.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also

setExtension() showExtension() setOrientation()

PySide2.QtWidgets.QDialog.finished(result)

Parameters:

result – int

PySide2.QtWidgets.QDialog.isSizeGripEnabled()

Return type:

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.

PySide2.QtWidgets.QDialog.open()

Shows the dialog as a window modal dialog , returning immediately.

See also

exec() show() result() setWindowModality()

PySide2.QtWidgets.QDialog.orientation()

Return type:

Orientation

Note

This function is deprecated.

Returns the dialog’s extension orientation.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also

setOrientation() extension()

PySide2.QtWidgets.QDialog.reject()

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

See also

accept() done()

PySide2.QtWidgets.QDialog.rejected()

PySide2.QtWidgets.QDialog.result()

Return type:

int

In general returns the modal dialog’s result code, Accepted or Rejected .

Note

When called on a QMessageBox instance, the returned value is a value of the StandardButton enum.

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

See also

setResult()

PySide2.QtWidgets.QDialog.setExtension(extension)

Parameters:

extension – PySide2.QtWidgets.QWidget

Note

This function is deprecated.

Sets the widget, extension , to be the dialog’s extension, deleting any previous extension. The dialog takes ownership of the extension. Note that if None is passed, any existing extension will be deleted. This function must only be called while the dialog is hidden.

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also

extension() showExtension() setOrientation()

PySide2.QtWidgets.QDialog.setModal(modal)

Parameters:

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 this property to true is equivalent to setting windowModality to ApplicationModal .

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

See also

windowModality show() exec()

PySide2.QtWidgets.QDialog.setOrientation(orientation)

Parameters:

orientation – Orientation

Note

This function is deprecated.

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

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also

orientation() setExtension()

PySide2.QtWidgets.QDialog.setResult(r)

Parameters:

r – int

Sets the modal dialog’s result code to i .

Note

We recommend that you use one of the values defined by DialogCode .

See also

result()

PySide2.QtWidgets.QDialog.setSizeGripEnabled(arg__1)

Parameters:

arg__1 – 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.

PySide2.QtWidgets.QDialog.showExtension(arg__1)

Parameters:

arg__1 – bool

Note

This function is deprecated.

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

Instead of using this functionality, we recommend that you simply call show() or hide() on the part of the dialog that you want to use as an extension. See the Extension Example for details.

See also

show() setExtension() setOrientation()