无QObject类时如何注册enum class到QML？解决相关报错

问题背景 #

用户尝试在命名空间中定义enum class并使用Qt宏注册到QML时遇到以下问题：

原头文件代码 #

#ifndef ENUMCLASSES_H
#define ENUMCLASSES_H

#include <QObject>

namespace mynamespace {

enum class Fruit : int
{
    Apple,
    Banana,
    Orange
};
Q_ENUM(Fruit)

}

#endif // ENUMCLASSES_H

使用Q_ENUM的报错 #

EnumClasses.h:14:1: error: 'friend' used outside of class
qobjectdefs.h:116:30: note: expanded from macro 'Q_ENUM'
qobjectdefs.h:114:5: note: expanded from macro 'Q_ENUM_IMPL'

使用过时Q_ENUMS的提示 #

/home/Qt/EnumClasses.h:14:1: Use Q_ENUM instead of Q_ENUMS

解决方案 #

方式1：使用Q_NAMESPACE + Q_ENUM_NS（推荐，真正不依赖QObject） #

Qt 5.8及以上版本支持给命名空间添加元对象信息，无需继承QObject：

1. 修改头文件，给命名空间添加Q_NAMESPACE宏，并用Q_ENUM_NS注册枚举：

#ifndef ENUMCLASSES_H
#define ENUMCLASSES_H

#include <QObject>

namespace mynamespace {
Q_NAMESPACE // 为命名空间启用元对象支持

enum class Fruit : int
{
    Apple,
    Banana,
    Orange
};
Q_ENUM_NS(Fruit) // 注册命名空间内的枚举

}

#endif // ENUMCLASSES_H

2. 在C++入口代码（如main.cpp）中注册命名空间到QML：

#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include "EnumClasses.h"

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

    // 注册命名空间到QML模块
    qmlRegisterUncreatableMetaObject(
        mynamespace::staticMetaObject,
        "com.example.mynamespace", // QML模块名
        1, 0, // 模块版本号
        "MyNamespace", // QML中引用的命名空间别名
        "Namespace cannot be instantiated" // 禁止实例化的提示
    );

    QQmlApplicationEngine engine;
    const QUrl url(u"qrc:/main.qml"_qs);
    QObject::connect(&engine, &QQmlApplicationEngine::objectCreated,
                     &app, [url](QObject *obj, const QUrl &objUrl) {
        if (!obj && url == objUrl)
            QCoreApplication::exit(-1);
    }, Qt::QueuedConnection);
    engine.load(url);

    return app.exec();
}

3. 在QML中导入模块并使用枚举：

import com.example.mynamespace 1.0

Text {
    text: MyNamespace.Fruit.Apple.toString()
}

方式2：基于空QObject派生类（兼容旧版Qt，仍依赖QObject） #

如果使用Qt 5.8之前的版本，可以创建一个仅用于承载枚举的空QObject子类，避免业务代码依赖QObject：

1. 修改头文件：

#ifndef ENUMCLASSES_H
#define ENUMCLASSES_H

#include <QObject>

class Enums : public QObject
{
    Q_OBJECT
public:
    enum class Fruit : int
    {
        Apple,
        Banana,
        Orange
    };
    Q_ENUM(Fruit)

    explicit Enums(QObject *parent = nullptr) : QObject(parent) {}
};

#endif // ENUMCLASSES_H

2. 在main.cpp中注册类到QML：

qmlRegisterType<Enums>("com.example.enums", 1, 0, "Enums");

3. QML中使用：

import com.example.enums 1.0

Text {
    text: Enums.Fruit.Apple.toString()
}

内容的提问来源于stack exchange，提问作者Евгений Дружинин