Qt Reference Documentation

[Previous: Porting to Qt 4 - Drag and Drop] [Next: Porting to Graphics View]

# Porting UI Files to Qt 4

Qt Designer has changed significantly in the Qt 4 release. We have moved away from viewing Qt Designer as an IDE and concentrated on creating a robust form builder which can be extended and embedded in existing IDEs. Our efforts are ongoing and include the Visual Studio Integration, as well as integrating Designer with KDevelop and possibly other IDEs.

The most important changes in Qt Designer 4 which affect porting for UI files are summarized below:

- Removed project manager. Qt Designer now only reads and edits UI files. It has no notion of a project file (`.pro`).
- Removed code editor. Qt Designer can no longer be used to edit source files.
- Changed format of UI files. Qt Designer 4 cannot read files created by Qt Designer 3 and vice versa. However, we provide the tool `uic3` to generate Qt 4 code out of Qt 3 UI files, and to convert old UI files into a format readable by Qt Designer 4.
- Changed structure of the code generated by `uic`. The `myform.ui` file containing the form `MyForm` is now converted into a single header file `ui_myform.h`, which contains the declaration and inline definition of a POD class `Ui::MyForm`.
- New resource file system. Icon data is no longer stored in the UI file. Instead, icons are put into resource files (`.qrc`).

The rest of this document explains how to deal with the main differences between Qt Designer 3 and Qt Designer 4:

See Porting to Qt 4 and qt3to4 - The Qt 3 to 4 Porting Tool for more information about porting from Qt 3 to Qt 4. See also the Qt Designer Manual.

## uic Output

In Qt 3, `uic` generated a header file and an implementation for a class, which inherited from one of Qt's widgets. To use the form, the programmer included the generated sources into the application and created an instance of the class.

In Qt 4, `uic` creates a header file containing a POD class. The name of this class is the object name of the main container, qualified with the `Ui` namespace (e.g., `Ui::MyForm`). The class is implemented using inline functions, removing the need of a separate `.cpp` file. Just as in Qt 3, this class contains pointers to all the widgets inside the form as public members. In addition, the generated class provides the public method `setupUi()`.

The class generated by `uic` is not a QWidget; in fact, it's not even a QObject. Instead, it is a class which knows how to populate an instance of a main container with the contents of the form. The programmer creates the main container himself, then passes it to `setupUi()`.

For example, here's the `uic` output for a simple `helloworld.ui` form (some details were removed for simplicity):

     namespace Ui {

     class HelloWorld
     {
     public:
         QVBoxLayout *vboxLayout;
         QPushButton *pushButton;

         void setupUi(QWidget *HelloWorld)
         {
             HelloWorld->setObjectName(QString::fromUtf8("HelloWorld"));

             vboxLayout = new QVBoxLayout(HelloWorld);
             vboxLayout->setObjectName(QString::fromUtf8("vboxLayout"));

             pushButton = new QPushButton(HelloWorld);
             pushButton->setObjectName(QString::fromUtf8("pushButton"));

             vboxLayout->addWidget(pushButton);

             retranslateUi(HelloWorld);
         }
     };

     }

In this case, the main container was specified to be a QWidget (or any subclass of QWidget). Had we started with a QMainWindow template in Qt Designer, `setupUi()`'s parameter would be of type QMainWindow.

There are two ways to create an instance of our form. One approach is to create an instance of the `Ui::HelloWorld` class, an instance of the main container (a plain QWidget), and call `setupUi()`:

     #include <QApplication>
     #include <QWidget>

     #include "ui_helloworld.h"   // defines Ui::HelloWorld

     int main(int argc, char *argv[])
     {
         QApplication app(argc, argv);

         QWidget w;
         Ui::HelloWorld ui;
         ui.setupUi(&w);

         w.show();
         return app.exec();
     }

The second approach is to inherit from both the `Ui::HelloWorld` class and the main container, and to call `setupUi()` in the constructor of the subclass. In that case, QWidget (or one of its subclasses, e.g. QDialog) must appear first in the base class list so that moc picks it up correctly. For example:

     #include <QApplication>
     #include <QWidget>

     #include "ui_helloworld.h"   // defines Ui::HelloWorld

     class HelloWorldWidget : public QWidget, public Ui::HelloWorld
     {
         Q_OBJECT

     public:
         HelloWorldWidget(QWidget *parent = 0)
             : QWidget(parent)
         { setupUi(this); }
     };

     int main(int argc, char *argv[])
     {
         QApplication app(argc, argv);
         HelloWorldWidget w;
         w.show();
         return app.exec();
     }

