Tutorial: Qt Widgets application

This tutorial illustrates how to use Qt Extension for VS Code to create a Qt Widgets application. You will need a project that you can develop further using VS Code and Qt Widgets Designer.

You can download the completed project from here.

Before you start

Before you start, you have to:

• Install Qt Extension for VS Code
• Register Qt installations
• Create a Qt Widgets application project

Create a Qt Widgets application project

To develop Qt applications, you need a project folder that has the code and a project configuration file (CMakeLists.txt) that has instructions for building the project.

The AddressBook project has two classes, each with a header, source, and UI form:

• AddressBook (based on QMainWindow)
• AddDialog (based on QDialog)

To create a project:

1. Create a folder called AddressBook.
2. In VS Code, go to File > Open Folder.
3. Go to File > New File, and create the following files:
   • main.cpp
   • addressbook.cpp
   • addressbook.h
   • adddialog.cpp
   • adddialog.h
4. Go to File > New Text File, and create the CMakeLists.txt file. For more information about CMake configuration files, see Getting started with CMake.

Next, create the main window of the application.

Design the main window

Use Qt Widgets Designer to design the application's main window, which has some widgets placed in layouts:

For more information about using Qt Widgets Designer, see Qt Widgets Designer Manual.

Add widgets

To add widgets to the UI and to set properties for them:

1. In VS Code Explorer, select addressbook.ui, and then select Open this file with Qt Widgets Designer to open it in Qt Widgets Designer.

   

2. In the New Form dialog, select Close.
3. In Qt Widgets Designer's Widget Box, select List Widget and Drag it to the form to add a QListWidget.
4. In the Property Editor, set the ObjectName property to addressList.
5. Drag two Push Button widgets to the top-right corner of the form to add QPushButton objects for the Add and Delete buttons.
6. Set the button names to addButton and deleteButton and text property values to Add and Delete.
7. Drag two Label widgets to the form to add QLabel objects for displaying the selected item in the list.
8. Rename the first label to nameLabel and change its text property to <No item selected>.
9. Rename the second label to emailLabel and leave its text property empty.

Position the widgets as they appear in the screenshot above. To properly position the widgets and to automatically resize them when the form is resized, you need to add layouts to the form.

Add widgets to layouts

You will need a vertical layout for the buttons as well as a spacer to push the buttons to the top of the layout. In addition, you will need a second layout to manage the positioning of the other widgets as well as the button layout.

To add widgets to layouts:

1. Drag a Vertical Spacer item to the form to add a spacer.
2. Select the buttons and the spacer, and then select Form > Lay Out Vertically to add a vertical layout (QVBoxLayout).
3. Select the list widgets, the two labels, and the button layout, and then select Form > Lay Out in a Grid to add a grid layout (QGridLayout).

   Note: Make sure that the labels are almost as wide as the form. Otherwise, the grid layout will make them only as wide as the address list.

4. Select Form > Preview to preview your form without compiling it.
5. Go to File > Save to save the form.

Build and run the application to check the main window.

Add a dialog

Now that the main window is ready, move on to add functionality to the application. To have the application open a dialog when the user clicks the Add button, create an Add Address dialog and invoke the dialog from a slot that you connect to the Add button.

To add a dialog:

1. In Qt Widgets Designer, go to File > New, and select Dialog without Buttons.
2. Select Create to create the dialog.
3. In the Property Editor, set the ObjectName property to AddDialog.
4. Go to File > Save, and save the file as adddialog.ui.

Add the UI file to the project sources in the CMakeLists.txt file:

set(PROJECT_SOURCES
        main.cpp
        addressbook.cpp
        addressbook.h
        addressbook.ui
        adddialog.cpp
        adddialog.h
        adddialog.ui
)

Design the dialog

To design the dialog:

