QUiLoader Class

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);
}

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

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

    QStringList availableWidgets = loader.availableWidgets();

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

    return myWidget;
}

Member Function Documentation

QUiLoader::QUiLoader(QObject *parent = nullptr)

Creates a form loader with the given parent.

[override 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

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 = 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 = 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 = 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 = 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().

[since 5.0] 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.

See also setLanguageChangeEnabled().

QWidget *QUiLoader::load(QIODevice *device, QWidget *parentWidget = 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.

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().