Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
\inmodule QtCore\reentrant More...
#include <qjsonobject.h>
Classes | |
class | const_iterator |
\inmodule QtCore More... | |
class | iterator |
\inmodule QtCore\reentrant More... | |
Public Types | |
typedef iterator | Iterator |
Qt-style synonym for QJsonObject::iterator. | |
typedef const_iterator | ConstIterator |
Qt-style synonym for QJsonObject::const_iterator. | |
typedef QJsonValue | mapped_type |
Typedef for QJsonValue. | |
typedef QString | key_type |
Typedef for QString. | |
typedef qsizetype | size_type |
Typedef for qsizetype. | |
Public Member Functions | |
QJsonObject () | |
Constructs an empty JSON object. | |
QJsonObject (std::initializer_list< std::pair< QString, QJsonValue > > args) | |
~QJsonObject () | |
Destroys the object. | |
QJsonObject (const QJsonObject &other) noexcept | |
Creates a copy of other. | |
QJsonObject & | operator= (const QJsonObject &other) noexcept |
Assigns other to this object. | |
QJsonObject (QJsonObject &&other) noexcept | |
QJsonObject & | operator= (QJsonObject &&other) noexcept |
void | swap (QJsonObject &other) noexcept |
QVariantMap | toVariantMap () const |
Converts this object to a QVariantMap. | |
QVariantHash | toVariantHash () const |
Converts this object to a QVariantHash. | |
QStringList | keys () const |
Returns a list of all keys in this object. | |
qsizetype | size () const |
Returns the number of (key, value) pairs stored in the object. | |
qsizetype | count () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Same as size(). | |
qsizetype | length () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Same as size(). | |
bool | isEmpty () const |
Returns true if the object is empty. | |
QJsonValue | value (const QString &key) const |
Returns a QJsonValue representing the value for the key key. | |
QJsonValue | operator[] (const QString &key) const |
Returns a QJsonValue representing the value for the key key. | |
QJsonValueRef | operator[] (const QString &key) |
Returns a reference to the value for key. | |
QJsonValue | value (QStringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValue | value (QLatin1StringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValue | operator[] (QStringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValue | operator[] (QLatin1StringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValueRef | operator[] (QStringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValueRef | operator[] (QLatin1StringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | remove (const QString &key) |
Removes key from the object. | |
QJsonValue | take (const QString &key) |
Removes key from the object. | |
bool | contains (const QString &key) const |
Returns true if the object contains key key. | |
void | remove (QStringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | remove (QLatin1StringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValue | take (QStringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QJsonValue | take (QLatin1StringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | contains (QStringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | contains (QLatin1StringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
iterator | begin () |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in the object. | |
const_iterator | begin () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | constBegin () const |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item in the object. | |
iterator | end () |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the object. | |
const_iterator | end () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | constEnd () const |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the object. | |
iterator | erase (iterator it) |
Removes the (key, value) pair pointed to by the iterator it from the map, and returns an iterator to the next item in the map. | |
iterator | find (const QString &key) |
Returns an iterator pointing to the item with key key in the map. | |
const_iterator | find (const QString &key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | constFind (const QString &key) const |
Returns a const iterator pointing to the item with key key in the map. | |
iterator | insert (const QString &key, const QJsonValue &value) |
Inserts a new item with the key key and a value of value. | |
iterator | find (QStringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
iterator | find (QLatin1StringView key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | find (QStringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | find (QLatin1StringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | constFind (QStringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const_iterator | constFind (QLatin1StringView key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
iterator | insert (QStringView key, const QJsonValue &value) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
iterator | insert (QLatin1StringView key, const QJsonValue &value) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | empty () const |
This function is provided for STL compatibility. | |
Static Public Member Functions | |
static QJsonObject | fromVariantMap (const QVariantMap &map) |
Converts the variant map map to a QJsonObject. | |
static QJsonObject | fromVariantHash (const QVariantHash &map) |
Converts the variant hash hash to a QJsonObject. | |
Friends | |
class | iterator |
class | const_iterator |
class | QJsonValue |
class | QJsonDocument |
class | QJsonPrivate::Value |
class | QJsonValueConstRef |
class | QJsonValueRef |
class | QCborMap |
Q_CORE_EXPORT bool | comparesEqual (const QJsonObject &lhs, const QJsonObject &rhs) |
bool | comparesEqual (const QJsonObject &lhs, const QJsonValue &rhs) |
bool | comparesEqual (const QJsonObject &lhs, const QJsonValueConstRef &rhs) |
Q_CORE_EXPORT QDebug | operator<< (QDebug dbg, const QJsonObject &o) |
\inmodule QtCore
\reentrant
The QJsonObject class encapsulates a JSON object.
\compares equality \compareswith equality QJsonValue QJsonValueConstRef \endcompareswith
A JSON object is a list of key value pairs, where the keys are unique strings and the values are represented by a QJsonValue.
A QJsonObject can be converted to and from a QVariantMap. You can query the number of (key, value) pairs with size(), insert(), and remove() entries from it and iterate over its content using the standard C++ iterator pattern.
QJsonObject 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 object to and from text based JSON through QJsonDocument.
Definition at line 19 of file qjsonobject.h.
Qt-style synonym for QJsonObject::const_iterator.
Definition at line 293 of file qjsonobject.h.
Qt-style synonym for QJsonObject::iterator.
Definition at line 292 of file qjsonobject.h.
Typedef for QJsonValue.
Provided for STL compatibility.
Definition at line 308 of file qjsonobject.h.
Typedef for qsizetype.
Provided for STL compatibility.
Definition at line 310 of file qjsonobject.h.
|
default |
Constructs an empty JSON object.
QJsonObject::QJsonObject | ( | std::initializer_list< std::pair< QString, QJsonValue > > | args | ) |
Definition at line 118 of file qjsonobject.cpp.
|
default |
Destroys the object.
|
defaultnoexcept |
Creates a copy of other.
Since QJsonObject is implicitly shared, the copy is shallow as long as the object does not get modified.
|
noexcept |
|
inline |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the first item in the object.
Definition at line 283 of file qjsonobject.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 284 of file qjsonobject.h.
|
inline |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the first item in the object.
Definition at line 285 of file qjsonobject.h.
|
inline |
Returns a const \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the object.
Definition at line 288 of file qjsonobject.h.
QJsonObject::const_iterator QJsonObject::constFind | ( | const QString & | key | ) | const |
Returns a const iterator pointing to the item with key key in the map.
If the map contains no item with key key, the function returns constEnd().
Definition at line 734 of file qjsonobject.cpp.
QJsonObject::const_iterator QJsonObject::constFind | ( | QLatin1StringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 752 of file qjsonobject.cpp.
QJsonObject::const_iterator QJsonObject::constFind | ( | QStringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 743 of file qjsonobject.cpp.
bool QJsonObject::contains | ( | const QString & | key | ) | const |
Returns true
if the object contains key key.
Definition at line 581 of file qjsonobject.cpp.
bool QJsonObject::contains | ( | QLatin1StringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 599 of file qjsonobject.cpp.
bool QJsonObject::contains | ( | QStringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 590 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Same as size().
Definition at line 51 of file qjsonobject.h.
|
inline |
This function is provided for STL compatibility.
It is equivalent to isEmpty(), returning true
if the object is empty; otherwise returning false
.
Definition at line 312 of file qjsonobject.h.
|
inline |
Returns an \l{STL-style iterators}{STL-style iterator} pointing to the imaginary item after the last item in the object.
Definition at line 286 of file qjsonobject.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 287 of file qjsonobject.h.
QJsonObject::iterator QJsonObject::erase | ( | QJsonObject::iterator | it | ) |
Removes the (key, value) pair pointed to by the iterator it from the map, and returns an iterator to the next item in the map.
Definition at line 656 of file qjsonobject.cpp.
QJsonObject::iterator QJsonObject::find | ( | const QString & | key | ) |
Returns an iterator pointing to the item with key key in the map.
If the map contains no item with key key, the function returns end().
Definition at line 673 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 295 of file qjsonobject.h.
QJsonObject::iterator QJsonObject::find | ( | QLatin1StringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 691 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 301 of file qjsonobject.h.
QJsonObject::iterator QJsonObject::find | ( | QStringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 682 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 300 of file qjsonobject.h.
|
static |
Converts the variant hash hash to a QJsonObject.
The keys in hash will be used as the keys in the JSON object, and the QVariant values will be converted to JSON values.
Definition at line 203 of file qjsonobject.cpp.
|
static |
Converts the variant map map to a QJsonObject.
The keys in map will be used as the keys in the JSON object, and the QVariant values will be converted to JSON values.
Definition at line 174 of file qjsonobject.cpp.
QJsonObject::iterator QJsonObject::insert | ( | const QString & | key, |
const QJsonValue & | value ) |
Inserts a new item with the key key and a value of value.
If there is already an item with the key key, then that item's value is replaced with value.
Returns an iterator pointing to the inserted item.
If the value is QJsonValue::Undefined, it will cause the key to get removed from the object. The returned iterator will then point to end().
Definition at line 421 of file qjsonobject.cpp.
QJsonObject::iterator QJsonObject::insert | ( | QLatin1StringView | key, |
const QJsonValue & | value ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 439 of file qjsonobject.cpp.
QJsonObject::iterator QJsonObject::insert | ( | QStringView | key, |
const QJsonValue & | value ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 430 of file qjsonobject.cpp.
bool QJsonObject::isEmpty | ( | ) | const |
Returns true
if the object is empty.
This is the same as size() == 0.
Definition at line 256 of file qjsonobject.cpp.
QStringList QJsonObject::keys | ( | ) | const |
Returns a list of all keys in this object.
The list is sorted alphabetically.
Definition at line 232 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Same as size().
Definition at line 52 of file qjsonobject.h.
Referenced by testing.tools.encode_pdf_filter._PngIdatPdfStream::write().
|
defaultnoexcept |
Assigns other to this object.
|
inlinenoexcept |
QJsonValueRef QJsonObject::operator[] | ( | const QString & | key | ) |
Returns a reference to the value for key.
If there is no value with key key in the object, one is created with a QJsonValue::Null value and then returned.
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 element in the QJsonArray or QJsonObject from which you got the reference.
Definition at line 365 of file qjsonobject.cpp.
QJsonValue QJsonObject::operator[] | ( | const QString & | key | ) | const |
Returns a QJsonValue representing the value for the key key.
This does the same as value().
The returned QJsonValue is QJsonValue::Undefined if the key does not exist.
Definition at line 333 of file qjsonobject.cpp.
QJsonValueRef QJsonObject::operator[] | ( | QLatin1StringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 383 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 61 of file qjsonobject.h.
QJsonValueRef QJsonObject::operator[] | ( | QStringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 374 of file qjsonobject.cpp.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 60 of file qjsonobject.h.
Removes key from the object.
Definition at line 484 of file qjsonobject.cpp.
void QJsonObject::remove | ( | QLatin1StringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 502 of file qjsonobject.cpp.
void QJsonObject::remove | ( | QStringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 493 of file qjsonobject.cpp.
qsizetype QJsonObject::size | ( | ) | const |
Returns the number of (key, value) pairs stored in the object.
Definition at line 246 of file qjsonobject.cpp.
|
inlinenoexcept |
Definition at line 39 of file qjsonobject.h.
QJsonValue QJsonObject::take | ( | const QString & | key | ) |
Removes key from the object.
Returns a QJsonValue containing the value referenced by key. If key was not contained in the object, the returned QJsonValue is QJsonValue::Undefined.
Definition at line 533 of file qjsonobject.cpp.
QJsonValue QJsonObject::take | ( | QLatin1StringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 551 of file qjsonobject.cpp.
QJsonValue QJsonObject::take | ( | QStringView | key | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 542 of file qjsonobject.cpp.
QVariantHash QJsonObject::toVariantHash | ( | ) | const |
Converts this object to a QVariantHash.
Returns the created hash.
Definition at line 221 of file qjsonobject.cpp.
QVariantMap QJsonObject::toVariantMap | ( | ) | const |
Converts this object to a QVariantMap.
Returns the created map.
Definition at line 186 of file qjsonobject.cpp.
QJsonValue QJsonObject::value | ( | const QString & | key | ) | const |
Returns a QJsonValue representing the value for the key key.
The returned QJsonValue is QJsonValue::Undefined if the key does not exist.
Definition at line 285 of file qjsonobject.cpp.
QJsonValue QJsonObject::value | ( | QLatin1StringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 303 of file qjsonobject.cpp.
QJsonValue QJsonObject::value | ( | QStringView | key | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 294 of file qjsonobject.cpp.
|
friend |
Definition at line 623 of file qjsonobject.cpp.
|
friend |
Definition at line 317 of file qjsonobject.h.
|
friend |
Definition at line 321 of file qjsonobject.h.
|
friend |
Definition at line 280 of file qjsonobject.h.
|
friend |
Definition at line 190 of file qjsonobject.h.
|
friend |
Definition at line 1428 of file qjsonobject.cpp.
|
friend |
Definition at line 333 of file qjsonobject.h.
|
friend |
Definition at line 329 of file qjsonobject.h.
|
friend |
Definition at line 330 of file qjsonobject.h.
|
friend |
Definition at line 328 of file qjsonobject.h.
|
friend |
Definition at line 331 of file qjsonobject.h.
|
friend |
Definition at line 332 of file qjsonobject.h.