QUiLoader Class | Qt UI Tools 5.13.2

Qt 5.13 | Qt UI Tools | C++ Classes | QUiLoader

Qt 5.13.2 Reference Documentation

# QUiLoader Class

The QUiLoader class enables standalone applications to dynamically create user interfaces at run-time using the information stored in UI files or specified in plugin paths. More...

Header: | #include <QUiLoader>
qmake: | QT += uitools

## Detailed Description

In addition, you can customize or create your own user interface by deriving your own loader class.

If you have a custom component or an application that embeds Qt Designer, you can also use the QFormBuilder class provided by the QtDesigner module to create user interfaces from UI files.

The QUiLoader class provides a collection of functions allowing you to create widgets based on the information stored in UI files (created with Qt Designer) or available in the specified plugin paths. The specified plugin paths can be retrieved using the pluginPaths() function. Similarly, the contents of a UI file can be retrieved using the load() function. For example:

      MyWidget::MyWidget(QWidget *parent)
          : QWidget(parent)
      {
          QUiLoader loader;
          QFile file(":/forms/myform.ui");
          file.open(QFile::ReadOnly);
          QWidget *myWidget = loader.load(&file, this);
          file.close();

          QVBoxLayout *layout = new QVBoxLayout;
          layout->addWidget(myWidget);
          setLayout(layout);
      }

By including the user interface in the form's resources (`myform.qrc`), we ensure that it will be present at run-time:

      <!DOCTYPE RCC><RCC version="1.0">
      <qresource prefix="/forms">
      <file>myform.ui</file>
      </qresource>
      </RCC>

The availableWidgets() function returns a QStringList with the class names of the widgets available in the specified plugin paths. To create these widgets, simply use the createWidget() function. For example:

      QWidget *loadCustomWidget(QWidget *parent)
      {
          QUiLoader loader;
          QWidget *myWidget;

          QStringList availableWidgets = loader.availableWidgets();

          if (availableWidgets.contains("AnalogClock"))
              myWidget = loader.createWidget("AnalogClock", parent);

          return myWidget;
      }

To make a custom widget available to the loader, you can use the addPluginPath() function; to remove all available widgets, you can call the clearPluginPaths() function.

The createAction(), createActionGroup(), createLayout(), and createWidget() functions are used internally by the QUiLoader class whenever it has to create an action, action group, layout, or widget respectively. For that reason, you can subclass the QUiLoader class and reimplement these functions to intervene the process of constructing a user interface. For example, you might want to have a list of the actions created when loading a form or creating a custom widget.

For a complete example using the QUiLoader class, see the Calculator Builder Example.

See also Qt UI Tools and QFormBuilder.