Как получить доступ к перечислению С++ из QML?

Ответ 1

Вы можете заключить перечисление в класс, производный от QObject (и который вы предоставляете QML):

style.hpp:

#ifndef STYLE_HPP
#define STYLE_HPP

#include <QtGlobal>
#if QT_VERSION < QT_VERSION_CHECK(5,0,0)
    // Qt 4
    #include <QDeclarativeEngine>
#else
    // Qt 5
    #include <QQmlEngine>
#endif

// Required derivation from QObject
class StyleClass : public QObject
{
    Q_OBJECT

    public:
        // Default constructor, required for classes you expose to QML.
        StyleClass() : QObject() {}

        enum EnStyle
        {
            STYLE_RADIAL,
            STYLE_ENVELOPE,
            STYLE_FILLED
        };
        Q_ENUMS(EnStyle)

        // Do not forget to declare your class to the QML system.
        static void declareQML() {
            qmlRegisterType<StyleClass>("MyQMLEnums", 13, 37, "Style");
        }
};

#endif    // STYLE_HPP

main.cpp:

#include <QApplication>
#include "style.hpp"

int main (int argc, char ** argv) {
    QApplication a(argc, argv);

    //...

    StyleClass::declareQML();

    //...

    return a.exec();
}

Код QML:

import MyQMLEnums 13.37
import QtQuick 2.0    // Or 1.1 depending on your Qt version

Item {
    id: myitem

    //...

    property int item_style: Style.STYLE_RADIAL

    //...
}

Ответ 2

Начиная с Qt 5.8 вы можете выставлять перечисления из namespace:

Определите пространство имен и перечисление:

#include <QObject>

namespace MyNamespace
{
    Q_NAMESPACE         // required for meta object creation
    enum EnStyle {
        STYLE_RADIAL,
        STYLE_ENVELOPE,
        STYLE_FILLED
    };
    Q_ENUM_NS(EnStyle)  // register the enum in meta object data
}

Зарегистрируйте пространство имен (например, в main(), перед созданием Qml View/Context):

qmlRegisterUncreatableMetaObject(
  MyNamespace::staticMetaObject, // static meta object
  "my.namespace",                // import statement (can be any string)
  1, 0,                          // major and minor version of the import
  "MyNamespace",                 // name in QML (does not have to match C++ name)
  "Error: only enums"            // error in case someone tries to create a MyNamespace object
);

Используйте его в файле QML:

import QtQuick 2.0
import my.namespace 1.0

Item {
    Component.onCompleted: console.log(MyNamespace.STYLE_RADIAL)
}

Рекомендации:

https://www.kdab.com/new-qt-5-8-meta-object-support-namespaces/

http://doc.qt.io/qt-5/qqmlengine.html#qmlRegisterUncreatableMetaObject

http://doc.qt.io/qt-5/qobject.html#Q_ENUM_NS

Ответ 3

Дополнительная информация (не документированная до Qt 5.5):

Имена перечисляемых значений должны начинаться с заглавной буквы.

Это будет работать:

enum EnStyle
{
    STYLE_RADIAL,
    STYLE_ENVELOPE,
    STYLE_FILLED
};
Q_ENUMS(EnStyle)

Это не:

enum EnStyle
{
    styleRADIAL,
    styleENVELOPE,
    styleFILLED
};
Q_ENUMS(EnStyle)

Вы не получите никаких ошибок во время компиляции, они просто игнорируются движком QML.

Ответ 4

Qt также поддерживает определяемые QML типы перечислений начиная с версии 5.10 Qt. В качестве альтернативы ответу air-dex на основе С++ теперь вы также можете использовать QML для создания типов перечислений:

Style.qml:

import QtQuick 2.0

QtObject {
  enum EnStyle {
    STYLE_RADIAL,
    STYLE_ENVELOPE,
    STYLE_FILLED
  }
}

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

import VPlayApps 1.0
import QtQuick 2.9

App {

  property int enStyle: Style.EnStyle.STYLE_RADIAL

  Component.onCompleted: {
    if(enStyle === Style.EnStyle.STYLE_ENVELOPE)
      console.log("ENVELOPE")
    else
      console.log("NOT ENVELOPE")
  }
}

