QUiLoader Class | Qt UI Tools 5.9

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

Qt 5.9.3 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
Inherits: | QObject

- List of all members, including inherited members

## Public Functions

| QUiLoader(QObject *parent = Q_NULLPTR)
virtual | ~QUiLoader()
void | addPluginPath(const QString &path)
QStringList | availableLayouts() const
QStringList | availableWidgets() const
void | clearPluginPaths()
virtual QAction * | createAction(QObject *parent = Q_NULLPTR, const QString &name = QString())
virtual QActionGroup * | createActionGroup(QObject *parent = Q_NULLPTR, const QString &name = QString())
virtual QLayout * | createLayout(const QString &className, QObject *parent = Q_NULLPTR, const QString &name = QString())
virtual QWidget * | createWidget(const QString &className, QWidget *parent = Q_NULLPTR, const QString &name = QString())
QString | errorString() const
bool | isLanguageChangeEnabled() const
QWidget * | load(QIODevice *device, QWidget *parentWidget = Q_NULLPTR)
QStringList | pluginPaths() const
void | setLanguageChangeEnabled(bool enabled)
void | setWorkingDirectory(const QDir &dir)
QDir | workingDirectory() const

- 32 public functions inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 2 signals inherited from QObject
- 1 public variable inherited from QObject
- 10 static public members inherited from QObject
- 9 protected functions inherited from QObject
- 2 protected variables inherited from QObject

## Detailed Description

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.

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.

## Member Function Documentation

### QUiLoader::QUiLoader(QObject *parent = Q_NULLPTR)

Creates a form loader with the given parent.

### `[virtual]` QUiLoader::~QUiLoader()

Destroys the loader.

### void QUiLoader::addPluginPath(const QString &path)

Adds the given path to the list of paths in which the loader will search when locating plugins.

See also pluginPaths() and clearPluginPaths().

### QStringList QUiLoader::availableLayouts() const

Returns a list naming all available layouts that can be built using the createLayout() function

This function was introduced in Qt 4.5.

See also createLayout().

### QStringList QUiLoader::availableWidgets() const

Returns a list naming all available widgets that can be built using the createWidget() function, i.e all the widgets specified within the given plugin paths.

See also pluginPaths() and createWidget().

### void QUiLoader::clearPluginPaths()

Clears the list of paths in which the loader will search when locating plugins.

See also addPluginPath() and pluginPaths().

### `[virtual]` QAction *QUiLoader::createAction(QObject *parent = Q_NULLPTR, const QString &name = QString())

Creates a new action with the given parent and name.

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader's version first.

See also createActionGroup(), createWidget(), and load().

### `[virtual]` QActionGroup *QUiLoader::createActionGroup(QObject *parent = Q_NULLPTR, const QString &name = QString())

Creates a new action group with the given parent and name.

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader's version first.

See also createAction(), createWidget(), and load().

### `[virtual]` QLayout *QUiLoader::createLayout(const QString &className, QObject *parent = Q_NULLPTR, const QString &name = QString())

Creates a new layout with the given parent and name using the class specified by className.

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader's version first.

See also createWidget() and load().

### `[virtual]` QWidget *QUiLoader::createWidget(const QString &className, QWidget *parent = Q_NULLPTR, const QString &name = QString())

Creates a new widget with the given parent and name using the class specified by className. You can use this function to create any of the widgets returned by the availableWidgets() function.

The function is also used internally by the QUiLoader class whenever it creates a widget. Hence, you can subclass QUiLoader and reimplement this function to intervene process of constructing a user interface or widget. However, in your implementation, ensure that you call QUiLoader's version first.

See also availableWidgets() and load().

### QString QUiLoader::errorString() const

Returns a human-readable description of the last error occurred in load().

This function was introduced in Qt 5.0.

See also load().

### bool QUiLoader::isLanguageChangeEnabled() const

Returns true if dynamic retranslation on language change is enabled; returns false otherwise.

This function was introduced in Qt 4.5.

See also setLanguageChangeEnabled().

### QWidget *QUiLoader::load(QIODevice *device, QWidget *parentWidget = Q_NULLPTR)

Loads a form from the given device and creates a new widget with the given parentWidget to hold its contents.

See also createWidget() and errorString().

### QStringList QUiLoader::pluginPaths() const

Returns a list naming the paths in which the loader will search when locating custom widget plugins.

See also addPluginPath() and clearPluginPaths().

### void QUiLoader::setLanguageChangeEnabled(bool enabled)

If enabled is true, user interfaces loaded by this loader will automatically retranslate themselves upon receiving a language change event. Otherwise, the user interfaces will not be retranslated.

This function was introduced in Qt 4.5.

See also isLanguageChangeEnabled().

### void QUiLoader::setWorkingDirectory(const QDir &dir)

Sets the working directory of the loader to dir. The loader will look for other resources, such as icons and resource files, in paths relative to this directory.

See also workingDirectory().

### QDir QUiLoader::workingDirectory() const

Returns the working directory of the loader.

See also setWorkingDirectory().