QFormBuilder Class

The QFormBuilder class is used to dynamically construct user interfaces from UI files at run-time. More...

Header: #include <QFormBuilder>
CMake: find_package(Qt6 REQUIRED COMPONENTS Designer)
target_link_libraries(mytarget PRIVATE Qt6::Designer)
qmake: QT += designer
Inherits: QAbstractFormBuilder

Public Functions

virtual ~QFormBuilder() override
void addPluginPath(const QString &pluginPath)
void clearPluginPaths()
QList<QDesignerCustomWidgetInterface *> customWidgets() const
QStringList pluginPaths() const
void setPluginPath(const QStringList &pluginPaths)

Detailed Description

The QFormBuilder class provides a mechanism for dynamically creating user interfaces at run-time, based on UI files created with Qt Designer. For example:

        MyForm::MyForm(QWidget *parent)
            : QWidget(parent)
            QFormBuilder builder;
            QFile file(":/forms/myWidget.ui");
            QWidget *myWidget = builder.load(&file, this);

            auto *layout = new QVBoxLayout(this);

By including the user interface in the example's resources (myForm.qrc), we ensure that it will be present when the example is run:

    <!DOCTYPE RCC><RCC version="1.0">
    <qresource prefix="/forms">

QFormBuilder extends the QAbstractFormBuilder base class with a number of functions that are used to support custom widget plugins:

  • pluginPaths() returns the list of paths that the form builder searches when loading custom widget plugins.
  • addPluginPath() allows additional paths to be registered with the form builder.
  • setPluginPath() is used to replace the existing list of paths with a list obtained from some other source.
  • clearPluginPaths() removes all paths registered with the form builder.
  • customWidgets() returns a list of interfaces to plugins that can be used to create new instances of registered custom widgets.

The QFormBuilder class is typically used by custom components and applications that embed Qt Designer. Standalone applications that need to dynamically generate user interfaces at run-time use the QUiLoader class, found in the QtUiTools module.

See also QAbstractFormBuilder and Qt UI Tools.

Member Function Documentation


Constructs a new form builder.

[override virtual noexcept] QFormBuilder::~QFormBuilder()

Destroys the form builder.

void QFormBuilder::addPluginPath(const QString &pluginPath)

Adds a new plugin path specified by pluginPath to the list of paths that will be searched by the form builder when loading a custom widget plugin.

See also setPluginPath() and clearPluginPaths().

void QFormBuilder::clearPluginPaths()

Clears the list of paths that the form builder uses to search for custom widget plugins.

See also pluginPaths().

QList<QDesignerCustomWidgetInterface *> QFormBuilder::customWidgets() const

Returns a list of the available plugins.

QStringList QFormBuilder::pluginPaths() const

Returns the list of paths the form builder searches for plugins.

See also addPluginPath().

void QFormBuilder::setPluginPath(const QStringList &pluginPaths)

Sets the list of plugin paths to the list specified by pluginPaths.

See also addPluginPath().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.