API reference - Class QJsonValueRef

!=

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

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

==

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

Description: Method bool QJsonValueRef::operator==(const QJsonValue &other)

_assign

Signature: void _assign (const QJsonValueRef other)

Description: Assigns another object to self

_const_cast

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

(1) Signature: QJsonValueRef assign (const QJsonValue val)

Description: Method QJsonValueRef &QJsonValueRef::operator =(const QJsonValue &val)

(2) Signature: QJsonValueRef assign (const QJsonValueRef val)

Description: Method QJsonValueRef &QJsonValueRef::operator =(const QJsonValueRef &val)

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

Description: Creates a copy of self

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

isArray?

Signature: [const] bool isArray?

Description: Method bool QJsonValueRef::isArray()

isBool?

Signature: [const] bool isBool?

Description: Method bool QJsonValueRef::isBool()

isDouble?

Signature: [const] bool isDouble?

Description: Method bool QJsonValueRef::isDouble()

isNull?

Signature: [const] bool isNull?

Description: Method bool QJsonValueRef::isNull()

isObject?

Signature: [const] bool isObject?

Description: Method bool QJsonValueRef::isObject()

isString?

Signature: [const] bool isString?

Description: Method bool QJsonValueRef::isString()

isUndefined?

Signature: [const] bool isUndefined?

Description: Method bool QJsonValueRef::isUndefined()

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 QJsonValueRef new (QJsonArray ptr array, int idx)

Description: Constructor QJsonValueRef::QJsonValueRef(QJsonArray *array, int idx)

This method creates an object of class QJsonValueRef.

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

(2) Signature: [static] new QJsonValueRef new (QJsonObject ptr object, int idx)

Description: Constructor QJsonValueRef::QJsonValueRef(QJsonObject *object, int idx)

This method creates an object of class QJsonValueRef.

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

toArray

Signature: [const] QJsonArray toArray

Description: Method QJsonArray QJsonValueRef::toArray()

toBool

(1) Signature: [const] bool toBool

Description: Method bool QJsonValueRef::toBool()

(2) Signature: [const] bool toBool (bool defaultValue)

Description: Method bool QJsonValueRef::toBool(bool defaultValue)

toDouble

(1) Signature: [const] double toDouble

Description: Method double QJsonValueRef::toDouble()

(2) Signature: [const] double toDouble (double defaultValue)

Description: Method double QJsonValueRef::toDouble(double defaultValue)

toInt

(1) Signature: [const] int toInt

Description: Method int QJsonValueRef::toInt()

(2) Signature: [const] int toInt (int defaultValue)

Description: Method int QJsonValueRef::toInt(int defaultValue)

toObject

Signature: [const] QJsonObject toObject

Description: Method QJsonObject QJsonValueRef::toObject()

toString

(1) Signature: [const] string toString

Description: Method QString QJsonValueRef::toString()

(2) Signature: [const] string toString (string defaultValue)

Description: Method QString QJsonValueRef::toString(const QString &defaultValue)

toVariant

Signature: [const] variant toVariant

Description: Method QVariant QJsonValueRef::toVariant()

type

Signature: [const] QJsonValue_Type type

Description: Method QJsonValue::Type QJsonValueRef::type()