Динамическое создание QML-объектов из JavaScript

QML поддерживает динамическое создание объектов из JavaScript. Это полезно для отсрочки инициализации объектов до необходимости, тем самым улучшая время запуска приложения. Также это позволяет динамически создавать визуальные объекты и добавлять их в сцену в ответ на пользовательский ввод или другие события.

См. пример Динамической сцены для демонстрации концепций, обсуждаемых на этой странице.

Динамическое создание объектов

Существует два способа создания объектов динамически из JavaScript. Вы можете вызвать Qt.createComponent() для динамического создания объекта Component или использовать Qt.createQmlObject() для создания объекта из строки QML. Создание компонента предпочтительнее, если у вас уже определён компонент в документе QML, и вы хотите динамически создавать экземпляры этого компонента. В противном случае, создание объекта из строки QML полезно, когда сам QML-объект генерируется во время выполнения.

Динамическое создание компонента

Для динамической загрузки компонента, определённого в файле QML, вызовите функцию Qt.createComponent() в объекте Qt. Эта функция принимает URL файла QML в качестве единственного аргумента и создаёт объект Component из этого URL.

После получения объекта Component, вы можете вызвать его метод createObject() для создания экземпляра компонента. Эта функция может принимать один или два аргумента:

• Первый аргумент — родительский объект для нового объекта. Родитель может быть графическим объектом (например, типа Item) или неграфическим объектом (например, типа QtObject или C++ QObject). Только графические объекты с графическими родительскими объектами будут отображаться на визуальной канве Qt Quick. Если вы хотите установить родителя позже, вы можете безопасно передать null в эту функцию.
• Второй аргумент является необязательным и представляет собой карту пар «свойство-значение», определяющих начальные значения свойств объекта. Значения свойств, указанные в этом аргументе, применяются к объекту до завершения его создания, предотвращая ошибки привязки, которые могут возникнуть, если определённые свойства должны быть инициализированы для включения других привязок свойств. Кроме того, существуют небольшие преимущества производительности по сравнению с определением значений свойств и привязок после создания объекта.

Вот пример. Сначала есть Sprite.qml, который определяет простой QML-компонент:

import QtQuick 2.0

Rectangle { width: 80; height: 50; color: "red" }

Наш основной файл приложения, main.qml, импортирует файл JavaScript componentCreation.js, который будет создавать объекты Sprite.

import QtQuick 2.0
import "componentCreation.js" as MyScript

Rectangle {
    id: appWindow
    width: 300; height: 300

    Component.onCompleted: MyScript.createSpriteObjects();
}

Вот componentCreation.js. Обратите внимание, что он проверяет, является ли статус компонента status Component.Ready, прежде чем вызывать createObject(), на случай, если файл QML загружается через сеть и, следовательно, не готов сразу.

var component;
var sprite;

function createSpriteObjects() {
    component = Qt.createComponent("Sprite.qml");
    if (component.status == Component.Ready)
        finishCreation();
    else
        component.statusChanged.connect(finishCreation);
}

function finishCreation() {
    if (component.status == Component.Ready) {
        sprite = component.createObject(appWindow, {"x": 100, "y": 100});
        if (sprite == null) {
            // Error Handling
            console.log("Error creating object");
        }
    } else if (component.status == Component.Error) {
        // Error Handling
        console.log("Error loading component:", component.errorString());
    }
}

Если вы уверены, что загружаемый файл QML является локальным файлом, вы можете опустить функцию finishCreation() и вызвать createObject() сразу:

function createSpriteObjects() {
    component = Qt.createComponent("Sprite.qml");
    sprite = component.createObject(appWindow, {"x": 100, "y": 100});

    if (sprite == null) {
        // Error Handling
        console.log("Error creating object");
    }
}

Обратите внимание, что в обоих случаях createObject() вызывается с appWindow в качестве аргумента родителя, так как динамически создаваемый объект является визуальным (Qt Quick) объектом. Созданный объект станет потомком объекта appWindow в main.qml, и появится в сцене.

При использовании файлов с относительными путями, путь должен быть относительным к файлу, в котором выполняется Qt.createComponent().

Для подключения сигналов к (или получения сигналов от) динамически созданных объектов используйте метод сигнала connect(). См. Подключение сигналов к методам и сигналам для получения дополнительной информации.

Также возможно создание экземпляров компонентов без блокировки с помощью функции incubateObject().

