Visindigo::Utility::JsonConfig Class

template <typename T> concept VI_Q_OBJECT = requires(T t) {
        { t.metaobject() } -> std::same_as<const QMetaObject*>;
};
template <typename T> concept VI_Q_GADGET = requires(T t) {
        { t.qt_check_for_QGADGET_macro() } -> std::same_as<void>;
};

class MyConfig {
        Q_GADGET
        Q_PROPERTY(int intValue MEMBER intValue)
        Q_PROPERTY(QString stringValue MEMBER stringValue)
public:
        int intValue;
        QString stringValue;
}

QString jsonStr = R"({
        "intValue": 42,
        "stringValue": "Hello, World!"
})";

MyConfig config = JsonConfig::toMetable<MyConfig>(JsonConfig::fromJson(jsonStr));

MyConfig config;
JsonConfig::fromMetable(&config, JsonConfig::fromJson(jsonStr));

成员函数文档

[since Visindigo 0.13.0] JsonConfig::JsonConfig()

VIJsonConfig的默认构造函数

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] JsonConfig::JsonConfig(const QJsonDocument &json)

json 为Json对象。 VIJsonConfig的构造函数

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] JsonConfig::JsonConfig(const QString &jsonStr)

jsonStr 为Json字符串。 VIJsonConfig的构造函数

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] JsonConfig::JsonConfig(const QVariant &variant)

variant 为QVariant对象。 从QVariant构造一个JsonConfig对象。

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] JsonConfig::JsonConfig(const Visindigo::Utility::JsonConfig &other)

other 为VIJsonConfig的另一个实例。 VIJsonConfig的拷贝构造函数

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] JsonConfig::JsonConfig(Visindigo::Utility::JsonConfig &&other)

other 为VIJsonConfig的另一个实例。 VIJsonConfig的移动构造函数

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] JsonConfig::~JsonConfig()

VIJsonConfig的析构函数

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::clear()

清空Json对象的内容。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::contains(const QString &key) const

key 为键。

return 指定Json节点是否为是否包含指定的键。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] Visindigo::Utility::JsonConfig JsonConfig::fromJson(const QString &jsonStr, QJsonParseError *error = nullptr)

jsonStr 为Json字符串。 error 为指向QJsonParseError对象的指针，用于获取解析错误信息。默认为nullptr。 从Json字符串构造一个JsonConfig对象，并返回该对象。如果解析过程中发生错误，可以通过 error 参数获取错误信息。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] template <typename T> Visindigo::Utility::JsonConfig JsonConfig::fromMetable(const T &obj)

