QQmlEngine 类提供实例化 QML 组件的环境。 更多...
| 头： | #include <QQmlEngine> |
| qmake: | QT += qml |
| Since: | Qt 5.0 |
| 继承： | QJSEngine |
| 继承者： |
该类在 Qt 5.0 引入。
| enum | ObjectOwnership { CppOwnership, JavaScriptOwnership } |
| QQmlEngine (QObject * parent = nullptr) | |
| virtual | ~QQmlEngine () override |
| void | addImageProvider (const QString & providerId , QQmlImageProviderBase * provider ) |
| void | addImportPath (const QString & path ) |
| void | addPluginPath (const QString & path ) |
| QUrl | baseUrl () const |
| void | clearComponentCache () |
| QQmlImageProviderBase * | imageProvider (const QString & providerId ) const |
| QStringList | importPathList () const |
| bool | importPlugin (const QString & filePath , const QString & uri , QList<QQmlError> * errors ) |
| QQmlIncubationController * | incubationController () const |
| QNetworkAccessManager * | networkAccessManager () const |
| QQmlNetworkAccessManagerFactory * | networkAccessManagerFactory () const |
| QString | offlineStorageDatabaseFilePath (const QString & databaseName ) const |
| QString | offlineStoragePath () const |
| bool | outputWarningsToStandardError () const |
| QStringList | pluginPathList () const |
| void | removeImageProvider (const QString & providerId ) |
| QQmlContext * | rootContext () const |
| void | setBaseUrl (const QUrl & url ) |
| void | setImportPathList (const QStringList & paths ) |
| void | setIncubationController (QQmlIncubationController * controller ) |
| void | setNetworkAccessManagerFactory (QQmlNetworkAccessManagerFactory * factory ) |
| void | setOfflineStoragePath (const QString & dir ) |
| void | setOutputWarningsToStandardError (bool enabled ) |
| void | setPluginPathList (const QStringList & paths ) |
| T | singletonInstance (int qmlTypeId ) |
| void | trimComponentCache () |
| void | retranslate () |
| void | exit (int retCode ) |
| void | quit () |
| void | warnings (const QList<QQmlError> & warnings ) |
| QQmlContext * | contextForObject (const QObject * object ) |
| QQmlEngine::ObjectOwnership | objectOwnership (QObject * object ) |
| void | setContextForObject (QObject * object , QQmlContext * context ) |
| void | setObjectOwnership (QObject * object , QQmlEngine::ObjectOwnership ownership ) |
| virtual bool | event (QEvent * e ) override |
| QObject * | qmlAttachedPropertiesObject (const QObject * attachee , bool create = true) |
| void | qmlClearTypeRegistrations () |
| QQmlContext * | qmlContext (const QObject * object ) |
| QQmlEngine * | qmlEngine (const QObject * object ) |
| bool | qmlProtectModule (const char * uri , int majVersion ) |
| int | qmlRegisterAnonymousType (const char * uri , int versionMajor ) |
| int | qmlRegisterExtendedType (const char * uri , int versionMajor , int versionMinor , const char * qmlName ) |
| int | qmlRegisterExtendedUncreatableType (const char * uri , int versionMajor , int versionMinor , const char * qmlName , const QString & reason ) |
| int | qmlRegisterInterface (const char * typeName ) |
| void | qmlRegisterModule (const char * uri , int versionMajor , int versionMinor ) |
| int | qmlRegisterRevision (const char * uri , int versionMajor , int versionMinor ) |
| int | qmlRegisterSingletonInstance (const char * uri , int versionMajor , int versionMinor , const char * typeName , QObject * cppObject ) |
| int | qmlRegisterSingletonType (const char * uri , int versionMajor , int versionMinor , const char * typeName , QJSValue (*)(QQmlEngine *, QJSEngine *) callback ) |
| int | qmlRegisterSingletonType (const char * uri , int versionMajor , int versionMinor , const char * typeName , QObject *(*)(QQmlEngine *, QJSEngine *) callback ) |
| int | qmlRegisterSingletonType (const char * uri , int versionMajor , int versionMinor , const char * typeName , std::function<QObject *(QQmlEngine *, QJSEngine *)> callback ) |
| int | qmlRegisterSingletonType (const QUrl & url , const char * uri , int versionMajor , int versionMinor , const char * qmlName ) |
| int | qmlRegisterType (const char * uri , int versionMajor , int versionMinor , const char * qmlName ) |
| int | qmlRegisterType (const QUrl & url , const char * uri , int versionMajor , int versionMinor , const char * qmlName ) |
| int | qmlRegisterTypeNotAvailable (const char * uri , int versionMajor , int versionMinor , const char * qmlName , const QString & message ) |
| int | qmlRegisterUncreatableMetaObject (const QMetaObject & staticMetaObject , const char * uri , int versionMajor , int versionMinor , const char * qmlName , const QString & reason ) |
| int | qmlRegisterUncreatableType (const char * uri , int versionMajor , int versionMinor , const char * qmlName , const QString & message ) |
| int | qmlTypeId (const char * uri , int versionMajor , int versionMinor , const char * qmlName ) |
| QML_ADDED_IN_MINOR_VERSION ( VERSION ) | |
| QML_ANONYMOUS | |
| QML_ATTACHED ( ATTACHED_TYPE ) | |
| QML_DECLARE_TYPE | |
| QML_DECLARE_TYPEINFO ( Type , Flags ) | |
| QML_ELEMENT | |
| QML_EXTENDED ( EXTENDED_TYPE ) | |
| QML_FOREIGN ( FOREIGN_TYPE ) | |
| QML_INTERFACE | |
| QML_NAMED_ELEMENT ( name ) | |
| QML_REMOVED_IN_MINOR_VERSION ( VERSION ) | |
| QML_SINGLETON | |
| QML_UNAVAILABLE | |
| QML_UNCREATABLE ( reason ) |
每个 QML 组件被实例化在 QQmlContext . QQmlContext 's are essential for passing data to QML components. In QML, contexts are arranged hierarchically and this hierarchy is managed by the QQmlEngine.
Prior to creating any QML components, an application must have created a QQmlEngine to gain access to a QML context. The following example shows how to create a simple Text item.
QQmlEngine engine; QQmlComponent component(&engine); component.setData("import QtQuick 2.0\nText { text: \"Hello world!\" }", QUrl()); QQuickItem *item = qobject_cast<QQuickItem *>(component.create()); //add item to view, etc ...
In this case, the Text item will be created in the engine's 根上下文 .
另请参阅 QQmlComponent , QQmlContext ，和 QML 全局对象 .
ObjectOwnership controls whether or not QML automatically destroys the QObject when the corresponding JavaScript object is garbage collected by the engine. The two ownership options are:
| 常量 | 值 | 描述 |
|---|---|---|
QQmlEngine::CppOwnership
|
0
|
The object is owned by C++ code and QML will never delete it. The JavaScript destroy() method cannot be used on these objects. This option is similar to QScriptEngine::QtOwnership . |
QQmlEngine::JavaScriptOwnership
|
1
|
The object is owned by JavaScript. When the object is returned to QML as the return value of a method call, QML will track it and delete it if there are no remaining JavaScript references to it and it has no QObject::parent (). An object tracked by one QQmlEngine will be deleted during that QQmlEngine 's destructor. Thus, JavaScript references between objects with JavaScriptOwnership from two different engines will not be valid if one of these engines is deleted. This option is similar to QScriptEngine::ScriptOwnership . |
Generally an application doesn't need to set an object's ownership explicitly. QML uses a heuristic to set the default ownership. By default, an object that is created by QML has JavaScriptOwnership. The exception to this are the root objects created by calling QQmlComponent::create () 或 QQmlComponent::beginCreate (), which have CppOwnership by default. The ownership of these root-level objects is considered to have been transferred to the C++ caller.
Objects not-created by QML have CppOwnership by default. The exception to this are objects returned from C++ method calls; their ownership will be set to JavaScriptOwnership. This applies only to explicit invocations of Q_INVOKABLE methods or slots, but not to property getter invocations.
调用 setObjectOwnership () overrides the default ownership heuristic used by QML.
This property holds the directory for storing offline user data
Returns the directory where SQL and other offline storage is placed.
The SQL databases created with openDatabase() are stored here.
The default is QML/OfflineStorage in the platform-standard user application data directory.
Note that the path may not currently exist on the filesystem, so callers wanting to create new files at this location should create it first - see QDir::mkpath ().
访问函数：
| QString | offlineStoragePath () const |
| void | setOfflineStoragePath (const QString & dir ) |
创建新 QQmlEngine 采用给定 parent .
[signal]
void
QQmlEngine::
exit
(
int
retCode
)
This signal is emitted when the QML loaded by the engine would like to exit from the event loop with the specified return code retCode .
该函数在 Qt 5.8 引入。
另请参阅 quit ().
[signal]
void
QQmlEngine::
quit
()
This signal is emitted when the QML loaded by the engine would like to quit.
另请参阅 exit ().
[slot]
void
QQmlEngine::
retranslate
()
Refreshes all binding expressions that use strings marked for translation.
Call this function after you have installed a new translator with QCoreApplication::installTranslator , to ensure that your user-interface shows up-to-date translations.
注意： Due to a limitation in the implementation, this function refreshes all the engine's bindings, not only those that use strings marked for translation. This may be optimized in a future release.
该函数在 Qt 5.10 引入。
[signal]
void
QQmlEngine::
warnings
(const
QList
<
QQmlError
> &
warnings
)
此信号被发射当 warnings messages are generated by QML.
[override virtual]
QQmlEngine::
~QQmlEngine
()
销毁 QQmlEngine .
任何 QQmlContext 's created on this engine will be invalidated, but not destroyed (unless they are parented to the QQmlEngine 对象)。
见 QJSEngine docs for details on cleaning up the JS engine.
设置 provider to use for images requested via the image : url scheme, with host providerId 。 QQmlEngine 拥有所有权对于 provider .
Image providers enable support for pixmap and threaded image requests. See the QQuickImageProvider documentation for details on implementing and using image providers.
All required image providers should be added to the engine before any QML sources files are loaded.
另请参阅 removeImageProvider (), QQuickImageProvider ，和 QQmlImageProviderBase .
添加 path as a directory where the engine searches for installed modules in a URL-based directory structure.
path
may be a local filesystem directory, a
Qt Resource
path (
:/imports
)，
Qt Resource
url (
qrc:/imports
) 或 URL。
path will be converted into canonical form before it is added to the import path list.
The newly added path will be first in the importPathList ().
另请参阅 setImportPathList () 和 QML 模块 .
添加
path
as a directory where the engine searches for native plugins for imported modules (referenced in the
qmldir
file).
By default, the list contains only
.
, i.e. the engine searches in the directory of the
qmldir
file itself.
The newly added path will be first in the pluginPathList ().
另请参阅 setPluginPathList ().
Return the base URL for this engine. The base URL is only used to resolve components when a relative URL is passed to the QQmlComponent 构造函数。
If a base URL has not been explicitly set, this method returns the application's current working directory.
另请参阅 setBaseUrl ().
Clears the engine's internal component cache.
This function causes the property metadata of all components previously loaded by the engine to be destroyed. All previously loaded components and the property bindings for all extant objects created from those components will cease to function.
This function returns the engine to a state where it does not contain any loaded component data. This may be useful in order to reload a smaller subset of the previous component set, or to load a new version of a previously loaded component.
Once the component cache has been cleared, components must be loaded before any new objects can be created.
另请参阅 trimComponentCache ().
[static]
QQmlContext
*QQmlEngine::
contextForObject
(const
QObject
*
object
)
返回 QQmlContext 为 object , or 0 if no context has been set.
当 QQmlEngine instantiates a QObject , the context is set automatically.
另请参阅 setContextForObject (), qmlContext ()，和 qmlEngine ().
[override virtual protected]
bool
QQmlEngine::
event
(
QEvent
*
e
)
重实现： QObject::event (QEvent *e).
Returns the image provider set for
providerId
if found; otherwise returns
nullptr
.
另请参阅 QQuickImageProvider .
Returns the list of directories where the engine searches for installed modules in a URL-based directory structure.
例如，若
/opt/MyApp/lib/imports
is in the path, then QML that imports
com.mycompany.Feature
will cause the
QQmlEngine
to look in
/opt/MyApp/lib/imports/com/mycompany/Feature/
for the components provided by that module. A
qmldir
file is required for defining the type version mapping and possibly QML extensions plugins.
By default, the list contains the directory of the application executable, paths specified in the
QML2_IMPORT_PATH
environment variable, and the builtin
Qml2ImportsPath
from
QLibraryInfo
.
另请参阅 addImportPath () 和 setImportPathList ().
Imports the plugin named filePath 采用 uri provided. Returns true if the plugin was successfully imported; otherwise returns false.
On failure and if non-null, the errors list will have any errors which occurred prepended to it.
The plugin has to be a Qt plugin which implements the QQmlEngineExtensionPlugin 接口。
Returns the currently set incubation controller, or 0 if no controller has been set.
另请参阅 setIncubationController ().
Returns a common QNetworkAccessManager which can be used by any QML type instantiated by this engine.
若 QQmlNetworkAccessManagerFactory has been set and a QNetworkAccessManager has not yet been created, the QQmlNetworkAccessManagerFactory will be used to create the QNetworkAccessManager; otherwise the returned QNetworkAccessManager will have no proxy or cache set.
另请参阅 setNetworkAccessManagerFactory ().
返回当前 QQmlNetworkAccessManagerFactory .
另请参阅 setNetworkAccessManagerFactory ().
[static]
QQmlEngine::ObjectOwnership
QQmlEngine::
objectOwnership
(
QObject
*
object
)
Returns the ownership of object .
另请参阅 setObjectOwnership ().
Returns the file path where a 本地存储 database with the identifier databaseName is (or would be) located.
该函数在 Qt 5.9 引入。
另请参阅 LocalStorage.openDatabaseSync ().
Returns true if warning messages will be output to stderr in addition to being emitted by the warnings () 信号，否则 false。
默认值为 true。
另请参阅 setOutputWarningsToStandardError ().
Returns the list of directories where the engine searches for native plugins for imported modules (referenced in the
qmldir
file).
By default, the list contains only
.
, i.e. the engine searches in the directory of the
qmldir
file itself.
另请参阅 addPluginPath () 和 setPluginPathList ().
Removes the image provider for providerId .
另请参阅 addImageProvider () 和 QQuickImageProvider .
返回引擎的根上下文。
The root context is automatically created by the QQmlEngine . Data that should be available to all QML component instances instantiated by the engine should be put in the root context.
Additional data that should only be available to a subset of component instances should be added to sub-contexts parented to the root context.
Set the base URL for this engine to url .
另请参阅 baseUrl ().
[static]
void
QQmlEngine::
setContextForObject
(
QObject
*
object
,
QQmlContext
*
context
)
设置 QQmlContext 为 object to context 。若 object already has a context, a warning is output, but the context is not changed.
当 QQmlEngine instantiates a QObject , the context is set automatically.
另请参阅 contextForObject ().
设置 paths as the list of directories where the engine searches for installed modules in a URL-based directory structure.
By default, the list contains the directory of the application executable, paths specified in the
QML2_IMPORT_PATH
environment variable, and the builtin
Qml2ImportsPath
from
QLibraryInfo
.
另请参阅 importPathList () 和 addImportPath ().
Sets the engine's incubation controller . The engine can only have one active controller and it does not take ownership of it.
另请参阅 incubationController ().
设置 factory to use for creating QNetworkAccessManager(s).
QNetworkAccessManager is used for all network access by QML. By implementing a factory it is possible to create custom QNetworkAccessManager with specialized caching, proxy and cookie support.
The factory must be set before executing the engine.
注意： QQmlEngine does not take ownership of the factory.
另请参阅 networkAccessManagerFactory ().
[static]
void
QQmlEngine::
setObjectOwnership
(
QObject
*
object
,
QQmlEngine::ObjectOwnership
ownership
)
设置 ownership of object .
另请参阅 objectOwnership ().
Set whether warning messages will be output to stderr to enabled .
若 enabled is true, any warning messages generated by QML will be output to stderr and emitted by the warnings () signal. If enabled is false, only the warnings () signal will be emitted. This allows applications to handle warning output themselves.
默认值为 true。
另请参阅 outputWarningsToStandardError ().
Sets the list of directories where the engine searches for native plugins for imported modules (referenced in the
qmldir
file) to
paths
.
By default, the list contains only
.
, i.e. the engine searches in the directory of the
qmldir
file itself.
另请参阅 pluginPathList () 和 addPluginPath ().
Returns the instance of a singleton type that was registered under qmlTypeId .
The template argument
T
may be either
QJSValue
or a pointer to a
QObject
-derived type and depends on how the singleton was registered. If no instance of
T
has been created yet, it is created now. If
qmlTypeId
does not represent a valid singleton type, either a default constructed
QJSValue
或
nullptr
被返回。
QObject * example:
class MySingleton : public QObject { Q_OBJECT // Register as default constructed singleton. QML_ELEMENT QML_SINGLETON static int typeId; // ... }; MySingleton::typeId = qmlTypeId(...); // Retrieve as QObject* QQmlEngine engine; MySingleton* instance = engine.singletonInstance<MySingleton*>(MySingleton::typeId);
QJSValue 范例：
// Register with QJSValue callback int typeId = qmlRegisterSingletonType(...); // Retrieve as QJSValue QQmlEngine engine; QJSValue instance = engine.singletonInstance<QJSValue>(typeId);
It is recommended to store the QML type id, e.g. as a static member in the singleton class. The lookup via qmlTypeId () is costly.
该函数在 Qt 5.12 引入。
另请参阅 QML_SINGLETON , qmlRegisterSingletonType ()，和 qmlTypeId ().
Trims the engine's internal component cache.
This function causes the property metadata of any loaded components which are not currently in use to be destroyed.
A component is considered to be in use if there are any extant instances of the component itself, any instances of other components that use the component, or any objects instantiated by any of those components.
另请参阅 clearComponentCache ().
The form of this template function is:
template<typename T> QObject *qmlAttachedPropertiesObject(const QObject *attachee, bool create = true)
This returns the attached object instance that has been attached to the specified attachee by the attaching type T .
若 create is true and type T is a valid attaching type, this creates and returns a new attached object instance.
Returns 0 if type T is not a valid attaching type, or if create is false and no attachment object instance has previously been created for attachee .
另请参阅 QML_ATTACHED () 和 Providing Attached Properties .
Clears all stored type registrations, such as those produced with qmlRegisterType ().
Do not call this function while a QQmlEngine exists or behavior will be undefined. Any existing QQmlEngines must be deleted before calling this function. This function only affects the application global cache. Delete the QQmlEngine to clear all cached data relating to that engine.
返回 QQmlContext associated with object , if any. This is equivalent to QQmlEngine::contextForObject (object).
注意：
Add
#include <QtQml>
to use this function.
另请参阅 contextForObject () 和 qmlEngine ().
返回 QQmlEngine associated with object , if any. This is equivalent to QQmlEngine::contextForObject (object)->engine(), but more efficient.
注意：
Add
#include <QtQml>
to use this function.
另请参阅 contextForObject () 和 qmlContext ().
This function protects a module from having types registered into it. This can be used to prevent other plugins from injecting types into your module. It can also be a performance improvement, as it allows the engine to skip checking for the possibility of new types or plugins when this import is reached.
The performance benefit is primarily seen when registering application specific types from within the application instead of through a plugin. Using qmlProtectModule allows the engine to skip checking for a plugin when that uri is imported, which can be noticeable with slow file systems.
After this function is called, any attempt to register C++ types into this uri, major version combination will lead to a runtime error. Call this after you have registered all of your types with the engine.
Returns true if the module with uri 作为 模块标识符 and majVersion as a major version number was found and locked, otherwise returns false. The module must contain exported types in order to be found.
This template function registers the C++ type in the QML system as an anonymous type. The resulting QML type does not have a name. Therefore, instances of this type cannot be created from the QML system. You can, however, access instances of the type when they are exposed as properties of other types.
Use this function when the type will not be referenced by name, specifically for C++ types that are used on the left-hand side of a property binding. To indicate to which module the type belongs use uri and versionMajor .
For example, consider the following two classes:
class Bar : public QObject { Q_OBJECT Q_PROPERTY(QString baz READ baz WRITE setBaz NOTIFY bazChanged) public: Bar() {} QString baz() const { return mBaz; } void setBaz(const QString &baz) { if (baz == mBaz) return; mBaz = baz; emit bazChanged(); } signals: void bazChanged(); private: QString mBaz; }; class Foo : public QObject { Q_OBJECT Q_PROPERTY(Bar *bar READ bar CONSTANT FINAL) public: Foo() {} Bar *bar() { return &mBar; } private: Bar mBar; };
In QML, we assign a string to the
baz
property of
bar
:
Foo {
bar.baz: "abc"
Component.onCompleted: print(bar.baz)
}
For the QML engine to know that the
Bar
类型拥有
baz
property, we have to make
Bar
known:
qmlRegisterType<Foo>("App", 1, 0, "Foo"); qmlRegisterAnonymousType<Bar>("App", 1);
As the
Foo
type is instantiated in QML, it must be registered with the version of
qmlRegisterType
() that takes an element name.
Returns the QML type id.
该函数在 Qt 5.14 引入。
另请参阅 QML_ANONYMOUS and Choosing the Correct Integration Method Between C++ and QML .
This template function registers the C++ type and its extension object in the QML system with the name qmlName in the library imported from uri having version number composed from versionMajor and versionMinor . Properties not available in the main type will be searched for in the extension object.
Returns the QML type id.
另请参阅 QML_EXTENDED (), qmlRegisterType ()，和 Registering Extension Objects .
This template function registers the C++ type and its extension in the QML system with the name qmlName in the library imported from uri having version number composed from versionMajor and versionMinor .
While the type has a name and a type, it cannot be created. An error message with the given reason is printed if the user attempts to create an instance of this type.
This is useful where the type is only intended for providing attached properties, enum values or an abstract base class with its extension.
Returns the QML type id.
另请参阅 QML_EXTENDED (), QML_UNCREATABLE ()，和 qmlRegisterUncreatableType ().
This template function registers the C++ type in the QML system under the name typeName .
Types registered as an interface with the engine should also declare themselves as an interface with the meta object system 。例如：
struct FooInterface { public: virtual ~FooInterface(); virtual void doSomething() = 0; }; Q_DECLARE_INTERFACE(FooInterface, "org.foo.FooInterface")
When registered with the QML engine in this way, they can be used as property types:
Q_PROPERTY (FooInterface *foo READ foo WRITE setFoo)
When you assign a
QObject
sub-class to this property, the QML engine does the interface cast to
FooInterface*
automatically.
Returns the QML type id.
另请参阅 QML_INTERFACE .
This function registers a module in a particular uri with a version specified in versionMajor and versionMinor .
This can be used to make a certain module version available, even if no types are registered for that version. This is particularly useful for keeping the versions of related modules in sync.
该函数在 Qt 5.9 引入。
This template function registers the specified revision of a C++ type in the QML system with the library imported from uri having the version number composed from versionMajor and versionMinor .
Returns the QML type id.
template<typename T, int metaObjectRevision> int qmlRegisterRevision(const char *uri, int versionMajor, int versionMinor);
This function is typically used to register the revision of a base class to use for the specified version of the type (see Type Revisions and Versions ).
This function is used to register a singleton object cppObject , with a particular uri and typeName . Its version is a combination of versionMajor and versionMinor .
Installing a singleton type into a URI allows you to provide arbitrary functionality (methods and properties) to QML code without requiring individual instances of the type to be instantiated by the client.
Use this function to register an object of the given type T as a singleton type.
A QObject singleton type may be referenced via the type name with which it was registered; in turn this type name may be used as the target in a Connections type, or like any other type ID. However, there's one exception: a QObject singleton type property can't be aliased because the singleton type name does not identify an object within the same component as any other item.
注意： cppObject must outlive the QML engine in which it is used. Moreover, cppObject must have the same thread affinity as the engine. If you want separate singleton instances for multiple engines, you need to use qmlRegisterSingletonType 。见 线程和 QObject for more information about thread safety.
用法：
// First, define your QObject which provides the functionality. class SingletonTypeExample : public QObject { Q_OBJECT Q_PROPERTY(int someProperty READ someProperty WRITE setSomeProperty NOTIFY somePropertyChanged) public: explicit SingletonTypeExample(QObject* parent = nullptr) : QObject(parent) {} Q_INVOKABLE int doSomething() { setSomeProperty(5); return m_someProperty; } int someProperty() const { return m_someProperty; } void setSomeProperty(int val) { if (m_someProperty != val) { m_someProperty = val; emit somePropertyChanged(val); } } signals: void somePropertyChanged(int newValue); private: int m_someProperty = 0; };
// Second, create an instance of the object // allocate example before the engine to ensure that it outlives it QScopedPointer<SingletonTypeExample> example(new SingletonTypeExample); QQmlEngine engine; // Third, register the singleton type provider with QML by calling this // function in an initialization function. qmlRegisterSingletonInstance("Qt.example.qobjectSingleton", 1, 0, "MyApi", example.get());
In order to use the registered singleton type in QML, you must import the URI with the corresponding version.
import QtQuick 2.0 import Qt.example.qobjectSingleton 1.0 Item { id: root property int someValue: MyApi.someProperty Component.onCompleted: { console.log(MyApi.doSomething()) } }
该函数在 Qt 5.14 引入。
另请参阅 QML_SINGLETON and qmlRegisterSingletonType .
This function may be used to register a singleton type provider callback in a particular uri and typeName with a version specified in versionMajor and versionMinor .
Installing a singleton type allows developers to provide arbitrary functionality (methods and properties) to a client without requiring individual instances of the type to be instantiated by the client.
A singleton type may be either a QObject 或 QJSValue . This function should be used to register a singleton type provider function which returns a QJSValue as a singleton type.
NOTE: QJSValue singleton type properties will not trigger binding re-evaluation if changed.
用法：
// First, define the singleton type provider function (callback). static QJSValue example_qjsvalue_singletontype_provider(QQmlEngine *engine, QJSEngine *scriptEngine) { Q_UNUSED(engine) static int seedValue = 5; QJSValue example = scriptEngine->newObject(); example.setProperty("someProperty", seedValue++); return example; } // Second, register the singleton type provider with QML by calling this function in an initialization function. qmlRegisterSingletonType("Qt.example.qjsvalueApi", 1, 0, "MyApi", example_qjsvalue_singletontype_provider);
Alternatively, you can use a C++11 lambda:
qmlRegisterSingletonType("Qt.example.qjsvalueApi", 1, 0, "MyApi", [](QQmlEngine *engine, QJSEngine *scriptEngine) -> QJSValue { Q_UNUSED(engine) static int seedValue = 5; QJSValue example = scriptEngine->newObject(); example.setProperty("someProperty", seedValue++); return example; });
In order to use the registered singleton type in QML, you must import the singleton type.
import QtQuick 2.0 import Qt.example.qjsvalueApi 1.0 as ExampleApi Item { id: root property int someValue: ExampleApi.MyApi.someProperty }
另请参阅 QML_SINGLETON and Choosing the Correct Integration Method Between C++ and QML .
This function may be used to register a singleton type provider callback in a particular uri and typeName with a version specified in versionMajor and versionMinor .
Installing a singleton type into a uri allows developers to provide arbitrary functionality (methods and properties) to clients without requiring individual instances ot the type to be instantiated by the client.
A singleton type may be either a QObject 或 QJSValue . This function should be used to register a singleton type provider function which returns a QObject of the given type T as a singleton type.
A QObject singleton type may be referenced via the type name with which it was registered, and this typename may be used as the target in a Connections type or otherwise used as any other type id would. One exception to this is that a QObject singleton type property may not be aliased.
NOTE: A QObject singleton type instance returned from a singleton type provider is owned by the QML engine unless the object has explicit QQmlEngine::CppOwnership flag set.
用法：
// First, define your QObject which provides the functionality. class SingletonTypeExample : public QObject { Q_OBJECT Q_PROPERTY (int someProperty READ someProperty WRITE setSomeProperty NOTIFY somePropertyChanged) public: SingletonTypeExample(QObject* parent = 0) : QObject(parent), m_someProperty(0) { } ~SingletonTypeExample() {} Q_INVOKABLE int doSomething() { setSomeProperty(5); return m_someProperty; } int someProperty() const { return m_someProperty; } void setSomeProperty(int val) { m_someProperty = val; emit somePropertyChanged(val); } signals: void somePropertyChanged(int newValue); private: int m_someProperty; }; // Second, define the singleton type provider function (callback). static QObject *example_qobject_singletontype_provider(QQmlEngine *engine, QJSEngine *scriptEngine) { Q_UNUSED(engine) Q_UNUSED(scriptEngine) SingletonTypeExample *example = new SingletonTypeExample(); return example; } // Third, register the singleton type provider with QML by calling this function in an initialization function. qmlRegisterSingletonType<SingletonTypeExample>("Qt.example.qobjectSingleton", 1, 0, "MyApi", example_qobject_singletontype_provider);
Alternatively, you can use a C++11 lambda:
qmlRegisterSingletonType<SingletonTypeExample>("Qt.example.qobjectSingleton", 1, 0, "MyApi", [](QQmlEngine *engine, QJSEngine *scriptEngine) -> QObject * { Q_UNUSED(engine) Q_UNUSED(scriptEngine) SingletonTypeExample *example = new SingletonTypeExample(); return example; });
In order to use the registered singleton type in QML, you must import the singleton type.
import QtQuick 2.0 import Qt.example.qobjectSingleton 1.0 Item { id: root property int someValue: MyApi.someProperty Component.onCompleted: { someValue = MyApi.doSomething() } }
另请参阅 QML_SINGLETON and Choosing the Correct Integration Method Between C++ and QML .
This function overloads qmlRegisterSingletonType.
该函数在 Qt 5.14 引入。
This function may be used to register a singleton type with the name qmlName , in the library imported from uri having the version number composed from versionMajor and versionMinor . The type is defined by the QML file located at url . The url must be an absolute URL, i.e. url.isRelative() == false.
In addition the type's QML file must have pragma Singleton statement among its import statements.
A singleton type may be referenced via the type name with which it was registered, and this typename may be used as the target in a Connections type or otherwise used as any other type id would. One exception to this is that a singleton type property may not be aliased (because the singleton type name does not identify an object within the same component as any other item).
用法：
// First, define your QML singleton type which provides the functionality. pragma Singleton import QtQuick 2.0 Item { property int testProp1: 125 }
// Second, register the QML singleton type by calling this function in an initialization function. qmlRegisterSingletonType(QUrl("file:///absolute/path/SingletonType.qml"), "Qt.example.qobjectSingleton", 1, 0, "RegisteredSingleton");
In order to use the registered singleton type in QML, you must import the singleton type.
import QtQuick 2.0 import Qt.example.qobjectSingleton 1.0 Item { id: root property int someValue: RegisteredSingleton.testProp1 }
It is also possible to have QML singleton types registered without using the qmlRegisterSingletonType function. That can be done by adding a pragma Singleton statement among the imports of the type's QML file. In addition the type must be defined in a qmldir file with a singleton keyword and the qmldir must be imported by the QML files using the singleton.
另请参阅 QML_SINGLETON .
This template function registers the C++ type in the QML system with the name qmlName , in the library imported from uri having the version number composed from versionMajor and versionMinor .
Returns the QML type id.
There are two forms of this template function:
template<typename T> int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const char *qmlName); template<typename T, int metaObjectRevision> int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const char *qmlName);
The former is the standard form which registers the type T as a new type. The latter allows a particular revision of a class to be registered in a specified version (see Type Revisions and Versions ).
For example, this registers a C++ class
MySliderItem
as a QML type named
Slider
for version 1.0 of a type namespace called "com.mycompany.qmlcomponents":
qmlRegisterType<MySliderItem>("com.mycompany.qmlcomponents", 1, 0, "Slider");
Once this is registered, the type can be used in QML by importing the specified type namespace and version number:
import com.mycompany.qmlcomponents 1.0 Slider { // ... }
Note that it's perfectly reasonable for a library to register types to older versions than the actual version of the library. Indeed, it is normal for the new library to allow QML written to previous versions to continue to work, even if more advanced versions of some of its types are available.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT ()，和 Choosing the Correct Integration Method Between C++ and QML .
This function registers a type in the QML system with the name qmlName , in the library imported from uri having the version number composed from versionMajor and versionMinor . The type is defined by the QML file located at url . The url must be an absolute URL, i.e. url.isRelative() == false.
Normally QML files can be loaded as types directly from other QML files, or using a qmldir file. This function allows registration of files to types from C++ code, such as when the type mapping needs to be procedurally determined at startup.
Returns -1 if the registration was not successful.
This function registers a type in the QML system with the name qmlName , in the type namespace imported from uri having the version number composed from versionMajor and versionMinor , but any attempt to instantiate the type will produce the given error message .
Normally, the types exported by a plugin should be fixed. However, if a C++ type is not available, you should at least "reserve" the QML type name, and give the user of the unavailable type a meaningful error message.
Returns the QML type id.
范例：
#ifdef NO_GAMES_ALLOWED qmlRegisterTypeNotAvailable("MinehuntCore", 0, 1, "Game", "Get back to work, slacker!"); #else qmlRegisterType<MinehuntGame>("MinehuntCore", 0, 1, "Game"); #endif
This will cause any QML which imports the "MinehuntCore" type namespace and attempts to use the type to produce an error message:
fun.qml: Get back to work, slacker! Game { ^
Without this, a generic "Game is not a type" message would be given.
另请参阅 QML_UNAVAILABLE , qmlRegisterUncreatableType ()，和 Choosing the Correct Integration Method Between C++ and QML .
This function registers the staticMetaObject and its extension in the QML system with the name qmlName in the library imported from uri having version number composed from versionMajor and versionMinor .
An instance of the meta object cannot be created. An error message with the given reason is printed if the user attempts to create it.
This function is useful for registering Q_NAMESPACE namespaces.
Returns the QML type id.
例如：
namespace MyNamespace { Q_NAMESPACE enum MyEnum { Key1, Key2, }; Q_ENUMS(MyEnum) } //... qmlRegisterUncreatableMetaObject(MyNamespace::staticMetaObject, "io.qt", 1, 0, "MyNamespace", "Access to enums & flags only");
On the QML side, you can now use the registered enums:
Component.onCompleted: console.log(MyNamespace.Key2)
该函数在 Qt 5.8 引入。
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT ()，和 QML_UNCREATABLE ().
This template function registers the C++ type in the QML system with the name qmlName , in the library imported from uri having the version number composed from versionMajor and versionMinor .
While the type has a name and a type, it cannot be created, and the given error message will result if creation is attempted.
This is useful where the type is only intended for providing attached properties or enum values.
Returns the QML type id.
另请参阅 QML_UNCREATABLE (), qmlRegisterTypeNotAvailable ()，和 Choosing the Correct Integration Method Between C++ and QML .
Returns the QML type id of a type that was registered with the name qmlName in a particular uri and a version specified in versionMajor and versionMinor .
This function returns the same value as the QML type registration functions such as qmlRegisterType() and qmlRegisterSingletonType ().
若 qmlName , uri and versionMajor match a registered type, but the specified minor version in 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.
该函数在 Qt 5.12 引入。
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT , QML_SINGLETON , qmlRegisterType ()，和 qmlRegisterSingletonType ().
Declares that the enclosing type or namespace was added in the specified minor VERSION , relative to the module major version. The minor version is assumed to be in line with any revisions given by Q_REVISION () macros on methods, slots, or signals, and any REVISION tags on properties declared with Q_PROPERTY ().
QML_ADDED_IN_MINOR_VERSION() only takes effect if the type or namespace is available in QML, by having a QML_ELEMENT , QML_NAMED_ELEMENT (), QML_ANONYMOUS ，或 QML_INTERFACE 宏。
If the QML module the type belongs to is imported with a lower version than the one determined this way, the QML type is invisible.
另请参阅 QML_ELEMENT and QML_NAMED_ELEMENT ().
Declares the enclosing type to be available, but anonymous in QML. The type cannot be created or used as property type, but when passed from C++, it is recognized.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT (), QML_UNCREATABLE ()，和 QML_INTERFACE .
Declares that the enclosing type attaches ATTACHED_TYPE as an attached property to other types. This takes effect if the type is exposed to QML using a QML_ELEMENT or QML_NAMED_ELEMENT () 宏。
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT (), qmlAttachedPropertiesObject ()，和 Providing Attached Properties .
相当于
Q_DECLARE_METATYPE(TYPE *)
and
Q_DECLARE_METATYPE(QQmlListProperty<TYPE>)
Declares additional properties of the given Type as described by the specified Flags .
Current the only supported type info is
QML_HAS_ATTACHED_PROPERTIES
which declares that the
Type
supports
attached properties
. QML_DECLARE_TYPEINFO() is not necessary if
Type
contains the
QML_ATTACHED
宏。
Declares the enclosing type or namespace to be available in QML, using its class or namespace name as the QML element name.
For example, this makes the C++ class
Slider
available as a QML type named
Slider
.
class Slider : public QObject { Q_OBJECT QML_ELEMENT ... }
You can use the build system to register the type in the type namespace
com.mycompany.qmlcomponents
with major version
1
by specifying the following in your project file:
CONFIG += qmltypes QML_IMPORT_NAME = com.mycompany.qmlcomponents QML_IMPORT_MAJOR_VERSION = 1
Once registered, the type can be used in QML by importing the same type namespace and version number:
import com.mycompany.qmlcomponents 1.0 Slider { // ... }
You can also make namespaces tagged with Q_NAMESPACE available this way, in order to expose any enums tagged with Q_ENUM_NS they contain.
另请参阅 Choosing the Correct Integration Method Between C++ and QML , QML_NAMED_ELEMENT (), Q_REVISION ()，和 QML_ADDED_IN_MINOR_VERSION ().
Declares that the enclosing type uses EXTENDED_TYPE as an extension to provide further properties and methods in QML. This takes effect if the type is exposed to QML using a QML_ELEMENT or QML_NAMED_ELEMENT () 宏。
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT ()，和 Registering Extension Objects .
Declares that any QML_ELEMENT , QML_NAMED_ELEMENT (), QML_ANONYMOUS , QML_INTERFACE , QML_UNCREATABLE (), QML_SINGLETON , QML_ADDED_IN_MINOR_VERSION (), QML_REMOVED_IN_MINOR_VERSION (), QML_ATTACHED ()，或 QML_EXTENDED () macros in the enclosing C++ type do not apply to the enclosing type but instead to FOREIGN_TYPE . The enclosing type still needs to be registered with the meta object system 使用 Q_GADGET or Q_OBJECT 宏。
This is useful for registering types that cannot be amended to add the macros, for example because they belong to 3rdparty libraries.
另请参阅 QML_ELEMENT and QML_NAMED_ELEMENT ().
This macro registers the enclosing C++ type in the QML system as an interface.
Types registered as an interface in QML should also declare themselves as an interface with the meta object system 。例如：
struct FooInterface { QML_INTERFACE public: virtual ~FooInterface(); virtual void doSomething() = 0; }; Q_DECLARE_INTERFACE(FooInterface, "org.foo.FooInterface")
When registered with QML in this way, they can be used as property types:
Q_PROPERTY (FooInterface *foo READ foo WRITE setFoo)
When you assign a
QObject
sub-class to this property, the QML engine does the interface cast to
FooInterface*
automatically.
Interface types are implicitly anonymous and uncreatable in QML.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT (), QML_UNCREATABLE ()，和 QML_ANONYMOUS .
Declares the enclosing type or namespace to be available in QML, using name as the element name. Otherwise behaves the same as QML_ELEMENT .
class SqlEventDatabase : public QObject { Q_OBJECT QML_NAMED_ELEMENT(EventDatabase) // ... };
另请参阅 Choosing the Correct Integration Method Between C++ and QML and QML_ELEMENT .
Declares that the enclosing type or namespace was removed in the specified minor VERSION , relative to the module major version. This is primarily useful when replacing the implementation of a QML type. If a corresponding QML_ADDED_IN_MINOR_VERSION () is present on a different type or namespace of the same QML name, then the removed type is used when importing versions of the module lower than VERSION , and the added type is used when importing versions of the module greater or equal VERSION .
QML_REMOVED_IN_MINOR_VERSION() only takes effect if type or namespace is available in QML, by having a QML_ELEMENT , QML_NAMED_ELEMENT (), QML_ANONYMOUS ，或 QML_INTERFACE 宏。
另请参阅 QML_ELEMENT and QML_NAMED_ELEMENT ().
Declares the enclosing type to be a singleton in QML. This only takes effect if the type is available in QML, by having a QML_ELEMENT or QML_NAMED_ELEMENT () macro. By default, each QQmlEngine will try to create a singleton instance using the type's default constructor when the type is first accessed. If there is no default constructor the singleton is initially inaccessible. This behavior can be overridden by calling qmlRegisterSingletonType () with a specific factory function or qmlRegisterSingletonInstance () with a specific instance for the same class and the same type namespace and version.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT ()，和 qmlRegisterSingletonInstance ().
This macro declares the enclosing type to be unavailable in QML. It registers an internal dummy type called
QQmlTypeNotAvailable
as
QML_FOREIGN
() type, using any further QML macros you specify.
Normally, the types exported by a module should be fixed. However, if a C++ type is not available, you should at least "reserve" the QML type name, and give the user of the unavailable type a meaningful error message.
范例：
#ifdef NO_GAMES_ALLOWED struct MinehuntGame { Q_GADGET QML_NAMED_ELEMENT(Game) QML_UNAVAILABLE QML_UNCREATABLE("Get back to work, slacker!"); }; #else class MinehuntGame : public QObject { Q_OBJECT QML_NAMED_ELEMENT(Game) // ... }; #endif
This will cause any QML which attempts to use the "Game" type to produce an error message:
fun.qml: Get back to work, slacker!
Game {
^
Using this technique, you only need a Q_GADGET struct to customize the error message, not a full-blown QObject . Without QML_UNCREATABLE (), QML_UNAVAILABLE still results in a more specific error message than the usual "is not a type" for completely unknown types.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT (), QML_UNCREATABLE ()，和 QML_FOREIGN ().
Declares that the enclosing type shall not be creatable from QML. This takes effect if the type is available in QML, by having a QML_ELEMENT or QML_NAMED_ELEMENT () macro. The reason will be emitted as error message if an attempt to create the type from QML is detected.
Some QML types are implicitly uncreatable, in particular types exposed with QML_ANONYMOUS or namespaces exposed with QML_ELEMENT or QML_NAMED_ELEMENT (). For such types, QML_UNCREATABLE() can be used to provide a custom error message.
另请参阅 QML_ELEMENT , QML_NAMED_ELEMENT ()，和 QML_ANONYMOUS .