QML - Урок 029. Регистрация Синглетон объекта для использования "Статических" методов в QML

qml, singleton, static

Понятие статических методов, которые используются в QML несколько отличается от классического в C++, когда в классе создаются статические методы, которые можно использовать обращаясь к имени класса, а не к какому-то конкретному объекту. В случае с QML дела обстоят несколько иначе. Для того, чтобы использовать такие методы в QML, которые присутствуют в C++ классе, необходимо зарегистрировать Синглетон объект, который будет предоставлять требуемые методы, причём эти методы уже не должны быть статическими сами по себе. Они должны как минимум быть помечены макросом Q_INVOKABLE , чтобы их можно было использовать в QML.

Для регистрации Синглетона необходимо использовать функцию qmlRegisterSingletonType , в которую помимо стандартных параметров, которые передаются в qmlRegisterType , необходимо также передать статическую функцию singletonProvider , которую также предстоит написать самим.

Структура проекта

Создайте Qt Quick проект, в котором будут содержаться следующие файлы:

• SingletonQMLCpp.pro - профайл проекта
• main.cpp - файл с main функцией
• main.qml - основной файл qml
• singletonclass.h - заголовочный файл синглетона
• singletonclass.cpp - файл исходных кодов синглетона

Профайл проекта будет создан по умолчанию и не будет изменяться.

main.cpp

Начнём с файла main.cpp, в котором зарегистрируем объект будущего синглетона.

#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include <QtQml> // Подключаем для использования qmlRegisterSingletonType

#include "singletonclass.h" // Подключаем заголовочный файл SingletonClass

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

    // регистрируем объект синглетона через функцию singletonProvider, то есть передаём указатель на неё в качестве аргумента.
    qmlRegisterSingletonType<SingletonClass>("SingletonClass", 1, 0, "SingletonClass", singletonProvider);

    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    if (engine.rootObjects().isEmpty())
        return -1;

    return app.exec();
}

singletonclass.h

В заголовочном файле определим enum , который будем использовать для получения определённых сообщений через "статический" метод getMessage в QML слое. В этом же файле определим статическую функцию singletonProvider , которая будет создавать инстанс синглетона.

#ifndef SINGLETONCLASS_H
#define SINGLETONCLASS_H

#include <QObject>
#include <QQmlEngine>
#include <QJSEngine>

class SingletonClass : public QObject
{
    Q_OBJECT
public:
    explicit SingletonClass(QObject *parent = nullptr);

    enum class Message {
        Info,
        Debug,
        Warning,
        Error
    };
    // Регистрация enum для испоьлзования в QML
    Q_ENUM(Message)

    // Чтобы использовать этот метод в QML, объявите его на Q_INVOKABLE
    Q_INVOKABLE QString getMessage(Message message);

signals:

public slots:
};

static QObject *singletonProvider(QQmlEngine *engine, QJSEngine *scriptEngine)
{
    Q_UNUSED(engine)
    Q_UNUSED(scriptEngine)

    SingletonClass *singletonClass = new SingletonClass();
    return singletonClass;
}

#endif // SINGLETONCLASS_H

Заметьте, что getMessage не обязан быть статическим, чтобы выступать в качестве статического метода Типа в QML.

singletonclass.cpp

В этом файле дана реализация метода getMessage.

#include "singletonclass.h"

SingletonClass::SingletonClass(QObject *parent) : QObject(parent)
{

}

QString SingletonClass::getMessage(SingletonClass::Message message)
{
    switch (message)
    {
        case Message::Info:
            return "This is Info Message";
        case Message::Debug:
            return "This is Debug Message";
        case Message::Warning:
            return "This is Warning Message";
        case Message::Error:
            return "This is Error Message";
        default:
            return "Nothin not found";
    }
}

main.qml

А теперь воспользуемся этим синглетон типом в QML.

import QtQuick 2.5
import QtQuick.Window 2.2
import QtQuick.Controls 1.4

import SingletonClass 1.0 // Подключаем Синглетон


Window {
    visible: true
    width: 640
    height: 480
    title: qsTr("Singleton Class")

    ListView {
        anchors.fill: parent
        delegate: Item {
            height: 48
            width: parent.width
            Text {
                anchors.fill: parent
                text: model.text

                verticalAlignment: Text.AlignVCenter
                horizontalAlignment: Text.AlignHCenter
            }
        }

        model: listModel
    }

    ListModel {
        id: listModel

        // Нет возможности использовать методы и функции сразу для property в ListElement, поэтому использован такой хак
        Component.onCompleted: {
            listModel.append({'text': SingletonClass.getMessage(SingletonClass.Info)})
            listModel.append({'text': SingletonClass.getMessage(SingletonClass.Debug)})
            listModel.append({'text': SingletonClass.getMessage(SingletonClass.Warning)})
            listModel.append({'text': SingletonClass.getMessage(SingletonClass.Error)})
        }
    }
}

Итог

В результате будет получен приложение, которые выведет четыре сообщения в своём окне.

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

Скачать архив с проектом