Заявления import

Синтаксис оператора import

Оператор import позволяет клиенту указать движку, какие модули, JavaScript-ресурсы и каталоги компонентов используются в документе QML. Типы, которые могут быть использованы в документе, зависят от того, какие модули, ресурсы и каталоги импортированы в документ.

Типы импорта

Существует три различных типа импорта. Каждый тип импорта имеет немного отличающийся синтаксис, и разные семантики применяются к разным типам импорта.

Импорт модулей (пространств имен)

Наиболее распространенный тип импорта — импорт модуля. Клиенты могут импортировать QML-модули, которые регистрируют типы QML-объектов и JavaScript-ресурсы в заданном пространстве имен.

Общий вид импорта модуля:

import <ModuleIdentifier> <Version.Number> [as <Qualifier>]

• <ModuleIdentifier> — это идентификатор, заданный в обозначении URI с точкой, который однозначно идентифицирует пространство имен типов, предоставляемое модулем.
• <Version.Number> — это версия в формате MajorVersion.MinorVersion, которая определяет, какие определения различных типов объектов и JavaScript-ресурсов будут доступны из-за импорта.
• <Qualifier> — это необязательный локальный идентификатор пространства имен, в который будут установлены типы объектов и JavaScript-ресурсы, предоставляемые модулем, если он указан. Если он опущен, типы объектов и JavaScript-ресурсы, предоставляемые модулем, будут установлены в глобальное пространство имен.

Пример импорта модуля без квалификатора:

import QtQuick 2.0

Этот импорт позволяет использовать все типы, предоставляемые модулем QtQuick, без необходимости указывать квалификатор. Например, следующий код клиента создает прямоугольник:

import QtQuick 2.0

Rectangle {
    width: 200
    height: 100
    color: "red"
}

Пример импорта модуля с квалификатором:

import QtQuick 2.0 as Quick

Этот импорт позволяет импортировать несколько модулей, предоставляющих конфликтующие имена типов, одновременно, однако, так как каждое использование типа, предоставляемого модулем, импортированным в квалифицированное пространство имен, должно предваряться квалификатором, конфликт может быть однозначно разрешен QML-движком.

Пример кода клиента, который создаёт прямоугольник после использования квалифицированного импорта модуля:

import QtQuick 2.0 as Quick

Quick.Rectangle {
    width: 200
    height: 100
    color: "red"
}

Дополнительную информацию об импорте с квалификатором см. в следующем разделе Импорт в квалифицированное локальное пространство имен.

Обратите внимание, что если документ QML не импортирует модуль, который предоставляет определенный тип QML-объекта, но пытается использовать этот тип, произойдет ошибка. Например, следующий QML-документ не импортирует QtQuick, и попытка использовать тип Rectangle завершится ошибкой:

Rectangle {
    width: 200
    height: 100
    color: "red"
}

В этом случае движок сгенерирует ошибку и откажется загрузить файл.

Импорт пространств имен, не являющихся модулями

Типы также могут быть зарегистрированы в пространствах имен напрямую с помощью различных функций регистрации в C++ (таких как qmlRegisterType()). Типы, которые были зарегистрированы в пространстве имен таким способом, могут быть импортированы путём импорта пространства имён, как если бы пространство имён было идентификатором модуля.

Это наиболее распространено в приложениях-клиентах, которые определяют собственные типы QML-объектов в C++ и регистрируют их в QML-системе типов вручную.

Импорт в квалифицированное локальное пространство имен

Оператор import может необязательно использовать ключевое слово as, чтобы указать, что типы должны быть импортированы в определённое локальное пространство имен документа. Если пространство имен задано, любые ссылки на типы, доступные посредством импорта, должны предваряться квалификатором локального пространства имён.

Ниже, модуль QtQuick импортируется в пространство имен "CoreItems". Теперь любые ссылки на типы из модуля QtQuick должны предваряться именем CoreItems:

import QtQuick 2.0 as CoreItems

CoreItems.Rectangle {
    width: 100; height: 100

    CoreItems.Text { text: "Hello, world!" }

    // WRONG! No namespace prefix - the Text type won't be found
    Text { text: "Hello, world!" }
}

Пространство имен служит идентификатором модуля в рамках файла. Пространство имен не становится атрибутом корневого объекта, на который можно ссылаться извне, как это можно сделать с помощью свойств, сигналов и методов.

Использование импорта с пространством имен полезно, если требуется использовать два QML-типа с одинаковым именем, но расположенные в разных модулях. В этом случае два модуля можно импортировать в разные пространства имен, чтобы гарантировать, что код ссылается на правильный тип:

