KDeclarative::QmlObject

KDeclarative
QmlObject

#include <KDeclarative/QmlObject>

Inheritance diagram for KDeclarative::QmlObject:

Properties
bool	initializationDelayed

QObject	rootObject

QUrl	source

QQmlComponent::Status	status

QString	translationDomain

Properties inherited from QObject
	objectName

Signals
void	finished ()

void	statusChanged (QQmlComponent::Status)

Public Slots
void	completeInitialization (const QVariantHash &initialProperties=QVariantHash())

Public Member Functions
	QmlObject (QObject *parent=nullptr)

	QmlObject (QQmlEngine engine, QObject parent=nullptr)

	QmlObject (QQmlEngine engine, QQmlContext rootContext, QObject *parent=nullptr)

	QmlObject (std::shared_ptr< QQmlEngine > engine, QQmlContext rootContext=nullptr, QObject parent=nullptr)

QObject *	createObjectFromComponent (QQmlComponent component, QQmlContext context=nullptr, const QVariantHash &initialProperties=QVariantHash())

QObject *	createObjectFromSource (const QUrl &source, QQmlContext *context=nullptr, const QVariantHash &initialProperties=QVariantHash())

QQmlEngine *	engine ()

bool	isInitializationDelayed () const

void	loadPackage (const QString &packageName)

QQmlComponent *	mainComponent () const

KPackage::Package	package () const

QQmlContext *	rootContext () const

QObject *	rootObject () const

void	setInitializationDelayed (const bool delay)

void	setPackage (const KPackage::Package &package)

void	setSource (const QUrl &source)

void	setTranslationDomain (const QString &translationDomain)

QUrl	source () const

QQmlComponent::Status	status () const

QString	translationDomain () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
	QmlObject (QQmlEngine engine, QQmlContext rootContext, QmlObject obj, QObject parent=nullptr)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

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

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

An object that instantiates an entire QML context, with its own declarative engine.

Author: Marco Martin [email protected][email protected]kde.[email protected]org

KDeclarative::QmlObject provides a class to conveniently use QML based declarative user interfaces inside Plasma widgets. A QmlObject corresponds to one QML file (which can include others). It will have its own QQmlEngine with a single root object, described in the QML file.

Definition at line 41 of file qmlobject.h.

Constructor & Destructor Documentation

◆ QmlObject() [1/5]

KDeclarative::QmlObject::QmlObject ( QObject * parent = nullptr )

explicit

Constructs a new QmlObject.

Parameters

parent the parent of this object

Definition at line 138 of file qmlobject.cpp.

◆ QmlObject() [2/5]

KDeclarative::QmlObject::QmlObject	(	QQmlEngine *	engine,
		QObject *	parent = `nullptr`
	)

explicit

Constructs a new QmlObject.

Parameters

engine	a QQmlEngine we want to use
parent	the parent of this object

Deprecated:: Since 5.95, Use QmlObject(std::shared_ptr<QmlEngine>, QObject*) instead.

Definition at line 144 of file qmlobject.cpp.

◆ QmlObject() [3/5]

KDeclarative::QmlObject::QmlObject	(	QQmlEngine *	engine,
		QQmlContext *	rootContext,
		QObject *	parent = `nullptr`
	)

explicit

Constructs a new QmlObject.

Parameters

engine	the QQmlEngine to use
rootContext	the root context to use for object creation
parent	the parent of this object

Deprecated:: Since 5.95, Use QmlObject(std::shared_ptr<QmlEngine>, QmlContext*, QObject*) instead.

Definition at line 149 of file qmlobject.cpp.

◆ QmlObject() [4/5]

KDeclarative::QmlObject::QmlObject	(	std::shared_ptr< QQmlEngine >	engine,
		QQmlContext *	rootContext = `nullptr`,
		QObject *	parent = `nullptr`
	)

explicit

Construct a new QmlObject.

Parameters

engine	The QQmlEngine to use. If this object is the first user of the engine (e.g. use_count() is 1), KDeclarative::setupEngine() will be called. If this is nullptr, a new engine will be created for this object to use.
rootContext	The QML context to use for object creation. If this is nullptr, the engine's root context will be used.
parent	The QObject parent for this object.

Definition at line 161 of file qmlobject.cpp.

◆ QmlObject() [5/5]

KDeclarative::QmlObject::QmlObject	(	QQmlEngine *	engine,
		QQmlContext *	rootContext,
		QmlObject *	obj,
		QObject *	parent = `nullptr`
	)

explicitprotected

Constructs a new QmlObject.

Parameters

engine	a QQmlEngine we want to use
rootContext	the root context we want to use for objects creation
obj	setupEngine is called when this is set to nullptr. This way the creator can influence if the engine should be initialized or not in case it is shared between multiple objects (such as QmlObjectSharedEngine)
parent	the parent of this object

Since: 5.45

Deprecated:: Since 5.95, Use QmlObject(std::shared_ptr<QmlEngine>, QmlContext*, QObject*) instead. The "obj" parameter has been dropped, instead setupEngine will be called if this QmlObject is the first user of the engine.

Definition at line 154 of file qmlobject.cpp.

Member Function Documentation

◆ completeInitialization

void KDeclarative::QmlObject::completeInitialization ( const QVariantHash & initialProperties = QVariantHash() )

slot

Finishes the process of initialization.

If isInitializationDelayed() is false, calling this will have no effect.

Parameters