obj 为具有Q_GADGET或Q_OBJECT标记的类的实例。 从具有Q_GADGET或Q_OBJECT标记的类的实例构造一个JsonConfig对象，并返回该对象。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QList<Visindigo::Utility::JsonConfig> JsonConfig::getArray(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的数组。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::getBool(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的布尔值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] double JsonConfig::getDouble(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的浮点数值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.14.0] QList<double> JsonConfig::getDoubleArray(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的double列表。

这个function 从 Visindigo 0.14.0 开始支持。

[since Visindigo 0.13.0] qint64 JsonConfig::getInt(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的整数值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.14.0] QList<qint64> JsonConfig::getIntArray(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的qint64列表。

这个function 从 Visindigo 0.14.0 开始支持。

[since Visindigo 0.13.0] Visindigo::Utility::JsonConfig JsonConfig::getObject(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的子对象。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString JsonConfig::getString(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的字符串值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QStringList JsonConfig::getStringList(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针

return 指定Json节点的字符串列表。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QJsonValue JsonConfig::getValue(const QString &key = "", bool *ok = nullptr) const

key 为键。 ok 为接受是否正常工作的结果指针 return 指定Json节点的值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isArray(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为数组。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isBool(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为布尔值。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isDouble(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为浮点数。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isEmpty(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为空。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isInt(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为整数。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isNull(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为空。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isObject(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为对象。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::isString(const QString &key = "") const

key 为键。

return 指定Json节点是否为是否为字符串。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QStringList JsonConfig::keys(const QString &key = "") const

key 为键。

return 指定Json节点的所有键。（不包括子对象）

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QJsonParseError JsonConfig::parse(const QString &jsonStr)

jsonStr 为Json字符串。

解析Json字符串。如果解析成功，返回的QJsonParseError的error属性为QJsonParseError::NoError。 并立即覆盖全部原有内容。如果解析失败，返回的QJsonParseError的error属性为相应的错误类型。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool JsonConfig::remove(const QString &key)

key 为键。 删除Json对象的键值对。 return 如果成功删除了键值对，返回true；如果没有找到键，返回false。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::setArray(const QString &key, const QList<Visindigo::Utility::JsonConfig> &value)

key 为键。 value 为数组。

设置指定Json节点为数组。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isArray().

[since Visindigo 0.13.0] void JsonConfig::setArray(const QString &key, const QStringList &value)

key 为键。 value 为字符串列表。

设置指定Json节点为字符串列表。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::setBool(const QString &key, bool value)

key 为键。 value 为布尔值。

设置指定Json节点为布尔值。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isBool().

[since Visindigo 0.13.0] void JsonConfig::setDouble(const QString &key, double value)

key 为键。 value 为浮点数值。

设置指定Json节点为浮点数值。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isDouble().

[since Visindigo 0.14.0] void JsonConfig::setDoubleArray(const QString &key, const QList<double> &value)

key 为键。 value 为浮点数列表。

设置指定Json节点为浮点数列表。

这个function 从 Visindigo 0.14.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::setInt(const QString &key, qint64 value)

key 为键。 value 为整数值。

设置指定Json节点为整数值。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isInt().

[since Visindigo 0.14.0] void JsonConfig::setIntArray(const QString &key, const QList<qint64> &value)

key 为键。 value 为整数列表。

设置指定Json节点为整数列表。

这个function 从 Visindigo 0.14.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::setObject(const QString &key, const Visindigo::Utility::JsonConfig &value)

key 为键。 value 为子对象。

设置指定Json节点为子对象。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isObject().

[since Visindigo 0.13.0] void JsonConfig::setString(const QString &key, const QString &value)

key 为键。 value 为字符串值。

设置指定Json节点为字符串值。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isString().

[since Visindigo 0.13.0] void JsonConfig::setStringList(const QString &key, const QStringList &value)

key 为键。 value 为整数列表。

设置指定Json节点为字符串列表。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void JsonConfig::setValue(const QString &key, const QJsonValue &value)

key 为键。 value 为值。

设置指定Json节点为值。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] template <typename T> T JsonConfig::toMetable(const QString &jsonStr, bool *ok = nullptr)

jsonStr 为Json字符串。 ok 为指向bool类型的指针，用于获取转换是否成功的信息。默认为nullptr。 将Json字符串转换为具有Q_GADGET标记的类的实例，并返回该实例。如果转换过程中发生错误，ok参数将被设置为false。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] template <typename T> T JsonConfig::toMetable(const Visindigo::Utility::JsonConfig &config, bool *ok = nullptr)

config 为JsonConfig对象。 ok 为指向bool类型的指针，用于获取转换是否成功的信息。默认为nullptr。 将JsonConfig对象转换为具有Q_GADGET标记的类的实例，并返回该实例。如果转换过程中发生错误，ok参数将被设置为false。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString JsonConfig::toString(int format)

format 为Json格式。

return 以指定格式将Json对象转换为字符串。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] template <typename T> void JsonConfig::writeMetable(T *obj, const QString &jsonStr, bool *ok = nullptr)

obj 为指向具有Q_OBJECT标记的类的实例的指针。 jsonStr 为Json字符串。 ok 为指向bool类型的指针，用于获取转换是否成功的信息。默认为nullptr。 将Json字符串写入具有Q_OBJECT标记的类的实例中。如果写入过程中发生错误，ok参数将被设置为false。

这个function 从 Visindigo 0.13.0 开始支持。

[static, since Visindigo 0.13.0] template <typename T> void JsonConfig::writeMetable(T *obj, const Visindigo::Utility::JsonConfig &config, bool *ok = nullptr)

obj 为指向具有Q_OBJECT标记的类的实例的指针。 config 为JsonConfig对象。 ok 为指向bool类型的指针，用于获取转换是否成功的信息。默认为nullptr。 将JsonConfig对象写入具有Q_OBJECT标记的类的实例中。如果写入过程中发生错误，ok参数将被设置为false。

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] Visindigo::Utility::JsonConfig &JsonConfig::operator=(Visindigo::Utility::JsonConfig &&other)

other 为VIJsonConfig的另一个实例。 VIJsonConfig的移动操作符

这个function 从 Visindigo 0.13.0 开始支持。

[noexcept, since Visindigo 0.13.0] Visindigo::Utility::JsonConfig &JsonConfig::operator=(const Visindigo::Utility::JsonConfig &other)

other 为VIJsonConfig的另一个实例。 VIJsonConfig的赋值操作符

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::Utility::JsonValueRef JsonConfig::operator[](const QString &key)

key 为键。 一个重载操作符，旨在以类似下标访问的方式访问Json对象，返回一个VIJsonValueRef实例。 此实例支持直接赋值，也可以使用指针操作符访问QJsonValue。此实例还重载了到QJsonValue的 隐式转换，可以直接将其赋值给QJsonValue。

这个function 从 Visindigo 0.13.0 开始支持。