Класс 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 в map.

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

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(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 из map и возвращает итератор на следующий элемент в map.

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

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

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

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

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

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

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

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

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

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

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

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

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

Преобразует хеш с вариантами hash в QJsonObject.

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

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

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

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

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

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

См. также 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().

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().

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.

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(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().

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

Это перегруженный метод.

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

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

Возвращает ссылку на значение для key.

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

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

QJsonValueRef QJsonObject::operator[](QLatin1String key)

Это перегруженный метод.

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