initialProperties optional properties that will be set on the object when created (and before Component.onCompleted gets emitted

Definition at line 304 of file qmlobject.cpp.

◆ createObjectFromComponent()

QObject * KDeclarative::QmlObject::createObjectFromComponent	(	QQmlComponent *	component,
		QQmlContext *	context = `nullptr`,
		const QVariantHash &	initialProperties = `QVariantHash()`
	)

Creates and returns an object based on the provided QQmlComponent with the same QQmlEngine and the same root context as the admin object, that will be the parent of the newly created object.

Parameters

component	the component we want to instantiate
context	The QQmlContext in which we will create the object, if 0 it will use the engine's root context
initialProperties	optional properties that will be set on the object when created (and before Component.onCompleted gets emitted

Definition at line 344 of file qmlobject.cpp.

◆ createObjectFromSource()

QObject * KDeclarative::QmlObject::createObjectFromSource	(	const QUrl &	source,
		QQmlContext *	context = `nullptr`,
		const QVariantHash &	initialProperties = `QVariantHash()`
	)

Creates and returns an object based on the provided url to a Qml file with the same QQmlEngine and the same root context as the main object, that will be the parent of the newly created object.

Parameters

source	url where the QML file is located
context	The QQmlContext in which we will create the object, if 0 it will use the engine's root context
initialProperties	optional properties that will be set on the object when created (and before Component.onCompleted gets emitted

Definition at line 336 of file qmlobject.cpp.

◆ engine()

QQmlEngine * KDeclarative::QmlObject::engine ( )

Returns: the declarative engine that runs the qml file assigned to this widget.

Definition at line 253 of file qmlobject.cpp.

◆ finished

void KDeclarative::QmlObject::finished ( )

signal

Emitted when the parsing and execution of the QML file is terminated.

◆ isInitializationDelayed()

bool KDeclarative::QmlObject::isInitializationDelayed ( ) const

Returns: true if the initialization of the QML file will be delayed at the end of the event loop

Definition at line 248 of file qmlobject.cpp.

◆ loadPackage()

void KDeclarative::QmlObject::loadPackage ( const QString & packageName )

Load the package called packageName, then loads the mainscript file for that package.

Parameters

packageName the plugin name of the package @seprecated Since 5.98, use KPackage manually and set the source URL to the "mainscript" file path

Definition at line 224 of file qmlobject.cpp.

◆ mainComponent()

QQmlComponent * KDeclarative::QmlObject::mainComponent ( ) const

Returns: the main QQmlComponent of the engine

Definition at line 267 of file qmlobject.cpp.

◆ package()

KPackage::Package KDeclarative::QmlObject::package ( ) const

Returns: the optional package, if any @seprecated Since 5.98, use KPackage manually and set the source URL to the "mainscript" file path

Definition at line 237 of file qmlobject.cpp.

◆ rootContext()

QQmlContext * KDeclarative::QmlObject::rootContext ( ) const

The components's creation context.

Since: 5.11

Definition at line 272 of file qmlobject.cpp.

◆ rootObject()

QObject* KDeclarative::QmlObject::rootObject ( ) const

Returns: the root object of the declarative object tree

◆ setInitializationDelayed()

void KDeclarative::QmlObject::setInitializationDelayed ( const bool delay )

Sets whether the execution of the QML file has to be delayed later in the event loop.

It has to be called before setQmlPath(). In this case it will be possible to assign new objects in the main engine context before the main component gets initialized. In that case it will be possible to access it immediately from the QML code. The initialization will either be completed automatically asynchronously or explicitly by calling completeInitialization()

Parameters

delay if true the initialization of the QML file will be delayed at the end of the event loop

Definition at line 243 of file qmlobject.cpp.

◆ setPackage()

void KDeclarative::QmlObject::setPackage ( const KPackage::Package & package )

Sets a package, then loads the mainscript file for that package.

Parameters

package the package we want to use to provide QML files to this QML object @seprecated Since 5.98, use KPackage manually and set the source URL to the "mainscript" file path

Definition at line 231 of file qmlobject.cpp.

◆ setSource()

void KDeclarative::QmlObject::setSource ( const QUrl & source )

Sets the path of the QML file to parse and execute.

Parameters

path	the absolute path of a QML file

Definition at line 212 of file qmlobject.cpp.

◆ setTranslationDomain()

void KDeclarative::QmlObject::setTranslationDomain ( const QString & translationDomain )

Call this method before calling setupBindings to install a translation domain for all i18n global functions.

If a translation domain is set all i18n calls delegate to the matching i18nd calls with the provided translation domain.

The translationDomain affects all i18n calls including those from imports. Because of that modules intended to be used as imports should prefer the i18nd variants and set the translation domain explicitly in each call.

This method is only required if your declarative usage is inside a library. If it's in an application there is no need to set the translation domain as the application's domain can be used.

Parameters

translationDomain The translation domain to be used for i18n calls.

Since: 5.0

Definition at line 202 of file qmlobject.cpp.

◆ source()

QUrl KDeclarative::QmlObject::source ( ) const

Returns: the absolute path of the current QML file

◆ status()

QQmlComponent::Status KDeclarative::QmlObject::status ( ) const

The component's current status.

Since: 5.11

◆ translationDomain()

QString KDeclarative::QmlObject::translationDomain ( ) const

Returns: the translation domain for the i18n calls done in this QML engine

Since: 5.0

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KDeclarative

KDeclarative::QmlObject

Properties

Signals

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QmlObject() [1/5]

◆ QmlObject() [2/5]

◆ QmlObject() [3/5]

◆ QmlObject() [4/5]

◆ QmlObject() [5/5]

Member Function Documentation

◆ completeInitialization

◆ createObjectFromComponent()

◆ createObjectFromSource()

◆ engine()

◆ finished

◆ isInitializationDelayed()

◆ loadPackage()

◆ mainComponent()

◆ package()

◆ rootContext()

◆ rootObject()

◆ setInitializationDelayed()

◆ setPackage()

◆ setSource()

◆ setTranslationDomain()

◆ source()

◆ status()

◆ translationDomain()