Определение типов объектов через QML-документы

Одной из ключевых функций QML является возможность легко определять типы QML-объектов в QML-документах, адаптируя их под нужды конкретных QML-приложений. Стандартный модуль Qt Quick предоставляет различные типы, такие как Прямоугольник, Текст и Изображение для создания QML-приложения; помимо этого, вы можете легко определять свои собственные QML-типы для повторного использования в приложении. Эта возможность создания собственных типов является основой любого QML-приложения.

Определение типа объекта с помощью QML-файла

Для создания типа объекта QML-документ должен быть размещен в текстовом файле с именем <TypeName>.qml, где <TypeName> — желаемое имя типа, которое должно состоять из буквенно-цифровых символов или символов подчеркивания и начинаться с заглавной буквы. Этот документ автоматически распознается движком как определение QML-типа. Кроме того, тип, определённый таким образом, автоматически становится доступным для других QML-файлов в той же директории, поскольку движок ищет типы QML в непосредственной директории при разрешении имён.

Например, ниже приведён документ, который объявляет Прямоугольник с дочерним элементом Областью мыши. Документ был сохранён в файле с именем SquareButton.qml:

// SquareButton.qml
import QtQuick 2.0

Rectangle {
    property int side: 100
    width: side; height: side
    color: "red"

    MouseArea {
        anchors.fill: parent
        onClicked: console.log("Button clicked!")
    }
}

Поскольку файл называется SquareButton.qml, теперь его можно использовать в качестве типа SquareButton в любом другом QML-файле в той же директории. Например, если в той же директории есть файл myapplication.qml, он может ссылаться на тип SquareButton:

// myapplication.qml
import QtQuick 2.0

SquareButton {}

Это создаёт 100x100 красный прямоугольник с внутренней областью мыши, как определено в SquareButton.qml. Когда движок загружает этот myapplication.qml документ, он загружает документ SquareButton.qml как компонент и создаёт объект SquareButton.

Тип SquareButton encapsulates иерархию QML-объектов, объявленных в SquareButton.qml. Когда QML-движок создаёт объект SquareButton этого типа, он создаёт объект из дерева Прямоугольников, объявленного в SquareButton.qml.

Примечание: регистр символов в имени файла имеет значение на некоторых файловых системах (в частности, UNIX). Рекомендуется, чтобы регистр имени файла точно соответствовал регистру имени QML-типа, например, Box.qml , а не BoX.qml, независимо от платформы, на которой будет развернут QML-тип.

Импортирование типов, определённых вне текущей директории

Если SquareButton.qml не находился в той же директории, что и myapplication.qml, типу SquareButton необходимо было бы сделать доступным через оператор import в myapplication.qml. Он может быть импортирован из относительного пути на файловой системе или как установленный модуль; см. модуль для получения более подробной информации.

Доступные атрибуты пользовательских типов

Определение корневого объекта в файле .qml определяет атрибуты, доступные для QML-типа. Все свойства, сигналы и методы, принадлежащие этому корневому объекту — будь то пользовательские, или принадлежащие QML-типу корневого объекта — являются внешне доступными и могут быть читаемы и изменяемы для объектов этого типа.

Например, тип корневого объекта в файле SquareButton.qml выше — Прямоугольник. Это означает, что любые свойства, определённые типом Прямоугольник, могут быть изменены для объекта SquareButton. Следующий код определяет три объекта SquareButton с настроенными значениями для некоторых свойств корневого объекта Прямоугольник типа SquareButton:

// application.qml
import QtQuick 2.0

Column {
    SquareButton { side: 50 }
    SquareButton { x: 50; color: "blue" }
    SquareButton { radius: 10 }
}

К атрибутам, доступным для объектов пользовательского QML-типа, относятся любые пользовательские свойства, методы и сигналы, которые дополнительно определены для объекта. Например, предположим, что Прямоугольник в SquareButton.qml был определён следующим образом, с дополнительными свойствами, методами и сигналами:

// SquareButton.qml
import QtQuick 2.0

Rectangle {
    id: root

    property bool pressed: mouseArea.pressed

    signal buttonClicked(real xPos, real yPos)

    function randomizeColor() {
        root.color = Qt.rgba(Math.random(), Math.random(), Math.random(), 1)
    }

    property int side: 100
    width: side; height: side
    color: "red"

    MouseArea {
        id: mouseArea
        anchors.fill: parent
        onClicked: root.buttonClicked(mouse.x, mouse.y)
    }
}

Любой объект SquareButton может использовать свойство pressed, сигнал buttonClicked и метод randomizeColor(), которые были добавлены к корневому прямоугольнику:

// application.qml
import QtQuick 2.0

SquareButton {
    id: squareButton

    onButtonClicked: {
        console.log("Clicked", xPos, yPos)
        randomizeColor()
    }

    Text { text: squareButton.pressed ? "Down" : "Up" }
}

Обратите внимание, что любые значения id , определённые в SquareButton.qml , недоступны для объектов SquareButton, поскольку значения id доступны только в рамках области видимости компонента, в котором объявлен компонент. Объект SquareButton выше не может ссылаться на mouseArea для ссылки на дочерний элемент Области мыши, и если у него был бы id id со значением root вместо squareButton, это не создавало бы конфликта со значением id корневого объекта, определённого в SquareButton.qml, так как оба объявляются в разных областях видимости.