Класс QJsonObject

Класс QJsonObject инкапсулирует JSON-объект. Подробнее...

Этот класс был представлен в Qt 5.0.

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые типы

Открытые функции

Статические публичные члены

Подробное описание

Объект JSON — это список пар ключ-значение, где ключи — уникальные строки, а значения представляются объектом QJsonValue.

Объект QJsonObject можно преобразовать в QVariantMap и обратно. Вы можете получить количество пар (ключ, значение) с помощью size(), вставлять и удалять элементы с помощью insert() и remove(), а также итерироваться по содержанию с помощью стандартного шаблона итераторов C++.

QJsonObject — это класс с неявной общей областью памяти, который разделяет данные с документом, из которого он был создан, до тех пор, пока он не изменяется.

Вы можете преобразовать объект в текстовое представление JSON и обратно с помощью QJsonDocument.

См. также Поддержка JSON в Qt и Пример сохранения игры в формате JSON.

Документация типов членов

typedef QJsonObject::ConstIterator

Синоним Qt-стиля для QJsonObject::const_iterator.

typedef QJsonObject::Iterator

Синоним Qt-стиля для QJsonObject::iterator.

typedef QJsonObject::key_type

Тип для QString. Предоставлен для совместимости со STL.

typedef QJsonObject::mapped_type

Тип для QJsonValue. Предоставлен для совместимости со STL.

typedef QJsonObject::size_type

Тип для int. Предоставлен для совместимости со STL.

Документация функций членов

QJsonObject::QJsonObject(QJsonObject &&other)

Создаёт QJsonObject, перемещая данные из other.

Эта функция была добавлена в Qt 5.10.

QJsonObject::QJsonObject(const QJsonObject &other)

Создаёт копию other.

Поскольку QJsonObject использует неявную общую область памяти, копия является поверхностной, пока объект не будет изменён.

QJsonObject::QJsonObject(std::initializer_list<QPair<QString, QJsonValue> > args)

Создаёт экземпляр QJsonObject, инициализированный из списка инициализации args. Например:

QJsonObject object
{
    {"property1", 1},
    {"property2", 2}
};

Эта функция была добавлена в Qt 5.4.

QJsonObject::QJsonObject()

Создаёт пустой объект JSON.

См. также isEmpty().

QJsonObject &QJsonObject::operator=(QJsonObject &&other)

Перемещает данные из other в текущий объект.

Эта функция была добавлена в Qt 5.10.

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

Копирует данные из other в текущий объект.

QJsonObject::~QJsonObject()

Уничтожает объект.

QJsonObject::iterator QJsonObject::begin()

Возвращает итератор STL, указывающий на первый элемент в объекте.

См. также constBegin() и end().

QJsonObject::const_iterator QJsonObject::begin() const

Это перегруженная функция.

QJsonObject::const_iterator QJsonObject::constBegin() const

Возвращает постоянный итератор STL, указывающий на первый элемент в объекте.

См. также begin() и constEnd().

QJsonObject::const_iterator QJsonObject::constEnd() const

Возвращает постоянный итератор STL, указывающий на мнимый элемент после последнего элемента в объекте.

См. также constBegin() и end().

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

Возвращает постоянный итератор, указывающий на элемент с ключом key в отображении.

Если в отображении нет элемента с ключом key, функция возвращает constEnd().