This second method is useful when porting Qt 3 forms to Qt 4. `HelloWorldWidget` is a class whose instance is the actual form and which contains public pointers to all the widgets in it. It therefore has an interface identical to that of a class generated by `uic` in Qt 3.

Creating POD classes from UI files is more flexible and generic than the old approach of creating widgets. Qt Designer does not need to know anything about the main container apart from the base widget class it inherits. Indeed, `Ui::HelloWorld` can be used to populate any container that inherits QWidget. Conversely, all non-GUI aspects of the main container may be implemented by the programmer in the application's sources without reference to the form.

## Working with uic3

Qt 4 comes with the tool `uic3` for working with old `.ui` files. It can be used in two ways:

1. To generate headers and source code for a widget to implement any custom signals and slots added using Qt Designer 3.
2. To generate a new UI file that can be used with Qt Designer 4.

You can use both these methods in combination to obtain UI, header and source files that you can use as a starting point when porting your user interface to Qt 4.

The first method generates a Qt 3 style header and implementation which uses Qt 4 widgets (this includes the Qt 3 compatibility classes present in the Qt3Support library). This process should be familiar to anyone used to working with Qt Designer 3:

     uic3 myform.ui > myform.h
     uic3 -impl myform.h myform.ui > myform.cpp

The resulting files `myform.h` and `myform.cpp` implement the form in Qt 4 using a QWidget that will include custom signals, slots and connections specified in the UI file. However, see below for the limitations of this method.

The second method is to use `uic3` to convert a Qt Designer 3 `.ui` file to the Qt Designer 4 format:

     uic3 -convert myform3.ui > myform4.ui

The resulting file `myform4.ui` can be edited in Qt Designer 4. The header file for the form is generated by Qt 4's `uic`. See the Using a Designer UI File in Your Application chapter of the Qt Designer Manual for information about the preferred ways to use forms created with Qt Designer 4.

`uic3` tries very hard to map Qt 3 classes and their properties to Qt 4. However, the behavior of some classes changed significantly in Qt 4. To keep the form working, some Qt 3 classes are mapped to classes in the Qt3Support library. Table 1 shows a list of classes this applies to.

Qt 3 class | Qt 4 class
--- | ---
`QButtonGroup` | Q3ButtonGroup
`QDateEdit` | Q3DateEdit
`QDateTimeEdit` | Q3DateTimeEdit
`QGroupBox` | Q3GroupBox
`QListBox` | Q3ListBox
`QListView` | Q3ListView
`QMainWindow` | Q3MainWindow
`QTextEdit` | Q3TextEdit
`QTextView` | Q3TextView
`QTimeEdit` | Q3TimeEdit
`QWidgetStack` | Q3WidgetStack
`QWizard` | Q3Wizard

## Limitations of uic3

Converting Qt 3 UI files to Qt 4 has some limitations. The most noticeable limitation is the fact that since `uic` no longer generates a QObject, it's not possible to define custom signals or slots for the form. Instead, the programmer must define these signals and slots in the main container and connect them to the widgets in the form after calling `setupUi()`. For example:

     class HelloWorldWidget : public QWidget, public Ui::HelloWorld
     {
         Q_OBJECT

     public:
         HelloWorldWidget(QWidget *parent = 0);

     public slots:
         void mySlot();
     };

     HelloWorldWidget::HelloWorldWidget(QWidget *parent)
         : QWidget(parent)
     {
         setupUi(this);

         QObject::connect(pushButton, SIGNAL(clicked()),
                          this, SLOT(mySlot()));
     }

     void HelloWorldWidget::mySlot()
     {
         ...
     }

A quick and dirty way to port forms containing custom signals and slots is to generate the code using `uic3`, rather than `uic`. Since `uic3` does generate a QWidget, it will populate it with custom signals, slots and connections specified in the UI file. However, `uic3` can only generate code from Qt 3 UI files, which implies that the UI files never get translated and need to be edited using Qt Designer 3.

