diff options
| author | Richard Weickelt <richard@weickelt.de> | 2018-05-31 21:41:47 +0200 |
|---|---|---|
| committer | Richard Weickelt <richard@weickelt.de> | 2018-06-21 18:00:11 +0000 |
| commit | 73fdeb9c1c70079e54104c93811b5d7ff9e4ee0b (patch) | |
| tree | c6c170c7a27fa8fa1715c035515c3ba849c097c9 /src/qml/doc | |
| parent | f44782d0cdbdb800d9c31d5aff712fbf29d52edc (diff) | |
Provide API to access singletons associated with a QQmlEngine
This patch adds allows C++ code to retrieve the instance of a registered
singleton type. Until now this required a deturn via QML expression.
Two methods are added to QQmlEngine: A generic one that encapsulates all
singleton objects in a QJSValue and a template function for QObject-derived
singleton types.
An additional convenience function is added to query the QML type id. This
function may also be used for other purposes in the future.
[ChangeLog][QtQml][QQmlEngine] Added API to access singletons associated with
a QQmlEngine.
Task-number: QTBUG-39970
Change-Id: I67c132ede35f80b9aaf1c5e5456715cf4f1b0848
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/qmlfunctions.qdoc | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 6445a003a1..62c0f5d81b 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -638,3 +638,25 @@ are registered for that version. This is particularly useful for keeping the versions of related modules in sync. */ + +/*! + \since 5.12 + \fn int qmlTypeId(const char* uri, int versionMajor, int versionMinor, const char *qmlName); + \relates QQmlEngine + + Returns the QML type id of a type that was registered with the + name \a qmlName in a particular \a uri and a version specified in \a + versionMajor and \a versionMinor. + + This function returns the same value as the QML type registration functions + such as qmlRegisterType() and qmlRegisterSingletonType(). + + If \a qmlName, \a uri and \a versionMajor match a registered type, but the + specified minor version in \a versionMinor is higher, then the id of the type + with the closest minor version is returned. + + Returns -1 if no matching type was found or one of the given parameters + was invalid. + + \sa qmlRegisterType(), qmlRegisterSingletonType() +*/ |