Использование C++ моделей с Qt Quick Views

Данные, предоставляемые пользовательской C++ моделью

Модели могут быть определены на C++ и затем предоставлены для QML. Это полезно для экспорта существующих C++ моделей данных или сложных наборов данных в QML.

Класс модели C++ может быть определен как QStringList, QVariantList, QObjectList или QAbstractItemModel. Первые три полезны для экспорта более простых наборов данных, в то время как QAbstractItemModel предоставляет более гибкое решение для более сложных моделей.

Для просмотра видео-урока, демонстрирующего весь процесс экспорта C++ модели в QML, см. Урок по использованию C++ моделей в QML.

Модель на основе QStringList

Модель может быть простой QStringList, которая предоставляет содержимое списка через роль modelData.

Вот ListView с делегатом, который ссылается на значение элемента модели, используя роль modelData:

ListView {
    width: 100; height: 100

    model: myModel
    delegate: Rectangle {
        height: 25
        width: 100
        Text { text: modelData }
    }
}

Приложение Qt может загрузить этот документ QML и установить значение myModel на QStringList:

    QStringList dataList;
    dataList.append("Item 1");
    dataList.append("Item 2");
    dataList.append("Item 3");
    dataList.append("Item 4");

    QQuickView view;
    QQmlContext *ctxt = view.rootContext();
    ctxt->setContextProperty("myModel", QVariant::fromValue(dataList));

Полный исходный код этого примера доступен в examples/quick/models/stringlistmodel в каталоге установки Qt.

Примечание: Вид не может знать о том, что содержимое QStringList изменилось. Если QStringList изменится, потребуется сбросить модель, вызвав QQmlContext::setContextProperty() снова.

Модель на основе QVariantList

Модель может быть единственным QVariantList, который предоставляет содержимое списка через роль modelData.

API работает так же, как и с QStringList, как показано в предыдущем разделе.

Примечание: Вид не может знать о том, что содержимое QVariantList изменилось. Если QVariantList изменится, потребуется сбросить модель.

Модель на основе QObjectList

Список значений QObject* также может использоваться как модель. QList<QObject*> предоставляет свойства объектов в списке в качестве ролей.

Следующее приложение создает класс DataObject с значениями Q_PROPERTY, которые будут доступны как именованные роли, когда QList<DataObject*> экспортируется в QML:

class DataObject : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QString color READ color WRITE setColor NOTIFY colorChanged)
    ...
};