Смотрите здесь другой пример использования перечисляемого типа на основе QML.

Ответ 5

Сообщите moc о своем перечислении с помощью макроса Q_ENUMS, как описано в docs. Вы должны зарегистрировать класс, который "владеет" перечислением перед его использованием, как описано в docs.

Блок цитат Ashif действителен только в том случае, если перечисление является глобальным или принадлежит производному классу не QObject.

Ответ 6

Все эти решения не могут быть включены, используя этот enum-класс в качестве параметра для сигнала/слота. Этот код компилируется, но не работает в QML:

class DataEmitter : public QObject
{
    Q_OBJECT

public:
    ...
signals:
    void setStyle(StyleClass::EnStyle style);
}

...

emit setStyle(StyleClass.STYLE_RADIAL);

QML-часть:

Connections {
    target: dataEmitter
    onSetStyle: {
         myObject.style=style
    }
}

И этот код генерирует ошибку во время выполнения, как это:

IndicatorArea.qml:124: Error: Cannot assign [undefined] to int

Чтобы этот код работал, вам необходим дополнительный тип метаобъекта Qt реестра:

qRegisterMetaType<StyleClass::EnStyle>("StyleClass.EnStyle");

Подробнее пишите здесь: https://webhamster.ru/mytetrashare/index/mtb0/1535044840rbtgvfmjys (рус)

Ответ 7

Я нашел очень хорошее решение для использования ENUM из класса C++ в QML, здесь: Перечисления в Qt QML - qml.guide. Пост был настолько хорош, что я чувствовал себя обязанным поделиться им здесь с SO-сообществом. И ИМХО атрибуция всегда должна быть сделана, отсюда добавлена ссылка на пост.

Пост в основном описывает:

1) Как создать тип ENUM в Qt/C++:

// statusclass.h

#include <QObject>

class StatusClass
{
    Q_GADGET
public:
    explicit StatusClass();

    enum Value {
        Null,
        Ready,
        Loading,
        Error
    };
    Q_ENUM(Value)
};

2) Как зарегистрировать класс с помощью движка QML как "Неуправляемый тип":
(Это та часть, которая делает это решение красивым и четким.)

// main.cpp

...
QQmlApplicationEngine engine;
qmlRegisterUncreatableType<StatusClass>("qml.guide", 1, 0, "StatusClass",
                                        "Not creatable as it is an enum type.");
...

Использование qmlRegisterUncreatableType предотвращает создание экземпляров StatusClass в QML. Предупреждение будет зарегистрировано, если пользователь попытается создать экземпляр этого класса:

qrc:/main.qml:16 Not creatable as it is an enum type.

3) Наконец, как использовать ENUM в файле QML:

// main.qml

import QtQuick 2.9
import QtQuick.Window 2.2

import qml.guide 1.0

Window {
    visible: true
    width: 640
    height: 480
    title: qsTr("Hello World")

    Component.onCompleted: {
        console.log(StatusClass.Ready); // <--- Here how to use the ENUM.
    }
}

Важная заметка:
Предполагается, что ENUM будет использоваться путем ссылки на него с именем класса, например, StatusClass.Ready. Если тот же класс также используется в QML как свойство контекста...

// main.cpp

...
QQmlApplicationEngine engine;
qmlRegisterUncreatableType<StatusClass>("qml.guide", 1, 0, "StatusClass",
                                        "Not creatable as it is an enum type.");

StatusClass statusClassObj; // Named such (perhaps poorly) for the sake of clarity in the example.
engine.rootContext()->setContextProperty("statusClassObj", &statusClassObj); // <--- like this
...

... тогда иногда люди случайно используют ENUM со свойством context вместо имени класса.

// main.qml

...
Component.onCompleted: {
    // Correct
    console.log(StatusClass.Ready);    // 1

    // Wrong
    console.log(statusClassObj.Ready); // undefined
}
...

Причина, по которой люди склонны совершать эту ошибку, заключается в том, что функция автозаполнения Qt Creator перечисляет ENUM как опцию, как при обращении с использованием имени класса, так и свойства context. Так что будьте осторожны, когда в такой ситуации.