KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QJsonObject

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QJsonObject

Sub-classes: Iterator, Const_iterator

Public constructors

new QJsonObjectnewConstructor QJsonObject::QJsonObject()
new QJsonObjectnew(const QJsonObject other)Constructor QJsonObject::QJsonObject(const QJsonObject &other)

Public methods

[const]bool!=(const QJsonObject other)Method bool QJsonObject::operator!=(const QJsonObject &other)
[const]bool==(const QJsonObject other)Method bool QJsonObject::operator==(const QJsonObject &other)
[const]QJsonValue[](string key)Method QJsonValue QJsonObject::operator[](const QString &key)
QJsonValueRef[](string key)Method QJsonValueRef QJsonObject::operator[](const QString &key)
void_assign(const QJsonObject other)Assigns another object to self
[const]QJsonObject ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QJsonObjectassign(const QJsonObject other)Method QJsonObject &QJsonObject::operator =(const QJsonObject &other)
QJsonObject_IteratorbeginMethod QJsonObject::iterator QJsonObject::begin()
[const]QJsonObject_Const_iteratorbeginMethod QJsonObject::const_iterator QJsonObject::begin()
[const]QJsonObject_Const_iteratorconstBeginMethod QJsonObject::const_iterator QJsonObject::constBegin()
[const]QJsonObject_Const_iteratorconstEndMethod QJsonObject::const_iterator QJsonObject::constEnd()
[const]QJsonObject_Const_iteratorconstFind(string key)Method QJsonObject::const_iterator QJsonObject::constFind(const QString &key)
[const]boolcontains(string key)Method bool QJsonObject::contains(const QString &key)
[const]intcountMethod int QJsonObject::count()
[const]new QJsonObject ptrdupCreates a copy of self
[const]boolemptyMethod bool QJsonObject::empty()
QJsonObject_IteratorendMethod QJsonObject::iterator QJsonObject::end()
[const]QJsonObject_Const_iteratorendMethod QJsonObject::const_iterator QJsonObject::end()
QJsonObject_Iteratorerase(QJsonObject_Iterator it)Method QJsonObject::iterator QJsonObject::erase(QJsonObject::iterator it)
QJsonObject_Iteratorfind(string key)Method QJsonObject::iterator QJsonObject::find(const QString &key)
[const]QJsonObject_Const_iteratorfind(string key)Method QJsonObject::const_iterator QJsonObject::find(const QString &key)
QJsonObject_Iteratorinsert(string key,
const QJsonValue value)
Method QJsonObject::iterator QJsonObject::insert(const QString &key, const QJsonValue &value)
[const]boolisEmpty?Method bool QJsonObject::isEmpty()
[const]string[]keysMethod QStringList QJsonObject::keys()
[const]intlengthMethod int QJsonObject::length()
voidremove(string key)Method void QJsonObject::remove(const QString &key)
[const]intsizeMethod int QJsonObject::size()
voidswap(QJsonObject other)Method void QJsonObject::swap(QJsonObject &other)
QJsonValuetake(string key)Method QJsonValue QJsonObject::take(const QString &key)
[const]map<string,variant>toVariantHashMethod QHash<QString, QVariant> QJsonObject::toVariantHash()
[const]map<string,variant>toVariantMapMethod QMap<QString, QVariant> QJsonObject::toVariantMap()
[const]QJsonValuevalue(string key)Method QJsonValue QJsonObject::value(const QString &key)

Public static methods and constants

QJsonObjectfromVariantHash(map<string,variant> map)Static method QJsonObject QJsonObject::fromVariantHash(const QHash<QString, QVariant> &map)
QJsonObjectfromVariantMap(map<string,variant> map)Static method QJsonObject QJsonObject::fromVariantMap(const QMap<QString, QVariant> &map)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

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

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

==

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

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

[]

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

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

(2) Signature: QJsonValueRef [] (string key)

Description: Method QJsonValueRef QJsonObject::operator[](const QString &key)