import QtQuick 2.0 as CoreItems
import "../textwidgets" as MyModule

CoreItems.Rectangle {
    width: 100; height: 100

    MyModule.Text { text: "Hello from my custom text item!" }
    CoreItems.Text { text: "Hello from Qt Quick!" }
}

Обратите внимание, что несколько модулей могут быть импортированы в одно и то же пространство имен так же, как несколько модулей могут быть импортированы в глобальное пространство имен. Например:

import QtQuick 2.0 as Project
import QtMultimedia 5.0 as Project

Project.Rectangle {
    width: 100; height: 50

    Project.Audio {
        source: "music.wav"
        autoPlay: true
    }
}

Импорт каталогов

Каталог, содержащий QML-документы, также может быть импортирован непосредственно в QML-документ. Это предоставляет простой способ сегментации QML-типов в многократно используемые группы: каталоги на файловой системе.

Общий вид импорта каталога:

import "<DirectoryPath>" [as <Qualifier>]

Примечание: Пути импорта прозрачны к сети: приложения могут импортировать документы из удаленных путей так же просто, как и из локальных путей. См. общие правила разрешения URL для прозрачности сети в QML-документах. Если каталог удалённый, он должен содержать файл каталожный файл qmldir, так как QML-движок не может определить содержимое удалённого каталога, если этот qmldir файл не существует.

Аналогичная семантика для <Qualifier> применяется к импорту каталогов, как и для импорта модулей; для получения дополнительной информации по этой теме см. предыдущий раздел Импорт в квалифицированное локальное пространство имен.

Для получения дополнительной информации об импорте каталогов см. подробную документацию по импорту каталогов.

Импорт JavaScript-ресурсов

JavaScript-ресурсы могут быть импортированы непосредственно в QML-документ. Каждый JavaScript-ресурс должен иметь идентификатор, с помощью которого к нему обращаются.

Общий вид импорта JavaScript-ресурса:

import "<JavaScriptFile>" as <Identifier>

Обратите внимание, что <Identifier> должен быть уникальным в QML-документе, в отличие от локального квалификатора пространства имен, который может быть применён к импорту модулей.

JavaScript-ресурсы из модулей

JavaScript-файлы могут предоставляться модулями, добавляя определения идентификаторов в файл qmldir, который определяет модуль.

Например, если модуль projects.MyQMLProject.MyFunctions задан с помощью следующего файла qmldir и установлен в QML-путь импорта:

module projects.MyQMLProject.MyFunctions
SystemFunctions 1.0 SystemFunctions.js
UserFunctions 1.0 UserFunctions.js

приложение-клиент может импортировать JavaScript-ресурсы, объявленные в модуле, импортировав модуль и используя идентификатор, связанный с объявленным ресурсом:

import QtQuick 2.0
import projects.MyQMLProject.MyFunctions 1.0

Item {
    Component.onCompleted: { SystemFunctions.cleanUp(); }
}

Если модуль был импортирован в локальное пространство имен документа, идентификаторы JavaScript-ресурсов должны быть предварены квалификатором пространства имен для их использования:

import QtQuick 2.0
import projects.MyQMLProject.MyFunctions 1.0 as MyFuncs
import org.example.Functions 1.0 as TheirFuncs

Item {
    Component.onCompleted: {
        MyFuncs.SystemFunctions.cleanUp();
        TheirFuncs.SystemFunctions.shutdown();
    }
}

Дополнительная информация

Дополнительную информацию о JavaScript-ресурсах см. в документации по определению JavaScript-ресурсов в QML, а дополнительную информацию об импорте JavaScript-ресурсов и о том, как импорты могут использоваться из JavaScript-ресурсов, см. в подробной документации по импорту JavaScript-ресурсов в QML.

QML-путь импорта

При импорте идентифицированного модуля QML-движок ищет соответствующий модуль в пути импорта.

Этот путь импорта, возвращаемый QQmlEngine::importPathList(), определяет стандартные места поиска модуля движком. По умолчанию этот список содержит:

• Директорию текущего файла
• Расположение, указанное в QLibraryInfo::Qml2ImportsPath
• Пути, указанные переменной окружения QML2_IMPORT_PATH

Дополнительные пути импорта можно добавить с помощью QQmlEngine::addImportPath() или переменной окружения QML2_IMPORT_PATH. При запуске инструмента qmlscene также можно использовать параметр -I для добавления пути импорта.

Отладка

Переменная окружения QML_IMPORT_TRACE может быть полезна для отладки при проблемах с поиском и загрузкой модулей. Дополнительную информацию см. в разделе Отладка импорта модулей.