API reference - Class QJsonValue::Type

Notation used in Ruby API documentation

Module: QtCore

Description: This class represents the QJsonValue::Type enum

This class is equivalent to the class QJsonValue_Type

Public constructors

new QJsonValue_Type ptrnew(int i)Creates an enum from an integer value
new QJsonValue_Type ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QJsonValue_Type other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QJsonValue_Type other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QJsonValue_Type other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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.
voidassign(const QJsonValue_Type other)Assigns another object to self
[const]new QJsonValue_Type ptrdupCreates a copy of self
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QJsonValue_QFlags_Type|(const QJsonValue_Type other)Creates a flag set by combining the two flags
[const]QJsonValue_QFlags_Type|(const QJsonValue_QFlags_Type other)Combines the flag and the flag set

Public static methods and constants

[static,const]QJsonValue_TypeArrayEnum constant QJsonValue::Array
[static,const]QJsonValue_TypeBoolEnum constant QJsonValue::Bool
[static,const]QJsonValue_TypeDoubleEnum constant QJsonValue::Double
[static,const]QJsonValue_TypeNullEnum constant QJsonValue::Null
[static,const]QJsonValue_TypeObjectEnum constant QJsonValue::Object
[static,const]QJsonValue_TypeStringEnum constant QJsonValue::String
[static,const]QJsonValue_TypeUndefinedEnum constant QJsonValue::Undefined

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

!=

(1) Signature: [const] bool != (const QJsonValue_Type other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QJsonValue_Type other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QJsonValue_Type other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

Array

Signature: [static,const] QJsonValue_Type Array

Description: Enum constant QJsonValue::Array

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

Bool

Signature: [static,const] QJsonValue_Type Bool

Description: Enum constant QJsonValue::Bool

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

Double

Signature: [static,const] QJsonValue_Type Double

Description: Enum constant QJsonValue::Double

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

Null

Signature: [static,const] QJsonValue_Type Null

Description: Enum constant QJsonValue::Null

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

Object

Signature: [static,const] QJsonValue_Type Object

Description: Enum constant QJsonValue::Object

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

String

Signature: [static,const] QJsonValue_Type String

Description: Enum constant QJsonValue::String

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

Undefined

Signature: [static,const] QJsonValue_Type Undefined

Description: Enum constant QJsonValue::Undefined

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

_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: void assign (const QJsonValue_Type other)

Description: Assigns another object to self

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

Description: Creates a copy of self

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

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 QJsonValue_Type ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new QJsonValue_Type ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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

|

(1) Signature: [const] QJsonValue_QFlags_Type | (const QJsonValue_Type other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QJsonValue_QFlags_Type | (const QJsonValue_QFlags_Type other)

Description: Combines the flag and the flag set