Заявления импорта

Синтаксис заявления импорта

Заявление импорта позволяет клиентам указать движку, какие модули, 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++ модулей

Обычно типы C++ объявляются с помощью макросов QML_ELEMENT и QML_NAMED_ELEMENT() и регистрируются через систему сборки с помощью QML_IMPORT_NAME и QML_IMPORT_MAJOR_VERSION. Имя и версия импорта, указанные таким образом, образуют модуль, который можно импортировать для доступа к типам.

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

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

Заявление 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-документах. Если каталог удалённый, он должен содержать файл directory import listing qmldir, так как QML-движок не может определить содержимое удалённого каталога, если этот файл не существует.

Аналогичные семантики для <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
• Путь qrc:/qt-project.org/imports внутри ресурсов.

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

Вы можете указать несколько путей импорта в переменной среды QML2_IMPORT_PATH путем их объединения с разделителем путей. В Windows разделителем является точка с запятой (;), на других платформах — двоеточие (:). Это означает, что вы не можете указать пути к ресурсам или URL-адреса в QML2_IMPORT_PATH, так как они содержат двоеточия. Однако вы можете добавить пути к ресурсам и URL-адреса, вызвав QQmlEngine::addImportPath() программно.

Отладка

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