_assign

Signature: void _assign (const QJsonObject other)

Description: Assigns another object to self

_const_cast

Signature: [const] QJsonObject 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.

assign

Signature: QJsonObject assign (const QJsonObject other)

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

begin

(1) Signature: QJsonObject_Iterator begin

Description: Method QJsonObject::iterator QJsonObject::begin()

(2) Signature: [const] QJsonObject_Const_iterator begin

Description: Method QJsonObject::const_iterator QJsonObject::begin()

constBegin

Signature: [const] QJsonObject_Const_iterator constBegin

Description: Method QJsonObject::const_iterator QJsonObject::constBegin()

constEnd

Signature: [const] QJsonObject_Const_iterator constEnd

Description: Method QJsonObject::const_iterator QJsonObject::constEnd()

constFind

Signature: [const] QJsonObject_Const_iterator constFind (string key)

Description: Method QJsonObject::const_iterator QJsonObject::constFind(const QString &key)

contains

Signature: [const] bool contains (string key)

Description: Method bool QJsonObject::contains(const QString &key)

count

Signature: [const] int count

Description: Method int QJsonObject::count()

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 QJsonObject ptr dup

Description: Creates a copy of self

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

empty

Signature: [const] bool empty

Description: Method bool QJsonObject::empty()

end

(1) Signature: QJsonObject_Iterator end

Description: Method QJsonObject::iterator QJsonObject::end()

(2) Signature: [const] QJsonObject_Const_iterator end

Description: Method QJsonObject::const_iterator QJsonObject::end()

erase

Signature: QJsonObject_Iterator erase (QJsonObject_Iterator it)

Description: Method QJsonObject::iterator QJsonObject::erase(QJsonObject::iterator it)

find

(1) Signature: QJsonObject_Iterator find (string key)

Description: Method QJsonObject::iterator QJsonObject::find(const QString &key)

(2) Signature: [const] QJsonObject_Const_iterator find (string key)

Description: Method QJsonObject::const_iterator QJsonObject::find(const QString &key)

fromVariantHash

Signature: [static] QJsonObject fromVariantHash (map<string,variant> map)

Description: Static method QJsonObject QJsonObject::fromVariantHash(const QHash<QString, QVariant> &map)

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

fromVariantMap

Signature: [static] QJsonObject fromVariantMap (map<string,variant> map)

Description: Static method QJsonObject QJsonObject::fromVariantMap(const QMap<QString, QVariant> &map)

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

insert

Signature: QJsonObject_Iterator insert (string key, const QJsonValue value)

Description: Method QJsonObject::iterator QJsonObject::insert(const QString &key, const QJsonValue &value)

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QJsonObject::isEmpty()

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.

keys

Signature: [const] string[] keys

Description: Method QStringList QJsonObject::keys()

length

Signature: [const] int length

Description: Method int QJsonObject::length()

new

(1) Signature: [static] new QJsonObject new

Description: Constructor QJsonObject::QJsonObject()

This method creates an object of class QJsonObject.

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

(2) Signature: [static] new QJsonObject new (const QJsonObject other)

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

This method creates an object of class QJsonObject.

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

remove

Signature: void remove (string key)

Description: Method void QJsonObject::remove(const QString &key)

size

Signature: [const] int size

Description: Method int QJsonObject::size()

Python specific notes:
This method is also available as 'len(object)'.

swap

Signature: void swap (QJsonObject other)

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

take

Signature: QJsonValue take (string key)

Description: Method QJsonValue QJsonObject::take(const QString &key)

toVariantHash

Signature: [const] map<string,variant> toVariantHash

Description: Method QHash<QString, QVariant> QJsonObject::toVariantHash()

toVariantMap

Signature: [const] map<string,variant> toVariantMap

Description: Method QMap<QString, QVariant> QJsonObject::toVariantMap()

value

Signature: [const] QJsonValue value (string key)

Description: Method QJsonValue QJsonObject::value(const QString &key)