Создание объекта из строки QML

Если QML не определён до времени выполнения, вы можете создать QML-объект из строки QML, используя функцию Qt.createQmlObject(), как в следующем примере:

var newObject = Qt.createQmlObject('import QtQuick 2.0; Rectangle {color: "red"; width: 20; height: 20}',
                                   parentItem,
                                   "dynamicSnippet1");

Первый аргумент — строка QML для создания. Как и в новом файле, вам потребуется импортировать любые типы, которые вы хотите использовать. Второй аргумент — родительский объект для нового объекта, а семантика аргумента родителя, применимые к компонентам, аналогично применимы к createQmlObject(). Третий аргумент — путь к файлу, который необходимо связать с новым объектом; он используется для вывода сообщений об ошибках.

Если строка QML импортирует файлы с относительными путями, путь должен быть относительным к файлу, в котором определён родительский объект (второй аргумент метода).

Важно: При построении статических QML-приложений файлы QML сканируются для определения зависимостей импорта. Таким образом, все необходимые плагины и ресурсы разрешаются на этапе компиляции. Однако учитываются только явные инструкции импорта (те, которые находятся в начале файла QML), а не инструкции импорта, заключённые в строковые литералы. Чтобы поддерживать статическую сборку, необходимо убедиться, что файлы QML, использующие Qt.createQmlObject(), содержат все необходимые импорты в начале файла в дополнение к строковым литералам.

Поддержание динамически созданных объектов

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

Фактический контекст создания зависит от того, как создаётся объект:

• Если используется Qt.createComponent(), контекст создания — это QQmlContext, в котором вызывается этот метод
• Если вызван Qt.createQmlObject(), контекст создания — это контекст родительского объекта, переданного в этот метод
• Если объект Component{} определён и вызывается createObject() или incubateObject() для этого объекта, контекст создания — это контекст, в котором определён Component

Также обратите внимание, что, хотя динамически созданные объекты могут использоваться так же, как и другие объекты, у них нет идентификатора в QML.

Удаление объектов динамически

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

Обратите внимание, что вы никогда не должны удалять объекты, которые были динамически созданы удобными фабриками QML-объектов (такими как Loader и Repeater). Также следует избегать удаления объектов, которые вы сами не создавали динамически.

Объекты можно удалить, используя метод destroy(). Этот метод имеет необязательный аргумент (по умолчанию 0), который указывает приблизительную задержку в миллисекундах перед уничтожением объекта.

Вот пример. application.qml создаёт пять экземпляров компонента SelfDestroyingRect.qml. Каждый экземпляр выполняет NumberAnimation, и когда анимация завершается, вызывает destroy() для своего корневого объекта, чтобы уничтожить себя:

import QtQuick 2.0

Item {
    id: container
    width: 500; height: 100

    Component.onCompleted: {
        var component = Qt.createComponent("SelfDestroyingRect.qml");
        for (var i=0; i<5; i++) {
            var object = component.createObject(container);
            object.x = (object.width + 10) * i;
        }
    }
}

import QtQuick 2.0

Rectangle {
    id: rect
    width: 80; height: 80
    color: "red"

    NumberAnimation on opacity {
        to: 0
        duration: 1000

        onRunningChanged: {
            if (!running) {
                console.log("Destroying...")
                rect.destroy();
            }
        }
    }
}

В качестве альтернативы, application.qml мог бы уничтожить созданный объект, вызвав object.destroy().

Обратите внимание, что безопасно вызывать destroy() для объекта внутри этого объекта. Объекты не уничтожаются мгновенно после вызова destroy(), а очищаются в какой-то момент между окончанием этого блока сценария и следующим кадром (если вы не указали ненулевую задержку).

Также обратите внимание, что если экземпляр SelfDestroyingRect был создан статически, как в этом примере:

Item {
    SelfDestroyingRect {
        // ...
    }
}

Это приведёт к ошибке, поскольку объекты могут быть уничтожены только динамически, если они были созданы динамически.

Объекты, созданные с помощью Qt.createQmlObject(), аналогичным образом могут быть уничтожены с помощью destroy():

var newObject = Qt.createQmlObject('import QtQuick 2.0; Rectangle {color: "red"; width: 20; height: 20}',
                                   parentItem,
                                   "dynamicSnippet1");
newObject.destroy(1000);