Module Definition qmldir Files

module <ModuleIdentifier>
								

Declares the module identifier of the module. The <ModuleIdentifier> is the (dotted URI notation) identifier for the module, which must match the module's install path.

模块标识符指令 must be the first line of the file. Exactly one module identifier directive may exist in the qmldir 文件。

范例：

module ExampleModule
								

[singleton] <TypeName> <InitialVersion> <File>
								

• [singleton] Optional. Used to declare a singleton type.
• <TypeName> is the type being made available
• <InitialVersion> is the module version for which the type is to be made available
• <File> is the (relative) file name of the QML file that defines the type

Zero or more object type declarations may exist in the qmldir file, however each object type must have a unique type name within any particular version of the module.

注意： To declare a singleton type, the QML file defining the type must include the pragma Singleton 语句。

范例：

//Style.qml with custom singleton type definition
pragma Singleton
import QtQuick 2.0
QtObject {
    property int textSize: 20
    property color textColor: "green"
}
// qmldir declaring the singleton type
module CustomStyles
singleton Style 1.0 Style.qml
// singleton type in use
import QtQuick 2.0
import CustomStyles 1.0
Text {
    font.pixelSize: Style.textSize
    color: Style.textColor
    text: "Hello World"
}
								

internal <TypeName> <File>
								

Declares an object type that is in the module but should not be made available to users of the module.

Zero or more internal object type declarations may exist in the qmldir 文件。

范例：

internal MyPrivateType MyPrivateType.qml
								

This is necessary if the module may be imported remotely (see 远程安装识别模块 ) because if an exported type depends on an non-exported type within the module, the engine must also load the non-exported type.

<ResourceIdentifier> <InitialVersion> <File>
									

Declares a JavaScript file to be made available by the module. The resource will be made available via the specified identifier with the specified version number.

Zero or more JavaScript resource declarations may exist in the qmldir file, however each JavaScript resource must have a unique identifier within any particular version of the module.

范例：

MyScript 1.0 MyScript.js
									

See the documentation about defining JavaScript resources and 在 QML 导入 JavaScript 资源 了解更多信息。

[optional] plugin <Name> [<Path>]
										

• optional denotes that the plugin itself does not contain any relevant code and only serves to load a library it links to. If given, and if any types for the module are already available, indicating that the library has been loaded by some other means, QML will not load the plugin.
• <Name> is the plugin library name. This is usually not the same as the file name of the plugin binary, which is platform dependent; e.g. the library MyAppTypes would produce libMyAppTypes.so on Linux and MyAppTypes.dll 在 Windows。
• <Path> (optional) specifies either:
  • an absolute path to the directory containing the plugin file, or
  • a relative path from the directory containing the qmldir file to the directory containing the plugin file.

  By default the engine searches for the plugin library in the directory that contains the qmldir file. (The plugin search path can be queried with QQmlEngine::pluginPathList () and modified using QQmlEngine::addPluginPath ().)

Zero or more C++ plugin declarations may exist in the qmldir file, however since plugin loading is a relatively expensive operation, clients are advised to specify at most a single plugin.

范例：

plugin MyPluginLibrary
										

classname <C++ plugin class>
										

Provides the class name of the C++ plugin used by the module.

This information is required for all the QML modules that depend on a C++ plugin for additional functionality. Qt Quick applications built with static linking cannot resolve the module imports without this information.

typeinfo <File>
										

范例：

typeinfo mymodule.qmltypes
									

Without such a file, QML tools may be unable to offer features such as code completion for the types defined in your plugins.

depends <ModuleIdentifier> <InitialVersion>
									

Declares that this module depends on another.

范例：

depends MyOtherModule 1.0
									

This declaration is necessary only in cases when the dependency is hidden: for example, when the C++ code for one module is used to load QML (perhaps conditionally) which then depends on other modules. In such cases, the depends declaration is necessary to include the other modules in application packages.

import <ModuleIdentifier> [<Version>]
										

Declares that this module imports another.

范例：

import MyOtherModule 1.0
										

The types from the other module are made available in the same type namespace as this module is imported into. Omitting the version imports the latest version available of the other module, specifying auto as version imports the same version as the version of this module specified in the QML import 语句。

# <Comment>
											

Declares a comment. These are ignored by the engine.

范例：

# this is a comment
											

designersupported
											

Set this property if the plugin is supported by Qt Quick Designer. By default, the plugin will not be supported.

A plugin that is supported by Qt Quick Designer has to be properly tested. This means that the plugin does not crash when running inside the qml2puppet that is used by Qt Quick Designer to execute QML. Generally the plugin should work well in the Qt Quick Designer and not cause any show stoppers, like taking huge amounts of memory, slowing down the qml2puppet heavily or anything else that renders the plugin effectively unusable in the Qt Quick Designer.

The items of an unsupported plugin are not painted in the Qt Quick Designer, but they are still available as empty boxes and the properties can be edited.

prefer <Path>
											

This property directs the QML engine to load any further files for this module from <path>, rather than the current directory. This can be used to load files compiled with qmlcachegen.

For example, you can add a module's QML files as resources to a resource path :/my/path/MyModule/ . Then, add prefer :/my/path/MyModule to the qmldir file in order to use the files in the resource system, rather than the ones in the file system. If you then use qmlcachegen for those, the pre-compiled files will be available to any clients of the module.