Qt 4.0: Using a Component in Your Application

|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

[Previous: Using Custom Widgets with Qt Designer] [Contents] [Next: Creating Custom Widgets for Qt Designer]

# Using a Component in Your Application

- The Direct Approach
- The Single Inheritance Approach
- The Multiple Inheritance Approach
- Automatic Connections

- A Dialog Without Auto-Connect
- A Dialog With Auto-Connect

With Qt's integrated build tools, qmake and uic, the code for user interface components created with Qt Designer is automatically generated when the rest of of your application is built. Forms can be included and used directly from your application or, and you can use them to extend subclasses of standard widgets.

There are three approaches to using a form in your application: the direct approach, single inheritance subclassing, and multiple inheritance subclassing. In the direct approach, you simply construct a widget to use as a placeholder for the component, and set up the user interface inside it. In the single inheritance approach, you subclass the form's base class (QWidget or QDialog, for example), and include a private instance of the form's user interface object. In the multiple inheritance approach, you subclass from both the form's base class and the form's user interface object. This allows the widgets defined in the form to be used directly from within the scope of the subclass.

## The Direct Approach

To demonstrate how user interface components can be used straight from Qt Designer, we take the dialog that we created in the chapter on Designing a Component, and we create a simple application to display it.

The source of the application consists of two files: `main.cpp` and `imagedialog.ui`. We will use `qmake` to build the executable, so we need to write a `.pro` file:

        TEMPLATE    = app
        FORMS       = imagedialog.ui
        SOURCES     = main.cpp

The special feature of this file is the `FORMS` declaration that tells `qmake` which files it needs to process with `uic`. In this case, the `imagedialog.ui` file is used to create a `ui_imagedialog.h` file that can be used by any files listed in the `SOURCES` declaration. To ensure that `qmake` generates the `ui_imagedialog.h` file, we need to include it in a file listed in `SOURCES`. Since we only have `main.cpp`, we include it there:

        #include "ui_imagedialog.h"
        #include <QApplication>

This additional check ensures that we do not generate code for .ui files that are not used.

The `main` function creates the image dialog by constructing a standard QDialog that we use to host the user interface described by the `imagedialog.ui` file.

        int main(int argc, char *argv[])
        {
            QApplication app(argc, argv);
            QDialog *window = new QDialog;
            Ui::ImageDialog ui;
            ui.setupUi(window);

            window->show();
            return app.exec();
        }

In this case, the `Ui::ImageDialog` is an interface description object from the `ui_imagedialog.h` file that sets up all the dialog's widgets and the connections between its signals and slots.

This approach provides a quick and easy way to use simple, self-contained components in your applications, but many components created with Qt Designer will need to be integrated more closely with the rest of the application code. To achieve this, we need to subclass a standard Qt widget.

## The Single Inheritance Approach

In this approach, we use the `Ui::ImageDialog` object as we did in the simple case, but instead of setting up the dialog from the application's main function, we subclass QDialog and set up the user interface from within the constructor. Components used in this way expose the widgets and layouts used in the form to the QDialog subclass, and provide a standard system for making signal and slot connections between the user interface and other objects in your application.

To ensure that we can use the user interface, we need to include the header file that `uic` generates before referring to `Ui::ImageDialog`:

        #include "ui_imagedialog.h"

The subclass is defined in the following way:

        class ImageDialog : public QDialog
        {
            Q_OBJECT

        public:
            ImageDialog(QWidget *parent = 0);

        private:
            Ui::ImageDialog ui;
        };

The important features of the class are the private `ui` object which provides the code for setting up and managing the user interface, and two private slots for handling mouse clicks on the push buttons in the dialog.

The constructor for the subclass constructs and configures all the widgets and layouts for the dialog just by calling the `ui` object's setupUi() function. Once this has been done, it is possible to modify the user interface and create items for the combobox:

        ImageDialog::ImageDialog(QWidget *parent)
            : QDialog(parent)
        {
            ui.setupUi(this);

            ui.colorDepthCombo->addItem(tr("2 colors (1 bit per pixel)"));
            ui.colorDepthCombo->addItem(tr("4 colors (2 bits per pixel)"));
            ui.colorDepthCombo->addItem(tr("16 colors (4 bits per pixel)"));
            ui.colorDepthCombo->addItem(tr("256 colors (8 bits per pixel)"));
            ui.colorDepthCombo->addItem(tr("65536 colors (16 bits per pixel)"));
            ui.colorDepthCombo->addItem(tr("16 million colors (24 bits per pixel)"));

            connect(ui.okButton, SIGNAL(clicked()), this, SLOT(accept()));
            connect(ui.cancelButton, SIGNAL(clicked()), this, SLOT(reject()));
        }

We can connect signals from the user interface widgets to slots in the dialog in the usual way, taking care to prefix the `ui` object to each widget used.

The main advantages of this approach are its simple use of inheritance to provide a QDialog-based interface, and its encapsulation of the user interface widget variables within the `ui` data member. We can use this method to define a number of user interfaces within the same widget, each of which is contained within its own namespace, and overlay (or "compose") them. This approach can be used to create individual tabs from existing forms, for example.

