The QJsonArray class encapsulates a JSON array. More...
| Header: | #include <QJsonArray> |
| CMake: | find_package(Qt6 COMPONENTS Core REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
| Since: | Qt 5.0 |
Note: All functions in this class are reentrant.
| class | const_iterator |
| class | iterator |
| ConstIterator | |
| Iterator | |
| const_pointer | |
| const_reference | |
| difference_type | |
| pointer | |
| reference | |
| size_type | |
| value_type |
| QJsonArray(QJsonArray &&other) | |
| QJsonArray(const QJsonArray &other) | |
| QJsonArray(std::initializer_list<QJsonValue> args) | |
| QJsonArray() | |
| QJsonArray & | operator=(QJsonArray &&other) |
| QJsonArray & | operator=(const QJsonArray &other) |
| ~QJsonArray() | |
| void | append(const QJsonValue &value) |
| QJsonValue | at(qsizetype i) const |
| QJsonArray::iterator | begin() |
| QJsonArray::const_iterator | begin() const |
| QJsonArray::const_iterator | cbegin() const |
| QJsonArray::const_iterator | cend() const |
| QJsonArray::const_iterator | constBegin() const |
| QJsonArray::const_iterator | constEnd() const |
| bool | contains(const QJsonValue &value) const |
| qsizetype | count() const |
| bool | empty() const |
| QJsonArray::iterator | end() |
| QJsonArray::const_iterator | end() const |
| QJsonArray::iterator | erase(QJsonArray::iterator it) |
| QJsonValue | first() const |
| void | insert(qsizetype i, const QJsonValue &value) |
| QJsonArray::iterator | insert(QJsonArray::iterator before, const QJsonValue &value) |
| bool | isEmpty() const |
| QJsonValue | last() const |
| void | pop_back() |
| void | pop_front() |
| void | prepend(const QJsonValue &value) |
| void | push_back(const QJsonValue &value) |
| void | push_front(const QJsonValue &value) |
| void | removeAt(qsizetype i) |
| void | removeFirst() |
| void | removeLast() |
| void | replace(qsizetype i, const QJsonValue &value) |
| qsizetype | size() const |
| void | swap(QJsonArray &other) |
| QJsonValue | takeAt(qsizetype i) |
| QVariantList | toVariantList() const |
| bool | operator!=(const QJsonArray &other) const |
| QJsonArray | operator+(const QJsonValue &value) const |
| QJsonArray & | operator+=(const QJsonValue &value) |
| QJsonArray & | operator<<(const QJsonValue &value) |
| bool | operator==(const QJsonArray &other) const |
| QJsonValueRef | operator[](qsizetype i) |
| QJsonValue | operator[](qsizetype i) const |
| QJsonArray | fromStringList(const QStringList &list) |
| QJsonArray | fromVariantList(const QVariantList &list) |
A JSON array is a list of values. The list can be manipulated by inserting and removing QJsonValue's from the array.
A QJsonArray can be converted to and from a QVariantList. You can query the number of entries with size(), insert(), and removeAt() entries from it and iterate over its content using the standard C++ iterator pattern.
QJsonArray is an implicitly shared class and shares the data with the document it has been created from as long as it is not being modified.
You can convert the array to and from text based JSON through QJsonDocument.
See also JSON Support in Qt and JSON Save Game Example.
Qt-style synonym for QJsonArray::const_iterator.
Qt-style synonym for QJsonArray::iterator.
Typedef for const QJsonValue *. Provided for STL compatibility.
Typedef for const QJsonValue &. Provided for STL compatibility.
Typedef for qsizetype. Provided for STL compatibility.
Typedef for QJsonValue *. Provided for STL compatibility.
Typedef for QJsonValue &. Provided for STL compatibility.
Typedef for qsizetype. Provided for STL compatibility.
Typedef for QJsonValue. Provided for STL compatibility.
[since 5.10] QJsonArray::QJsonArray(QJsonArray &&other)
Move-constructs a QJsonArray from other.
This function was introduced in Qt 5.10.
Creates a copy of other.
Since QJsonArray is implicitly shared, the copy is shallow as long as the object doesn't get modified.
[since 5.4] QJsonArray::QJsonArray(std::initializer_list<QJsonValue> args)
Creates an array initialized from args initialization list.
QJsonArray can be constructed in a way similar to JSON notation, for example:
QJsonArray array = { 1, 2.2, QString() }; This function was introduced in Qt 5.4.
Creates an empty array.
[since 5.10] QJsonArray &QJsonArray::operator=(QJsonArray &&other)
Move-assigns other to this array.
This function was introduced in Qt 5.10.
Assigns other to this array.
Deletes the array.
Inserts value at the end of the array.
See also prepend() and insert().
Returns a QJsonValue representing the value for index i.
The returned QJsonValue is Undefined, if i is out of bounds.
Returns an STL-style iterator pointing to the first item in the array.
See also constBegin() and end().
This is an overloaded function.
Returns a const STL-style iterator pointing to the first item in the array.
Returns a const STL-style iterator pointing to the imaginary item after the last item in the array.
Returns a const STL-style iterator pointing to the first item in the array.
See also begin() and constEnd().
Returns a const STL-style iterator pointing to the imaginary item after the last item in the array.
See also constBegin() and end().
Returns true if the array contains an occurrence of value, otherwise false.
See also count().
Same as size().
See also size().
This function is provided for STL compatibility. It is equivalent to isEmpty() and returns true if the array is empty.
Returns an STL-style iterator pointing to the imaginary item after the last item in the array.
See also begin() and constEnd().
This is an overloaded function.
Removes the item pointed to by it, and returns an iterator pointing to the next item.
See also removeAt().
Returns the first value stored in the array.
Same as at(0).
See also at().
[static] QJsonArray QJsonArray::fromStringList(const QStringList &list)
Converts the string list list to a QJsonArray.
The values in list will be converted to JSON values.
See also toVariantList() and QJsonValue::fromVariant().
[static] QJsonArray QJsonArray::fromVariantList(const QVariantList &list)
Converts the variant list list to a QJsonArray.
The QVariant values in list will be converted to JSON values.
Note: Conversion from QVariant is not completely lossless. Please see the documentation in QJsonValue::fromVariant() for more information.
See also toVariantList() and QJsonValue::fromVariant().
Inserts value at index position i in the array. If i is 0, the value is prepended to the array. If i is size(), the value is appended to the array.
See also append(), prepend(), replace(), and removeAt().
Inserts value before the position pointed to by before, and returns an iterator pointing to the newly inserted item.
See also erase() and insert().
Returns true if the object is empty. This is the same as size() == 0.
See also size().
Returns the last value stored in the array.
Same as at(size() - 1).
See also at().
This function is provided for STL compatibility. It is equivalent to removeLast(). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.
This function is provided for STL compatibility. It is equivalent to removeFirst(). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.
Inserts value at the beginning of the array.
This is the same as insert(0, value) and will prepend value to the array.
See also append() and insert().
This function is provided for STL compatibility. It is equivalent to append(value) and will append value to the array.
This function is provided for STL compatibility. It is equivalent to prepend(value) and will prepend value to the array.
Removes the value at index position i. i must be a valid index position in the array (i.e., 0 <= i < size()).
See also insert() and replace().
Removes the first item in the array. Calling this function is equivalent to calling removeAt(0). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.
See also removeAt() and removeLast().
Removes the last item in the array. Calling this function is equivalent to calling removeAt(size() - 1). The array must not be empty. If the array can be empty, call isEmpty() before calling this function.
See also removeAt() and removeFirst().
Replaces the item at index position i with value. i must be a valid index position in the array (i.e., 0 <= i < size()).
See also operator[]() and removeAt().
Returns the number of values stored in the array.
[since 5.10] void QJsonArray::swap(QJsonArray &other)
Swaps the array other with this. This operation is very fast and never fails.
This function was introduced in Qt 5.10.
Removes the item at index position i and returns it. i must be a valid index position in the array (i.e., 0 <= i < size()).
If you don't use the return value, removeAt() is more efficient.
See also removeAt().
Converts this object to a QVariantList.
Returns the created map.
Returns true if this array is not equal to other.
[since 5.3] QJsonArray QJsonArray::operator+(const QJsonValue &value) const
Returns an array that contains all the items in this array followed by the provided value.
This function was introduced in Qt 5.3.
See also operator+=().
[since 5.3] QJsonArray &QJsonArray::operator+=(const QJsonValue &value)
Appends value to the array, and returns a reference to the array itself.
This function was introduced in Qt 5.3.
See also append() and operator<<().
[since 5.3] QJsonArray &QJsonArray::operator<<(const QJsonValue &value)
Appends value to the array, and returns a reference to the array itself.
This function was introduced in Qt 5.3.
See also operator+=() and append().
Returns true if this array is equal to other.
Returns the value at index position i as a modifiable reference. i must be a valid index position in the array (i.e., 0 <= i < size()).
The return value is of type QJsonValueRef, a helper class for QJsonArray and QJsonObject. When you get an object of type QJsonValueRef, you can use it as if it were a reference to a QJsonValue. If you assign to it, the assignment will apply to the character in the QJsonArray of QJsonObject from which you got the reference.
See also at().
This is an overloaded function.
Same as at().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qjsonarray.html