int main(int argc, char ** argv)
{
    QGuiApplication app(argc, argv);

    QList<QObject*> dataList;
    dataList.append(new DataObject("Item 1", "red"));
    dataList.append(new DataObject("Item 2", "green"));
    dataList.append(new DataObject("Item 3", "blue"));
    dataList.append(new DataObject("Item 4", "yellow"));

    QQuickView view;
    view.setResizeMode(QQuickView::SizeRootObjectToView);
    QQmlContext *ctxt = view.rootContext();
    ctxt->setContextProperty("myModel", QVariant::fromValue(dataList));
    ...

QObject* доступен как свойство modelData. Для удобства свойства объекта также становятся доступны напрямую в контексте делегата. Здесь, view.qml ссылается на свойства DataModel в делегате ListView:

ListView {
    width: 100; height: 100

    model: myModel
    delegate: Rectangle {
        height: 25
        width: 100
        color: model.modelData.color
        Text { text: name }
    }
}

Обратите внимание на использование свойства color с квалификатором. Свойства объекта не дублируются в объекте model, так как они легко доступны через объект modelData.

Полный исходный код этого примера доступен в examples/quick/models/objectlistmodel в каталоге установки Qt.

Примечание: Вид не может знать о том, что содержимое QList изменилось. Если QList изменится, потребуется сбросить модель, вызвав QQmlContext::setContextProperty() снова.

Подкласс QAbstractItemModel

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

Роли подкласса QAbstractItemModel могут быть экспортированы в QML путем переопределения QAbstractItemModel::roleNames().

Вот приложение с подклассом QAbstractListModel с именем AnimalModel, которое экспортирует роли type и sizes. Оно переопределяет QAbstractItemModel::roleNames(), чтобы экспортировать имена ролей, чтобы к ним можно было обратиться через QML:

class Animal
{
public:
    Animal(const QString &type, const QString &size);
    ...
};

class AnimalModel : public QAbstractListModel
{
    Q_OBJECT
public:
    enum AnimalRoles {
        TypeRole = Qt::UserRole + 1,
        SizeRole
    };

    AnimalModel(QObject *parent = 0);
    ...
};

QHash<int, QByteArray> AnimalModel::roleNames() const {
    QHash<int, QByteArray> roles;
    roles[TypeRole] = "type";
    roles[SizeRole] = "size";
    return roles;
}

int main(int argc, char ** argv)
{
    QGuiApplication app(argc, argv);

    AnimalModel model;
    model.addAnimal(Animal("Wolf", "Medium"));
    model.addAnimal(Animal("Polar bear", "Large"));
    model.addAnimal(Animal("Quoll", "Small"));

    QQuickView view;
    view.setResizeMode(QQuickView::SizeRootObjectToView);
    QQmlContext *ctxt = view.rootContext();
    ctxt->setContextProperty("myModel", &model);
    ...

Эта модель отображается делегатом ListView, который обращается к ролям type и size:

ListView {
    width: 200; height: 250

    model: myModel
    delegate: Text { text: "Animal: " + type + ", " + size }
}

Представления QML автоматически обновляются при изменении модели. Помните, что модель должна следовать стандартным правилам для изменений модели и уведомлять представление о изменениях, используя QAbstractItemModel::dataChanged(), QAbstractItemModel::beginInsertRows() и т.д. См. Справочник по наследованию от модели для получения дополнительной информации.

Полный исходный код этого примера доступен в examples/quick/models/abstractitemmodel в каталоге установки Qt.

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

Свойство роли hasModelChildren для определения наличия у узла дочерних узлов.
DelegateModel::rootIndex позволяет указать корневой узел
DelegateModel::modelIndex() возвращает QModelIndex, который можно присвоить DelegateModel::rootIndex
DelegateModel::parentModelIndex() возвращает QModelIndex, который можно присвоить DelegateModel::rootIndex

SQL модели

Qt предоставляет классы C++, которые поддерживают модели данных SQL. Эти классы прозрачно работают с базовыми данными SQL, что позволяет избежать необходимости выполнения запросов SQL для основных операций SQL, таких как создание, вставка или обновление. Более подробную информацию об этих классах можно найти в Использование классов модели SQL.

Хотя классы C++ предоставляют полные наборы функций для работы с данными SQL, они не предоставляют доступ к данным QML. Поэтому вы должны реализовать пользовательскую модель данных C++ как подкласс одного из этих классов и экспортировать ее в QML либо как тип, либо как свойство контекста.

Модель данных только для чтения

Пользовательская модель должна переопределить следующие методы, чтобы обеспечить доступ только для чтения к данным из QML:

roleNames() для экспорта имен ролей в переднюю часть QML. Например, следующая версия возвращает имена полей выбранной таблицы как имена ролей:

 QHash<int, QByteArray> SqlQueryModel::roleNames() const
 {
    QHash<int, QByteArray> roles;
    // record() returns an empty QSqlRecord
    for (int i = 0; i < this->record().count(); i ++) {
        roles.insert(Qt::UserRole + i + 1, record().fieldName(i).toUtf8());
    }
    return roles;
}

data() для экспорта данных SQL в переднюю часть QML. Например, следующая реализация возвращает данные для заданного индекса модели:

QVariant SqlQueryModel::data(const QModelIndex &index, int role) const
{
    QVariant value;

    if (index.isValid()) {
        if (role < Qt::UserRole) {
            value = QSqlQueryModel::data(index, role);
        } else {
            int columnIdx = role - Qt::UserRole - 1;
            QModelIndex modelIndex = this->index(index.row(), columnIdx);
            value = QSqlQueryModel::data(modelIndex, Qt::DisplayRole);
        }
    }
    return value;
}

Класс QSqlQueryModel подходит для реализации пользовательской модели только для чтения, представляющей данные в базе данных SQL. Пример урока чата очень хорошо демонстрирует это, реализуя пользовательскую модель для извлечения данных контактов из базы данных SQLite.

Редактируемая модель данных

Помимо roleNames() и data(), редактируемые модели должны переопределить метод setData, чтобы сохранять изменения в существующих данных SQL. Следующая версия метода проверяет, является ли заданный индекс модели допустимым, и role равен Qt::EditRole, прежде чем вызывать версию родительского класса:

bool SqlEditableModel::setData(const QModelIndex &item, const QVariant &value, int role)
{
    if (item.isValid() && role == Qt::EditRole) {
        QSqlTableModel::setData(item, value,role);
        emit dataChanged(item, item);
        return true;
    }
    return false;

}

Примечание: Важно излучать сигнал dataChanged() после сохранения изменений.

В отличие от представлений элементов C++, таких как QListView или QTableView, метод setData() должен быть явно вызван из QML при необходимости. Например, при сигнале editingFinished() или accepted() TextField. В зависимости от EditStrategy, используемой моделью, изменения либо помещаются в очередь для последующей отправки, либо отправляются немедленно.

Вы также можете вставить новые данные в модель, вызвав QSqlTableModel::insertRecord(). В следующем фрагменте примера QSqlRecord заполняется деталями книги и добавляется в модель:

...
QSqlRecord newRecord = record();
newRecord.setValue("author", "John Grisham");
newRecord.setValue("booktitle", "The Litigators");
insertRecord(rowCount(), newRecord);
...

Экспорт C++ моделей данных в QML

В приведенных выше примерах используется QQmlContext::setContextProperty() для установки значений модели напрямую в компоненты QML. Альтернативой этому является регистрация класса модели C++ как типа QML (либо непосредственно из точки входа C++, или в функции инициализации QML C++ плагина, как показано ниже). Это позволит создавать классы моделей напрямую как типы в QML:

C++

class MyModelPlugin : public QQmlExtensionPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID "org.qt-project.QmlExtension.MyModel" FILE "mymodel.json")
public:
    void registerTypes(const char *uri)
    {
        qmlRegisterType<MyModel>(uri, 1, 0,
                "MyModel");
    }
}

QML

MyModel {
    id: myModel
    ListElement { someProperty: "some value" }
}

ListView {
    width: 200; height: 250
    model: myModel
    delegate: Text { text: someProperty }
}

Подробную информацию о написании QML C++ плагинов см. в Написание QML расширений с помощью C++.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.11/qtquick-modelviewsdata-cppmodels.html