Класс QPlaceReply
Класс QPlaceReply управляет операцией, запущенной экземпляром QPlaceManager, и служит базовым классом для более специализированных ответов. Подробнее...
| Заголовок: | #include <QPlaceReply> |
| qmake: | QT += location |
| С момента: | Qt 5.6 |
| Наследует: | QObject |
| Наследуется от: | QPlaceContentReply, QPlaceDetailsReply, QPlaceIdReply, QPlaceMatchReply, QPlaceSearchReply и QPlaceSearchSuggestionReply |
Этот класс был представлен в Qt 5.6.
Типы публичного доступа
| Перечисление | Error { НетОшибок, ОшибкаНесуществующегоМестоположения, ОшибкаНесуществующейКатегории, ОшибкаКоммуникации, ОшибкаПарсинга, …, НеизвестнаяОшибка } |
| Перечисление | Type { Ответ, ОтветПодробностей, ОтветПоиска, ОтветПредложенийПоиска, ОтветСодержимого, …, ОтветСоответствия } |
Открытые функции
| QPlaceReply(QObject *parent = nullptr) | |
| virtual | ~QPlaceReply() |
| QPlaceReply::Error | error() const |
| QString | errorString() const |
| bool | isFinished() const |
| virtual QPlaceReply::Type | type() const |
Открытые слоты
| virtual void | abort() |
Сигналы
| void | aborted() |
| void | contentUpdated() |
| void | error(QPlaceReply::Error error, const QString &errorString = QString()) |
| void | finished() |
Защищенные функции
| void | setError(QPlaceReply::Error error, const QString &errorString) |
| void | setFinished(bool finished) |
Подробное описание
Классы QPlaceReply и каждый из его специализированных подклассов управляют состоянием и результатами соответствующих операций. Сам QPlaceReply используется для операций, у которых нет результатов, то есть необходимо только узнать, прошла ли операция успешно или с ошибкой.
Сигнал finished() можно использовать для мониторинга прогресса операции. После завершения операции методы error() и errorString() предоставляют информацию об успешном завершении операции. В случае успеха ответ будет содержать результаты этой операции, то есть каждый подкласс будет иметь соответствующие функции для получения результатов операции.
См. также QPlaceManager.
Документация по типам членов
Перечисление QPlaceReply::Error
Описание ошибки, произошедшей во время операции.
| Постоянная | Значение | Описание |
|---|---|---|
QPlaceReply::NoError |
0 |
Ошибка не произошла |
QPlaceReply::PlaceDoesNotExistError |
1 |
Указанное местоположение не найдено |
QPlaceReply::CategoryDoesNotExistError |
2 |
Указанная категория не найдена |
QPlaceReply::CommunicationError |
3 |
Произошла ошибка при общении с поставщиком услуг. |
QPlaceReply::ParseError |
4 |
Ответ от поставщика услуг или файла импорта имеет нераспознаваемый формат |
QPlaceReply::PermissionsError |
5 |
Операция не выполнена из-за недостаточных прав. |
QPlaceReply::UnsupportedError |
6 |
Операция не поддерживается поставщиком услуг. |
QPlaceReply::BadArgumentError |
7 |
Предоставленный параметр некорректен. |
QPlaceReply::CancelError |
8 |
Операция отменена. |
QPlaceReply::UnknownError |
9 |
Произошла ошибка, которая не попадает ни в одну из других категорий. |
Перечисление QPlaceReply::Type
Описание типа ответа.
| Постоянная | Значение | Описание |
|---|---|---|
QPlaceReply::Reply |
0 |
Это общий ответ. |
QPlaceReply::DetailsReply |
1 |
Это ответ для получения подробностей о месте. |
QPlaceReply::SearchReply |
2 |
Это ответ для операции поиска мест. |
QPlaceReply::SearchSuggestionReply |
3 |
Это ответ для операции поиска предложений. |
QPlaceReply::ContentReply |
4 |
Это ответ для содержимого, связанного с местом. |
QPlaceReply::IdReply |
5 |
Это ответ, возвращающий идентификатор места или категории. Обычно используется для сохранения и удаления мест или категорий. |
QPlaceReply::MatchReply |
6 |
Это ответ, возвращающий места, соответствующие местам из другого поставщика. |
Документация по функциям членов
QPlaceReply::QPlaceReply(QObject *parent = nullptr)
Конструирует объект ответа с заданным parent.
[virtual slot] void QPlaceReply::abort()
Немедленно отменяет операцию.
См. также aborted().
[signal] void QPlaceReply::aborted()
Этот сигнал излучается, когда операция была отменена.
Эта функция была представлена в Qt 5.9.
См. также abort().
[signal] void QPlaceReply::contentUpdated()
Этот сигнал излучается, когда у этого ответа обновлено доступное содержимое. В зависимости от плагина, этот сигнал может никогда не излучаться или излучаться несколько раз перед тем, как излучиться QPlaceReply::finished(), поскольку некоторые бэкэнды могут возвращать запрашиваемое содержимое асинхронно и по частям.
Примечание: Не удаляйте и не вызывайте deleteLater для этого объекта ответа в подключённом слоте к этому сигналу. Делайте это только при QPlaceReply::finished.
[signal] void QPlaceReply::error(QPlaceReply::Error error, const QString &errorString = QString())
Этот сигнал излучается, когда в обработке этого ответа была обнаружена ошибка. Скорее всего, последует сигнал finished().
Ошибка будет описана с помощью кода ошибки error. Если errorString не пустая, она будет содержать текстовое описание ошибки, предназначенное для разработчиков, а не конечных пользователей.
Этот сигнал и QPlaceManager::error() будут испускаться одновременно.
Примечание: Не удаляйте этот объект ответа в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.
Примечание: Сигнал error перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя функции Qt предоставляет удобный помощник для получения указателя функции, как показано в этом примере:
connect(placeReply, QOverload<QPlaceReply::Error, const QString &>::of(&QPlaceReply::error),
[=](QPlaceReply::Error error, const QString &errorString){ /* ... */ });
[signal] void QPlaceReply::finished()
Этот сигнал испускается, когда обработка этого ответа завершена.
Если error() равно QPlaceReply::NoError, то обработка завершилась успешно.
Этот сигнал и QPlaceManager::finished() будут испускаться одновременно.
Примечание: Не удаляйте этот объект ответа в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.
См. также setFinished().
[virtual] QPlaceReply::~QPlaceReply()
Уничтожает объект ответа.
QPlaceReply::Error QPlaceReply::error() const
Возвращает код ошибки.
См. также setError().
QString QPlaceReply::errorString() const
Возвращает строку ошибки ответа. Строка ошибки предназначена только для разработчиков и не подходит для отображения конечному пользователю.
Если ошибка не произошла, строка пустая.
bool QPlaceReply::isFinished() const
Возвращает true, если ответ завершен.
[protected] void QPlaceReply::setError(QPlaceReply::Error error, const QString &errorString)
Устанавливает error и errorString ответа. Эта функция не вызывает испускание сигнала QPlaceReply::error(QPlaceReply::Error, const QString &errorString).
См. также error().
[protected] void QPlaceReply::setFinished(bool finished)
Устанавливает состояние, завершен ли ответ finished или нет. Эта функция не вызывает испускание сигнала finished().
См. также finished().
[virtual] QPlaceReply::Type QPlaceReply::type() const
Возвращает тип ответа.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.14/qplacereply.html