Note also that it is possible to create implicit connections between the widgets in a form and the main container. After `setupUi()` populates the main container with child widgets it scans the main container's list of slots for names with the form `on_objectName_signalName().`

If the form contains a widget whose object name is `objectName`, and if that widget has a signal called `signalName`, then this signal will be connected to the main container's slot. For example:

     class HelloWorldWidget : public QWidget, public Ui::HelloWorld
     {
         Q_OBJECT

     public:
         HelloWorldWidget(QWidget *parent = 0);

     public slots:
         void on_pushButton_clicked();
     };

     HelloWorldWidget::HelloWorldWidget(QWidget *parent)
         : QWidget(parent)
     {
         setupUi(this);
     }

     void HelloWorldWidget::on_pushButton_clicked()
     {
         ...
     }

Because of the naming convention, `setupUi()` automatically connects `pushButton`'s `clicked()` signal to `HelloWorldWidget`'s `on_pushButton_clicked()` slot.

## Icons

In Qt 3, the binary data for the icons used by a form was stored in the UI file. In Qt 4 icons and any other external files can be compiled into the application by listing them in a resource file (`.qrc`). This file is translated into a C++ source file using Qt's resource compiler (`rcc`). The data in the files is then available to any Qt class which takes a file name argument.

Imagine that we have two icons, `yes.png` and `no.png`. We create a resource file called `icons.qrc` with the following contents:

     <RCC version="1.0">
         <qresource prefix="/icons">
             <file>yes.png</file>
             <file>no.png</file>
         </qresource>
     </RCC>

Next, we add the resource file to our `.pro` file:

     RESOURCES += icons.qrc

When `qmake` is run, it will create the appropriate Makefile rules to call `rcc` on the resource file, and compile and link the result into the application. The icons may be accessed as follows:

     QFile file(":/icons/yes.png");
     QIcon icon(":/icons/no.png");
     QPixmap pixmap(":/icons/no.png");

In each case, the leading colon tells Qt to look for the file in the virtual file tree defined by the set of resource files compiled into the application instead of the file system.

In the `.qrc` file, the `qresource` tag's `prefix` attribute is used to arrange the files into categories and set a virtual path where the files will be accessed.

Caveat: If the resource file was not linked directly into the application, but instead into a dynamic or static library that was later linked with the application, its virtual file tree will not be available to QFile and friends until the Q_INIT_RESOURCE() macro is called. This macro takes one argument, which is the name of the `.qrc` file, without the path or the file extension. A convenient place to initialize resources is at the top of the application's `main()` function.

In Qt Designer 4, we can associate any number of resource files with a form using the resource editor tool. The widgets in the form can access all icons specified in its associated resource files.

In short, porting of icons from a Qt 3 to a Qt 4 form involves the following steps:

1. Use `uic3 -convert` to obtain a UI file understood by Qt Designer 4.
2. Create a `.qrc` file with a list of all the icon files.
3. Add the resource file to the `.pro` file.
4. Open the form in Qt Designer 4 and add the resource file to the form's resource editor.
5. Set the icon properties for the appropriate widgets.

## Custom Widgets

Qt Designer 3 supported defining custom widgets by specifying their name, header file and methods. In Qt Designer 4, a custom widget is always created by "promoting" an existing Qt widget to a custom class. Qt Designer 4 assumes that the custom widget will inherit from the widget that has been promoted. In the form editor, the custom widget will retain the looks, behavior, properties, signals and slots of the base widget. It is not currently possible to tell Qt Designer 4 that the custom widget will have additional signals or slots.

`uic3 -convert` handles the conversion of custom widgets to the new `.ui` format, however all custom signals and slots are lost. Furthermore, since Qt Designer 3 never knew the base widget class of a custom widget, it is taken to be QWidget. This is often sufficient. If not, the custom widgets have to be inserted manually into the form.

Custom widget plugins, which contain custom widgets to be used in Qt Designer, must themselves be ported before they can be used in forms ported with `uic3`. The Porting to Qt 4 document contains information about general porting issues that may apply to the custom widget code itself, and the Creating Custom Widgets for Qt Designer chapter of the Qt Designer Manual describes how the ported widget should be built in order to work in Qt Designer 4.