QJsonDocument Class | Qt Core (original) (raw)

This class is equality-comparable.

Member Function Documentation

QJsonDocument::QJsonDocument()

Constructs an empty and invalid document.

[explicit] QJsonDocument::QJsonDocument(const QJsonArray &array)

Constructs a QJsonDocument from array.

[explicit] QJsonDocument::QJsonDocument(const QJsonObject &object)

Creates a QJsonDocument from object.

QJsonDocument::QJsonDocument(const QJsonDocument &other)

Creates a copy of the other document.

[noexcept] QJsonDocument::QJsonDocument(QJsonDocument &&other)

Move-constructs a QJsonDocument from other.

[noexcept] QJsonDocument::~QJsonDocument()

Deletes the document.

Binary data set with fromRawData is not freed.

QJsonArray QJsonDocument::array() const

Returns the QJsonArray contained in the document.

Returns an empty array if the document contains an object.

See also isArray(), object(), and setArray().

[static] QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error = nullptr)

Parses json as a UTF-8 encoded JSON document, and creates a QJsonDocument from it.

Returns a valid (non-null) QJsonDocument if the parsing succeeds. If it fails, the returned document will be null, and the optional error variable will contain further details about the error.

See also toJson(), QJsonParseError, and isNull().

[static] QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)

Creates a QJsonDocument from the QVariant variant.

If the variant contains any other type than a QVariantMap, QVariantHash, QVariantList or QStringList, the returned document is invalid.

See also toVariant().

bool QJsonDocument::isArray() const

Returns true if the document contains an array.

See also array() and isObject().

bool QJsonDocument::isEmpty() const

Returns true if the document doesn't contain any data.

bool QJsonDocument::isNull() const

returns true if this document is null.

Null documents are documents created through the default constructor.

Documents created from UTF-8 encoded text or the binary format are validated during parsing. If validation fails, the returned document will also be null.

bool QJsonDocument::isObject() const

Returns true if the document contains an object.

See also object() and isArray().

QJsonObject QJsonDocument::object() const

Returns the QJsonObject contained in the document.

Returns an empty object if the document contains an array.

See also isObject(), array(), and setObject().

void QJsonDocument::setArray(const QJsonArray &array)

Sets array as the main object of this document.

See also setObject() and array().

void QJsonDocument::setObject(const QJsonObject &object)

Sets object as the main object of this document.

See also setArray() and object().

[noexcept] void QJsonDocument::swap(QJsonDocument &other)

Swaps this document with other. This operation is very fast and never fails.

QByteArray QJsonDocument::toJson(QJsonDocument::JsonFormat format = JsonFormat::Indented) const

Converts the QJsonDocument to a UTF-8 encoded JSON document in the provided format.

See also fromJson() and JsonFormat.

QVariant QJsonDocument::toVariant() const

Returns a QVariant representing the Json document.

The returned variant will be a QVariantList if the document is a QJsonArray and a QVariantMap if the document is a QJsonObject.

See also fromVariant() and QJsonValue::toVariant().

[noexcept] QJsonDocument &QJsonDocument::operator=(QJsonDocument &&other)

Move-assigns other to this document.

QJsonDocument &QJsonDocument::operator=(const QJsonDocument &other)

Assigns the other document to this QJsonDocument. Returns a reference to this object.

const QJsonValue QJsonDocument::operator[](const QString &key) const

Returns a QJsonValue representing the value for the key key.

Equivalent to calling object().value(key).

The returned QJsonValue is QJsonValue::Undefined if the key does not exist, or if isObject() is false.

See also QJsonValue, QJsonValue::isUndefined(), and QJsonObject.

const QJsonValue QJsonDocument::operator[](qsizetype _i_) const

Returns a QJsonValue representing the value for index i.

Equivalent to calling array().at(i).

The returned QJsonValue is QJsonValue::Undefined, if i is out of bounds, or if isArray() is false.

See also QJsonValue, QJsonValue::isUndefined(), and QJsonArray.

const QJsonValue QJsonDocument::operator[](QLatin1StringView key) const

This is an overloaded function.

const QJsonValue QJsonDocument::operator[](QStringView key) const

This is an overloaded function.