Extension Example

The Extension example shows how to add an extension to a QDialog using the toggled() signal and the setVisible() slot.

The Extension application lets the user add search parameters in a dialog and launch a simple or advanced search.

The simple search has two options: Match case and Search from start. The advanced search offers search for Whole words, Search backward, and Search selection. The application starts with simple search as the default. Click the More button to show the advanced search options:

FindDialog Class Definition

The FindDialog class inherits QDialog . QDialog is the base class for dialog windows. A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user.

class FindDialog(QDialog):

    Q_OBJECT
# public
    FindDialog(QWidget parent = None)
# private
    label = QLabel()
    lineEdit = QLineEdit()
    caseCheckBox = QCheckBox()
    fromStartCheckBox = QCheckBox()
    wholeWordsCheckBox = QCheckBox()
    searchSelectionCheckBox = QCheckBox()
    backwardCheckBox = QCheckBox()
    buttonBox = QDialogButtonBox()
    findButton = QPushButton()
    moreButton = QPushButton()
    extension = QWidget()

The FindDialog widget is the main application widget, and displays the application’s search options and controlling buttons.

In addition to the constructor, there are several child widgets:

FindDialog Class Implementation

Create the standard child widgets for the simple search in the constructor: the QLineEdit with the associated QLabel , two { QCheckBox }es and all the QPushButton s.

def __init__(self, parent):
    QDialog.__init__(self, parent)

    label = QLabel(tr("Find what:"))
    lineEdit = QLineEdit
    label.setBuddy(lineEdit)
    caseCheckBox = QCheckBox(tr("Match case"))
    fromStartCheckBox = QCheckBox(tr("Search from start"))
    fromStartCheckBox.setChecked(True)

    findButton = QPushButton(tr("Find"))
    findButton.setDefault(True)
    moreButton = QPushButton(tr("More"))
    moreButton.setCheckable(True)

This snippet illustrates how you can define a shortcut key for a widget. A shortcut should be defined by putting the ampersand character (&) in front of the letter that should become the shortcut. For example, for Find what, pressing Alt and w transfers focus to the QLineEdit widget. Shortcuts can also be used for checking on or off a checkmark. For example, pressing Alt and c puts the check mark on Match Case if it was unchecked and vice versa. It is the setBuddy() method that links a widget to the shortcut character if it has been defined.

Set the Find button’s default property to true, using the setDefault() function. Then the push button will be pressed if the user presses the Enter (or Return) key. Note that a QDialog can only have one default button.

extension = QWidget
wholeWordsCheckBox = QCheckBox(tr("Whole words"))
backwardCheckBox = QCheckBox(tr("Search backward"))
searchSelectionCheckBox = QCheckBox(tr("Search selection"))

Create the extension widget, and the QCheckBox es associated with the advanced search options.

buttonBox = QDialogButtonBox(Qt.Vertical)
buttonBox.addButton(findButton, QDialogButtonBox.ActionRole)
buttonBox.addButton(moreButton, QDialogButtonBox.ActionRole)
connect(moreButton, QAbstractButton.toggled, extension, QWidget.setVisible)
extensionLayout = QVBoxLayout()
extensionLayout.setContentsMargins(QMargins())
extensionLayout.addWidget(wholeWordsCheckBox)
extensionLayout.addWidget(backwardCheckBox)
extensionLayout.addWidget(searchSelectionCheckBox)
extension.setLayout(extensionLayout)

Now that the extension widget is created, connect the More button’s toggled() signal to the extension widget’s setVisible() slot.

The toggled() signal is emitted whenever a checkable button changes its state. The signal’s argument is true if the button is checked, or false if the button is unchecked. The setVisible() slot sets the widget’s visible status. If the status is true the widget is shown, otherwise the widget is hidden.

Since the More button is checkable, the connection makes sure that the extension widget is shown depending on the state of the More button.

Create checkboxes associated with the advanced search options in a layout installed on the extension widget.

topLeftLayout = QHBoxLayout()
topLeftLayout.addWidget(label)
topLeftLayout.addWidget(lineEdit)
leftLayout = QVBoxLayout()
leftLayout.addLayout(topLeftLayout)
leftLayout.addWidget(caseCheckBox)
leftLayout.addWidget(fromStartCheckBox)
mainLayout = QGridLayout()
mainLayout.setSizeConstraint(QLayout.SetFixedSize)
mainLayout.addLayout(leftLayout, 0, 0)
mainLayout.addWidget(buttonBox, 0, 1)
mainLayout.addWidget(extension, 1, 0, 1, 2)
mainLayout.setRowStretch(2, 1)
setLayout(mainLayout)
setWindowTitle(tr("Extension"))

Before creating the main layout, create several child layouts for the widgets. First align the QLabel and its buddy, the QLineEdit , using a QHBoxLayout . Then align the QLabel and the QLineEdit vertically with the checkboxes associated with the simple search, using a QVBoxLayout . Create also a QVBoxLayout for the buttons. Finally, lay out the two latter layouts and the extension widget using a QGridLayout .

extension.hide()

Hide the extension widget using the hide() function, making the application only show the simple search options when it starts. When the user wants to access the advanced search options, the dialog only needs to change the visibility of the extension widget. Qt’s layout management takes care of the dialog’s appearance.

Example project @ code.qt.io