1. In Qt Widgets Designer, set Add Address as the windowTitle.
2. Add a Label to the form and set its objectName property to nameText and text property to Name:.
3. Add another Label and set its objectName property to emailText and text property to Email:.
4. Add a Line Edit (QLineEdit) and set its objectName property to nameEdit. Leave the text property empty.
5. Add another Line Edit and set its objectName property to emailEdit. Leave the text property empty.
6. Select the labels and line edits, and then go to Form > Lay Out in a Grid to add a grid layout.
7. Add a Push Button and set its objectName property to okButton and text property to OK.
8. Add a horizontal spacer to the left of the button.
9. Add a horizontal layout for the spacer and the button.
10. Add a vertical spacer between the labels and the button.
11. Add a vertical layout for the labels and the spacer.
12. Add a grid layout for both layouts.
13. Go to Form > Preview to preview your form without compiling it.
14. Go to File > Save to save the form.

Connect to the dialog's OK button

To have the OK button invoke the QDialog::accept() slot, click the Edit Signals/Slots toolbar button to enter Qt Widgets Designer's Signals and Slots Editing Mode.

Click the OK button, drag the mouse cursor to an empty area of the form, and release the mouse button. In the Configure Connection dialog, connect the button's QPushButton::clicked() signal to the form's QDialog::accept() slot.

Open dialogs from the main window

To invoke the dialog when the user selects Add in the main window, you must add a slot to the AddressBook class and invoke AddDialog from this slot.

Forms that you create using Qt Widgets Designer call QMetaObject::connectSlotsByName() to establish connections between signals that the form's child widgets emit and slots that follow the naming convention on_<sender>_<signal>(). For the application to react appropriately when the user clicks the Add button, you must implement a slot called on_addButton_clicked().

To implement the slot, open the addressbook.h file in VS Code and add a declaration for the slot:

private slots:
    void on_addButton_clicked();

Then open addressbook.cpp, and add the slot definition:

void AddressBook::on_addButton_clicked()
{
    AddDialog dialog(this);
    dialog.exec();
}

To connect to some other signal, you must add the signal to the AddressBook class. This requires editing both the header file, addressbook.h, and the implementation file, addressbook.cpp.

Include adddialog.h to addressbook.cpp:

#include "adddialog.h"

To test your changes, build and run the application. Select the Add button to open the Add Address dialog, and then select OK to close it.

Add items to the list widget

When the user selects OK, an item should be added to the QListWidget. To implement this function, change the code in the on_addButton_clicked() slot, as follows:

AddDialog dialog(this);

    if (dialog.exec()) {
        QString name = dialog.nameEdit->text();
        QString email = dialog.emailEdit->text();

        if (!name.isEmpty() && !email.isEmpty()) {
            QListWidgetItem *item = new QListWidgetItem(name, ui.addressList);
            item->setData(Qt::UserRole, email);
            ui.addressList->setCurrentItem(item);
        }
    }

The dialog is executed. If the user accepts it by selecting OK, the Name and Email fields are extracted and a QListWidgetItem that has the specified information is created.

Display the selected item

To update the nameLabel and the emailLabel at the bottom of the form when the user selects an item in the list widget, add another slot to the AddressBook class.

In the addressbook.h file, add the following code in the private slots section of the class:

void on_addressList_currentItemChanged();

Then, add the block of code below to addressbook.cpp:

void AddressBook::on_addressList_currentItemChanged()
{
    QListWidgetItem *curItem = ui.addressList->currentItem();

    if (curItem) {
        ui.nameLabel->setText("Name: " + curItem->text());
        ui.emailLabel->setText("Email: " + curItem->data(Qt::UserRole).toString());
    } else {
        ui.nameLabel->setText("<No item selected>");
        ui.emailLabel->clear();
    }
}

The naming convention enables this slot to be automatically connected to the QListWidget::currentItemChanged() signal of addressList and be invoked whenever the selected item in the list changes.

Add functionality for the Delete button

To implement a slot for the Delete button, open the addressbook.h file in Visual Studio and add a declaration for the on_deleteButton_clicked() slot. Then open addressbook.cpp and add the slot definition for on_deleteButton_clicked().

Type the following code in the slot's body:

void AddressBook::on_deleteButton_clicked()
{
    QListWidgetItem *curItem = ui.addressList->currentItem();

    if (curItem) {
        int row = ui.addressList->row(curItem);
        ui.addressList->takeItem(row);
        delete curItem;

        if (ui.addressList->count() > 0)
            ui.addressList->setCurrentRow(0);
        else
            on_addressList_currentItemChanged();
    }
}

Your application is now complete.