QDialog

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

Synopsis

Functions

• def adjustPosition (arg__1)
• def isSizeGripEnabled ()
• def result ()
• def setModal (modal)
• def setResult (r)
• def setSizeGripEnabled (arg__1)

Virtual functions

• def accept ()
• def done (arg__1)
• def reject ()

Slots

• def exec_ ()
• def open ()

Signals

• def accepted ()
• def finished (result)
• def rejected ()

Detailed Description

The PySide.QtGui.QDialog class is the base class of dialog windows.

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 PySide.QtGui.QSizeGrip in their lower-right corner, using PySide.QtGui.QDialog.setSizeGripEnabled() .

Note that PySide.QtGui.QDialog (an 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 QWidget.setParent() function to change the ownership of a PySide.QtGui.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 Qt.Dialog flag).

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 . Typically, to get the dialog to close and return the appropriate value, we connect a default button, e.g. OK , to the PySide.QtGui.QDialog.accept() slot and a Cancel button to the PySide.QtGui.QDialog.reject() slot. Alternatively you can call the PySide.QtGui.QDialog.done() slot with Accepted or Rejected .

An alternative is to call setModal(true) or PySide.QtGui.QWidget.setWindowModality() , then PySide.QtGui.QWidget.show() . Unlike exec() , PySide.QtGui.QWidget.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 PySide.QtGui.QWidget.show() and setModal(true) together to perform a long operation, you must call QApplication.processEvents() periodically during processing to enable the user to interact with the dialog. (See PySide.QtGui.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 PySide.QtGui.QWidget.show() , which returns control to the caller immediately.

If you invoke the PySide.QtGui.QWidget.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 PySide.QtGui.QWidget.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 QPushButton.setDefault() , QPushButton.isDefault() and QPushButton.autoDefault() to set and control the dialog’s default button.

Escape Key

If the user presses the Esc key in a dialog, QDialog.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 PySide.QtGui.QDialog.accept() or the PySide.QtGui.QDialog.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 PySide.QtGui.QDialog.result() if the dialog has not been destroyed.

In order to modify your dialog’s close behavior, you can reimplement the functions PySide.QtGui.QDialog.accept() , PySide.QtGui.QDialog.reject() or PySide.QtGui.QDialog.done() . The PySide.QtGui.QWidget.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 !self.findDialog:
        self.findDialog = FindDialog(self)
        connect(findDialog, SIGNAL("findNext()"), self, SLOT("findNext()"))


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

See also

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

class PySide.QtGui.QDialog([parent=None[, f=0]])

Parameters:

• f – PySide.QtCore.Qt.WindowFlags
• parent – PySide.QtGui.QWidget

PySide.QtGui.QDialog.DialogCode

The value returned by a modal dialog.

Constant	Description
QDialog.Accepted
QDialog.Rejected

PySide.QtGui.QDialog.accept()

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

See also

PySide.QtGui.QDialog.reject() PySide.QtGui.QDialog.done()

PySide.QtGui.QDialog.accepted()

PySide.QtGui.QDialog.adjustPosition(arg__1)

Parameters:arg__1 – PySide.QtGui.QWidget

PySide.QtGui.QDialog.done(arg__1)

Parameters:arg__1 – PySide.QtCore.int

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

As with QWidget.close() , PySide.QtGui.QDialog.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

PySide.QtGui.QDialog.accept() PySide.QtGui.QDialog.reject() QApplication.activeWindow() QApplication.quit()

PySide.QtGui.QDialog.exec_()

Return type:PySide.QtCore.int

Shows the dialog as a modal dialog , blocking until the user closes it. The function returns a QDialog.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.

See also

PySide.QtGui.QDialog.open() PySide.QtGui.QWidget.show() PySide.QtGui.QDialog.result() PySide.QtGui.QWidget.setWindowModality()

PySide.QtGui.QDialog.finished(result)

Parameters:result – PySide.QtCore.int

PySide.QtGui.QDialog.isSizeGripEnabled()

Return type:PySide.QtCore.bool

This property holds whether the size grip is enabled.

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

PySide.QtGui.QDialog.open()

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

See also

exec() PySide.QtGui.QWidget.show() PySide.QtGui.QDialog.result() PySide.QtGui.QWidget.setWindowModality()

PySide.QtGui.QDialog.reject()

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

See also

PySide.QtGui.QDialog.accept() PySide.QtGui.QDialog.done()

PySide.QtGui.QDialog.rejected()

PySide.QtGui.QDialog.result()

Return type:PySide.QtCore.int

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

PySide.QtGui.QDialog.setResult()

PySide.QtGui.QDialog.setModal(modal)

Parameters:modal – PySide.QtCore.bool

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

By default, this property is false and PySide.QtGui.QWidget.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.

See also

QWidget.windowModality PySide.QtGui.QWidget.show() exec()

PySide.QtGui.QDialog.setResult(r)

Parameters:r – PySide.QtCore.int

Sets the modal dialog’s result code to i .

Note

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

See also

PySide.QtGui.QDialog.result()

PySide.QtGui.QDialog.setSizeGripEnabled(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

This property holds whether the size grip is enabled.

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