QJsonObject::const_iterator QJsonObject::constFind(QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonObject::const_iterator QJsonObject::constFind(QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

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

Возвращает true , если объект содержит ключ key.

См. также insert(), remove() и take().

bool QJsonObject::contains(QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

bool QJsonObject::contains(QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

int QJsonObject::count() const

Это перегруженная функция.

То же самое, что и size().

bool QJsonObject::empty() const

Эта функция предоставляется для совместимости со STL. Она эквивалентна isEmpty(), возвращает true , если объект пуст, иначе возвращает false.

QJsonObject::iterator QJsonObject::end()

Возвращает итератор STL, указывающий на мнимый элемент после последнего элемента в объекте.

См. также begin() и constEnd().

QJsonObject::const_iterator QJsonObject::end() const

Это перегруженная функция.

QJsonObject::iterator QJsonObject::erase(QJsonObject::iterator it)

Удаляет пару (ключ, значение), на которую указывает итератор it из отображения и возвращает итератор на следующий элемент в отображении.

См. также remove().

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

Возвращает итератор, указывающий на элемент с ключом key в отображении.

Если в отображении нет элемента с ключом key, функция возвращает end().

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

Это перегруженная функция.

QJsonObject::iterator QJsonObject::find(QStringView key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonObject::iterator QJsonObject::find(QLatin1String key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

QJsonObject::const_iterator QJsonObject::find(QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonObject::const_iterator QJsonObject::find(QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

[static] QJsonObject QJsonObject::fromVariantHash(const QVariantHash &hash)

Преобразует хэш QVariantHash hash в QJsonObject.

Ключи в hash будут использоваться как ключи в объекте JSON, а значения QVariant будут преобразованы в значения JSON.

Примечание: Преобразование из QVariant не является полностью без потерь. Подробнее об этом см. документацию QJsonValue::fromVariant().

Эта функция была добавлена в Qt 5.5.

См. также fromVariantMap(), toVariantHash() и QJsonValue::fromVariant().

[static] QJsonObject QJsonObject::fromVariantMap(const QVariantMap &map)

Преобразует карту значений map в QJsonObject.

Ключи в map будут использованы в качестве ключей в JSON-объекте, а значения QVariant будут преобразованы в JSON-значения.

Примечание: Преобразование из QVariant не является полностью без потерь. Подробнее см. документацию в QJsonValue::fromVariant().

См. также fromVariantHash(), toVariantMap() и QJsonValue::fromVariant().

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

Вставляет новую запись с ключом key и значением value.

Если запись с ключом key уже существует, то значение этой записи заменяется на value.

Возвращает итератор, указывающий на вставленную запись.

Если значение равно QJsonValue::Undefined, ключ будет удален из объекта. Возвращаемый итератор укажет на end().

См. также remove(), take(), QJsonObject::iterator и end().

QJsonObject::iterator QJsonObject::insert(QStringView key, const QJsonValue &value)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonObject::iterator QJsonObject::insert(QLatin1String key, const QJsonValue &value)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

bool QJsonObject::isEmpty() const

Возвращает true, если объект пуст. Это то же самое, что size() == 0.

См. также size().

QStringList QJsonObject::keys() const

Возвращает список всех ключей в этом объекте.

Список отсортирован лексикографически.

int QJsonObject::length() const

Это перегруженная функция.

То же самое, что size().

void QJsonObject::remove(const QString &key)

Удаляет key из объекта.

См. также insert() и take().

void QJsonObject::remove(QStringView key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

void QJsonObject::remove(QLatin1String key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

int QJsonObject::size() const

Возвращает количество пар (ключ, значение), хранящихся в объекте.

void QJsonObject::swap(QJsonObject &other)

Меняет местами этот объект и other. Эта операция очень быстрая и никогда не терпит неудачу.

Эта функция была добавлена в Qt 5.10.

QJsonValue QJsonObject::take(const QString &key)

Удаляет key из объекта.

Возвращает QJsonValue, содержащее значение, связанное с key. Если key не был найден в объекте, возвращаемое QJsonValue — QJsonValue::Undefined.

См. также insert(), remove() и QJsonValue.

QJsonValue QJsonObject::take(QStringView key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonValue QJsonObject::take(QLatin1String key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QVariantHash QJsonObject::toVariantHash() const

Преобразует этот объект в QVariantHash.

Возвращает созданный хэш.

Эта функция была добавлена в Qt 5.5.

См. также toVariantMap().

QVariantMap QJsonObject::toVariantMap() const

Преобразует этот объект в QVariantMap.

Возвращает созданную карту.

См. также toVariantHash().

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

Возвращает QJsonValue, представляющее значение для ключа key.

Возвращаемое QJsonValue равно QJsonValue::Undefined, если ключ не существует.

См. также QJsonValue и QJsonValue::isUndefined().

QJsonValue QJsonObject::value(QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonValue QJsonObject::value(QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

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

Возвращает true если other не равно этому объекту.

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

Возвращает true если other равно этому объекту.

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

Возвращает QJsonValue, представляющее значение для ключа key.

Это то же самое, что value().

Возвращаемое QJsonValue — QJsonValue::Undefined, если ключ не существует.

См. также value(), QJsonValue и QJsonValue::isUndefined().

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

Возвращает ссылку на значение для ключа key. Если значение с ключом key не существует в объекте, оно создаётся со значением QJsonValue::Null и затем возвращается.

Значение возвращается типа QJsonValueRef, вспомогательного класса для QJsonArray и QJsonObject. При получении объекта типа QJsonValueRef он может использоваться так, как будто это ссылка на QJsonValue. Если вы присваиваете ему значение, присвоение будет применимо к элементу в QJsonArray или QJsonObject, из которого вы получили ссылку.

См. также value().

QJsonValue QJsonObject::operator[](QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonValue QJsonObject::operator[](QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.

QJsonValueRef QJsonObject::operator[](QStringView key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

QJsonValueRef QJsonObject::operator[](QLatin1String key)

Это перегруженная функция.

Эта функция была добавлена в Qt 5.7.