Notation used in Ruby API documentation
Module: QtCore
Description: Binding of QJsonDocument
Sub-classes: DataValidation, QFlags_DataValidation, JsonFormat, QFlags_JsonFormat
new QJsonDocument | new | Constructor QJsonDocument::QJsonDocument() | |
new QJsonDocument | new | (const QJsonObject object) | Constructor QJsonDocument::QJsonDocument(const QJsonObject &object) |
new QJsonDocument | new | (const QJsonArray array) | Constructor QJsonDocument::QJsonDocument(const QJsonArray &array) |
new QJsonDocument | new | (const QJsonDocument other) | Constructor QJsonDocument::QJsonDocument(const QJsonDocument &other) |
[const] | bool | != | (const QJsonDocument other) | Method bool QJsonDocument::operator!=(const QJsonDocument &other) |
[const] | bool | == | (const QJsonDocument other) | Method bool QJsonDocument::operator==(const QJsonDocument &other) |
[const] | QJsonValue | [] | (string key) | Method const QJsonValue QJsonDocument::operator[](const QString &key) |
[const] | QJsonValue | [] | (int i) | Method const QJsonValue QJsonDocument::operator[](int i) |
void | _assign | (const QJsonDocument other) | Assigns another object to self | |
[const] | QJsonDocument ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly destroys the object | ||
[const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
[const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
void | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
[const] | QJsonArray | array | Method QJsonArray QJsonDocument::array() | |
void | array= | (const QJsonArray array) | Method void QJsonDocument::setArray(const QJsonArray &array) | |
QJsonDocument | assign | (const QJsonDocument other) | Method QJsonDocument &QJsonDocument::operator =(const QJsonDocument &other) | |
[const] | new QJsonDocument ptr | dup | Creates a copy of self | |
[const] | bool | isArray? | Method bool QJsonDocument::isArray() | |
[const] | bool | isEmpty? | Method bool QJsonDocument::isEmpty() | |
[const] | bool | isNull? | Method bool QJsonDocument::isNull() | |
[const] | bool | isObject? | Method bool QJsonDocument::isObject() | |
[const] | QJsonObject | object | Method QJsonObject QJsonDocument::object() | |
[const] | string | rawData | (int ptr size) | Method const char *QJsonDocument::rawData(int *size) |
void | setArray | (const QJsonArray array) | Method void QJsonDocument::setArray(const QJsonArray &array) | |
void | setObject | (const QJsonObject object) | Method void QJsonDocument::setObject(const QJsonObject &object) | |
void | swap | (QJsonDocument other) | Method void QJsonDocument::swap(QJsonDocument &other) | |
[const] | bytes | toBinaryData | Method QByteArray QJsonDocument::toBinaryData() | |
[const] | bytes | toJson | Method QByteArray QJsonDocument::toJson() | |
[const] | bytes | toJson | (const QJsonDocument_JsonFormat format) | Method QByteArray QJsonDocument::toJson(QJsonDocument::JsonFormat format) |
[const] | variant | toVariant | Method QVariant QJsonDocument::toVariant() |
[static,const] | QJsonDocument_DataValidation | BypassValidation | Enum constant QJsonDocument::BypassValidation | |
[static,const] | QJsonDocument_JsonFormat | Compact | Enum constant QJsonDocument::Compact | |
[static,const] | QJsonDocument_JsonFormat | Indented | Enum constant QJsonDocument::Indented | |
[static,const] | QJsonDocument_DataValidation | Validate | Enum constant QJsonDocument::Validate | |
QJsonDocument | fromBinaryData | (bytes data, const QJsonDocument_DataValidation validation = QJsonDocument::Validate) | Static method QJsonDocument QJsonDocument::fromBinaryData(const QByteArray &data, QJsonDocument::DataValidation validation) | |
QJsonDocument | fromJson | (bytes json, QJsonParseError ptr error = nullptr) | Static method QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error) | |
QJsonDocument | fromRawData | (string data, int size, const QJsonDocument_DataValidation validation = QJsonDocument::Validate) | Static method QJsonDocument QJsonDocument::fromRawData(const char *data, int size, QJsonDocument::DataValidation validation) | |
QJsonDocument | fromVariant | (variant variant) | Static method QJsonDocument QJsonDocument::fromVariant(const QVariant &variant) |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
!= | 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: |
Compact | Signature: [static,const] QJsonDocument_JsonFormat Compact Description: Enum constant QJsonDocument::Compact Python specific notes: |
Indented | Signature: [static,const] QJsonDocument_JsonFormat Indented Description: Enum constant QJsonDocument::Indented Python specific notes: |
Validate | Signature: [static,const] QJsonDocument_DataValidation Validate Description: Enum constant QJsonDocument::Validate Python specific notes: |
[] | (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 |
_const_cast | Signature: [const] QJsonDocument ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. |
_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: |
array= | Signature: void array= (const QJsonArray array) Description: Method void QJsonDocument::setArray(const QJsonArray &array) Python specific notes: |
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: |
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: |
(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: | |
(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: | |
(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: | |
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: |
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() |