API reference - Class QJsonDocument

!=

Signature: [const] bool != (const QJsonDocument other)

Description: Method bool QJsonDocument::operator!=(const QJsonDocument &other)

==

Signature: [const] bool == (const QJsonDocument other)

Description: Method bool QJsonDocument::operator==(const QJsonDocument &other)

BypassValidation

Signature: [static,const] QJsonDocument_DataValidation BypassValidation

Description: Enum constant QJsonDocument::BypassValidation

Python specific notes:
The object exposes a readable attribute 'BypassValidation'. This is the getter.

Compact

Signature: [static,const] QJsonDocument_JsonFormat Compact

Description: Enum constant QJsonDocument::Compact

Python specific notes:
The object exposes a readable attribute 'Compact'. This is the getter.

Indented

Signature: [static,const] QJsonDocument_JsonFormat Indented

Description: Enum constant QJsonDocument::Indented

Python specific notes:
The object exposes a readable attribute 'Indented'. This is the getter.

Validate

Signature: [static,const] QJsonDocument_DataValidation Validate

Description: Enum constant QJsonDocument::Validate

Python specific notes:
The object exposes a readable attribute 'Validate'. This is the getter.

[]

(1) Signature: [const] QJsonValue [] (string key)

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

(2) Signature: [const] QJsonValue [] (int i)

Description: Method const QJsonValue QJsonDocument::operator[](int i)

_assign

Signature: void _assign (const QJsonDocument other)

Description: Assigns another object to self

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

array

Signature: [const] QJsonArray array

Description: Method QJsonArray QJsonDocument::array()

Python specific notes:
The object exposes a readable attribute 'array'. This is the getter.

array=

Signature: void array= (const QJsonArray array)

Description: Method void QJsonDocument::setArray(const QJsonArray &array)

Python specific notes:
The object exposes a writable attribute 'array'. This is the setter.

assign

Signature: QJsonDocument assign (const QJsonDocument other)

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

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QJsonDocument ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

fromBinaryData

Signature: [static] QJsonDocument fromBinaryData (bytes data, const QJsonDocument_DataValidation validation = QJsonDocument::Validate)

Description: Static method QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data, QJsonDocument::DataValidation validation)

This method is static and can be called without an instance.

fromJson

Signature: [static] QJsonDocument fromJson (bytes json, QJsonParseError ptr error = nullptr)

Description: Static method QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error)

This method is static and can be called without an instance.

fromRawData

Signature: [static] QJsonDocument fromRawData (string data, int size, const QJsonDocument_DataValidation validation = QJsonDocument::Validate)

Description: Static method QJsonDocument QJsonDocument::fromRawData(const char *data, int size, QJsonDocument::DataValidation validation)

This method is static and can be called without an instance.

fromVariant

Signature: [static] QJsonDocument fromVariant (variant variant)

Description: Static method QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)

This method is static and can be called without an instance.

isArray?

Signature: [const] bool isArray?

Description: Method bool QJsonDocument::isArray()

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QJsonDocument::isEmpty()

isNull?

Signature: [const] bool isNull?

Description: Method bool QJsonDocument::isNull()

isObject?

Signature: [const] bool isObject?

Description: Method bool QJsonDocument::isObject()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QJsonDocument new

Description: Constructor QJsonDocument::QJsonDocument()

This method creates an object of class QJsonDocument.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QJsonDocument new (const QJsonObject object)

Description: Constructor QJsonDocument::QJsonDocument(const QJsonObject &object)

This method creates an object of class QJsonDocument.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QJsonDocument new (const QJsonArray array)

Description: Constructor QJsonDocument::QJsonDocument(const QJsonArray &array)

This method creates an object of class QJsonDocument.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QJsonDocument new (const QJsonDocument other)

Description: Constructor QJsonDocument::QJsonDocument(const QJsonDocument &other)

This method creates an object of class QJsonDocument.

Python specific notes:
This method is the default initializer of the object.

object

Signature: [const] QJsonObject object

Description: Method QJsonObject QJsonDocument::object()

rawData

Signature: [const] string rawData (int ptr size)

Description: Method const char *QJsonDocument::rawData(int *size)

setArray

Signature: void setArray (const QJsonArray array)

Description: Method void QJsonDocument::setArray(const QJsonArray &array)

Python specific notes:
The object exposes a writable attribute 'array'. This is the setter.

setObject

Signature: void setObject (const QJsonObject object)

Description: Method void QJsonDocument::setObject(const QJsonObject &object)

swap

Signature: void swap (QJsonDocument other)

Description: Method void QJsonDocument::swap(QJsonDocument &other)

toBinaryData

Signature: [const] bytes toBinaryData

Description: Method QByteArray QJsonDocument::toBinaryData()

toJson

(1) Signature: [const] bytes toJson

Description: Method QByteArray QJsonDocument::toJson()

(2) Signature: [const] bytes toJson (const QJsonDocument_JsonFormat format)

Description: Method QByteArray QJsonDocument::toJson(QJsonDocument::JsonFormat format)

toVariant

Signature: [const] variant toVariant

Description: Method QVariant QJsonDocument::toVariant()