## The Multiple Inheritance Approach

Forms created with Qt Designer can be subclassed along with a standard QWidget-based class. This approach makes all the user interface components defined in the form directly accessible within the scope of the subclass, and enables signal and slot connections to be made in the usual way with the connect() function.

As before, we need to include the header file that `uic` generates from the `imagedialog.ui` file:

        #include "ui_imagedialog.h"

The class is defined in a similar way to the one used in the private interface approach, except that this time we inherit from both QDialog and `Ui::ImageDialog`:

        class ImageDialog : public QDialog, private Ui::ImageDialog
        {
            Q_OBJECT

        public:
            ImageDialog(QWidget *parent = 0);
        };

We inherit `Ui::ImageDialog` privately to ensure that the user interface objects are private in our subclass. We can also inherit it with the `public` or `protected` keywords in the same way that we could have made `ui` public or protected in the previous case.

The constructor for the subclass performs many of the same tasks as the constructor used in the private interface example:

        ImageDialog::ImageDialog(QWidget *parent)
            : QDialog(parent)
        {
            setupUi(this);

            colorDepthCombo->addItem(tr("2 colors (1 bit per pixel)"));
            colorDepthCombo->addItem(tr("4 colors (2 bits per pixel)"));
            colorDepthCombo->addItem(tr("16 colors (4 bits per pixel)"));
            colorDepthCombo->addItem(tr("256 colors (8 bits per pixel)"));
            colorDepthCombo->addItem(tr("65536 colors (16 bits per pixel)"));
            colorDepthCombo->addItem(tr("16 million colors (24 bits per pixel)"));

            connect(okButton, SIGNAL(clicked()), this, SLOT(accept()));
            connect(cancelButton, SIGNAL(clicked()), this, SLOT(reject()));
        }

In this case, the interface can be set up using a member function, and the combobox is accessed in the same way as a widget created in code by hand. The push buttons are also referred to directly in the connect() function calls.

Subclassing using multiple inheritance gives us more direct access to the contents of the form, is slightly cleaner than the single inheritance approach, but does not conveniently support composition of multiple user interfaces.

## Automatic Connections

In the previous sections, we connected the OK and Cancel buttons in the form directly to the dialog's accept() and reject() slots because we did not need to perform any processing on the contents of the dialog. If we want to process the information entered by the user before accepting it, we need to connect the clicked() signal from the OK button to a custom slot in our dialog. We will first show an example of the dialog in which the slot is connected by hand then compare it with a dialog that uses automatic connection.

### A Dialog Without Auto-Connect

We define the dialog in the same way as before, but now include a slot in addition to the constructor:

        class ImageDialog : public QDialog, private Ui::ImageDialog
        {
            Q_OBJECT

        public:
            ImageDialog(QWidget *parent = 0);

        private slots:
            void checkValues();
        };

The checkValues() slot will be used to validate the values provided by the user.

In the dialog's constructor we set up the widgets as before, and connect the Cancel button's clicked() signal to the dialog's reject() slot. We also disable the autoDefault property in both buttons to ensure that the dialog does not interfere with the way that the line edit handles return key events:

        ImageDialog::ImageDialog(QWidget *parent)
            : QDialog(parent)
        {
            setupUi(this);
            okButton->setAutoDefault(false);
            cancelButton->setAutoDefault(false);
            ...
            connect(okButton, SIGNAL(clicked()), this, SLOT(checkValues()));
        }

We connect the OK button's clicked() signal to the dialog's checkValues() slot which we implement as follows:

        void ImageDialog::checkValues()
        {
            if (nameLineEdit->text().isEmpty())
                (void) QMessageBox::information(this, tr("No Image Name"),
                    tr("Please supply a name for the image."), QMessageBox::Cancel);
            else
                accept();
        }

This custom slot does the minimum necessary to ensure that the data entered by the user is valid - it only accepts the input if a name was given for the image.

### A Dialog With Auto-Connect

Although it is easy to implement a custom slot in the dialog and connect it in the constructor, we could instead use `uic`'s auto-connection facilities to connect the OK button's clicked() signal to a slot in our subclass. To do this, we only need to declare and implement a slot with a name that follows a standard convention:

        void on_<widget name>_<signal name>(<signal parameters>);

Using this convention, we can define and implement a slot that responds to mouse clicks on the OK button:

        class ImageDialog : public QDialog, private Ui::ImageDialog
        {
            Q_OBJECT

        public:
            ImageDialog(QWidget *parent = 0);

        private slots:
            void on_okButton_clicked();
        };

Automatic connection of signals and slots provides both a standard naming convention and an explicit interface for widget designers to work to. By providing source code that implements a given interface, user interface designers can check that their designs actually work without having to write code themselves.

[Previous: Using Custom Widgets with Qt Designer] [Contents] [Next: Creating Custom Widgets for Qt Designer]