\inmodule QtUiTools More...

#include <quiloader.h>

Inheritance diagram for QUiLoader:

Collaboration diagram for QUiLoader:

Public Member Functions
	QUiLoader (QObject *parent=nullptr)
	Creates a form loader with the given parent.

	~QUiLoader () override
	Destroys the loader.

QStringList	pluginPaths () const
	Returns a list naming the paths in which the loader will search when locating custom widget plugins.

void	clearPluginPaths ()
	Clears the list of paths in which the loader will search when locating plugins.

void	addPluginPath (const QString &path)
	Adds the given path to the list of paths in which the loader will search when locating plugins.

QWidget *	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.

QStringList	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.

QStringList	availableLayouts () const

virtual QWidget *	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.

virtual QLayout *	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.

virtual QActionGroup *	createActionGroup (QObject *parent=nullptr, const QString &name=QString())
	Creates a new action group with the given parent and name.

virtual QAction *	createAction (QObject *parent=nullptr, const QString &name=QString())
	Creates a new action with the given parent and name.

void	setWorkingDirectory (const QDir &dir)
	Sets the working directory of the loader to dir.

QDir	workingDirectory () const
	Returns the working directory of the loader.

void	setLanguageChangeEnabled (bool enabled)

bool	isLanguageChangeEnabled () const

void	setTranslationEnabled (bool enabled)

bool	isTranslationEnabled () const

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

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtUiTools

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 \QD, 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 \QD) 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);
}

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 = nullptr;
 
    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 \l{Calculator Builder}.

See also: {Qt UI Tools}, QFormBuilder

Definition at line 22 of file quiloader.h.

Constructor & Destructor Documentation

◆ QUiLoader()

QUiLoader::QUiLoader ( QObject * parent = nullptr )

explicit

Creates a form loader with the given parent.

Definition at line 615 of file quiloader.cpp.

◆ ~QUiLoader()

QUiLoader::~QUiLoader ( )

overridedefault

Destroys the loader.

Member Function Documentation

◆ addPluginPath()

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(), clearPluginPaths()

Definition at line 692 of file quiloader.cpp.

◆ availableLayouts()

QStringList QUiLoader::availableLayouts ( ) const

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

See also: createLayout()

Definition at line 800 of file quiloader.cpp.

◆ availableWidgets()

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(), createWidget()

Definition at line 777 of file quiloader.cpp.

◆ clearPluginPaths()

void QUiLoader::clearPluginPaths ( )

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

See also: addPluginPath(), pluginPaths()

Definition at line 680 of file quiloader.cpp.

◆ createAction()

QAction * QUiLoader::createAction	(	QObject *	parent = nullptr,
		const QString &	name = QString() )

virtual

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(), load()

Definition at line 763 of file quiloader.cpp.

◆ createActionGroup()

QActionGroup * QUiLoader::createActionGroup	(	QObject *	parent = nullptr,
		const QString &	name = QString() )

virtual

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(), load()

Definition at line 746 of file quiloader.cpp.

◆ createLayout()

QLayout * QUiLoader::createLayout	(	const QString &	className,
		QObject *	parent = nullptr,
		const QString &	name = QString() )

virtual

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(), load()

Definition at line 729 of file quiloader.cpp.

◆ createWidget()

QWidget * QUiLoader::createWidget	(	const QString &	className,
		QWidget *	parent = nullptr,
		const QString &	name = QString() )

virtual

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(), load()

Definition at line 711 of file quiloader.cpp.

◆ errorString()

QString QUiLoader::errorString ( ) const

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

Since: 5.0

See also: load()

Definition at line 909 of file quiloader.cpp.

◆ isLanguageChangeEnabled()

bool QUiLoader::isLanguageChangeEnabled ( ) const

Since: 4.5

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

See also: setLanguageChangeEnabled()

Definition at line 863 of file quiloader.cpp.

◆ isTranslationEnabled()

bool QUiLoader::isTranslationEnabled ( ) const

Since: 4.5

Returns true if translation is enabled; returns false otherwise.

See also: setTranslationEnabled()

Definition at line 896 of file quiloader.cpp.

◆ load()

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(), errorString()

Definition at line 653 of file quiloader.cpp.

◆ pluginPaths()

QStringList QUiLoader::pluginPaths ( ) const

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

See also: addPluginPath(), clearPluginPaths()

Definition at line 668 of file quiloader.cpp.

◆ setLanguageChangeEnabled()

void QUiLoader::setLanguageChangeEnabled ( bool enabled )

Since: 4.5

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

Definition at line 848 of file quiloader.cpp.

◆ setTranslationEnabled()

void QUiLoader::setTranslationEnabled ( bool enabled )

Since: 4.5

If enabled is true, user interfaces loaded by this loader will be translated. Otherwise, the user interfaces will not be translated.

Note: This is orthogonal to languageChangeEnabled.

See also: isLanguageChangeEnabled(), setLanguageChangeEnabled()

Definition at line 881 of file quiloader.cpp.

◆ setWorkingDirectory()

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

Definition at line 821 of file quiloader.cpp.

◆ workingDirectory()

QDir QUiLoader::workingDirectory ( ) const

Returns the working directory of the loader.

See also: setWorkingDirectory()

Definition at line 833 of file quiloader.cpp.

The documentation for this class was generated from the following files:

qttools/src/uitools/quiloader.h (a5bb88c896170ec0c719c3a73ce932cb8d5205ca)
qttools/src/uitools/quiloader.cpp (47b56e9050b1eaad861427ae9561ae3a06510320)

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QUiLoader()

◆ ~QUiLoader()

Member Function Documentation

◆ addPluginPath()

◆ availableLayouts()

◆ availableWidgets()

◆ clearPluginPaths()

◆ createAction()

◆ createActionGroup()

◆ createLayout()

◆ createWidget()

◆ errorString()

◆ isLanguageChangeEnabled()

◆ isTranslationEnabled()

◆ load()

◆ pluginPaths()

◆ setLanguageChangeEnabled()

◆ setTranslationEnabled()

◆ setWorkingDirectory()

◆ workingDirectory()