Класс QJsonObject

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

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

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

Типы общедоступных данных

Общедоступные функции

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

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

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

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

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

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

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

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

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

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

QJsonObject::QJsonObject(const QJsonObject &other)

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

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

QJsonObject::~QJsonObject()

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

iterator QJsonObject::begin()

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

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

const_iterator QJsonObject::begin() const

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

const_iterator QJsonObject::constBegin() const

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

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

const_iterator QJsonObject::constEnd() const

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

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

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

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

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

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

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

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

int QJsonObject::count() const

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

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

bool QJsonObject::empty() const

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

iterator QJsonObject::end()

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

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

const_iterator QJsonObject::end() const

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

iterator QJsonObject::erase(iterator it)

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

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

iterator QJsonObject::find(const QString &key)

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

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

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

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

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

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

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

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

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

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

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

Присваивает 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.

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

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